SpringBoot @ConfigurationProperties使用详解

2023-08-01 19:11:04 354

简介

本文将会详细讲解@ConfigurationProperties在SpringBoot中的使用。

添加依赖关系

首先我们需要添加SpringBoot依赖：


org.springframework.boot
spring-boot-starter-parent

一个简单的例子

@ConfigurationProperties需要和@Configuration配合使用，我们通常在一个POJO里面进行配置：

@Data
@Configuration
@ConfigurationProperties(prefix="mail")
publicclassConfigProperties{

privateStringhostName;
privateintport;
privateStringfrom;
}

上面的例子将会读取properties文件中所有以mail开头的属性，并和bean中的字段进行匹配：

#Simpleproperties
mail.hostname=host@mail.com
mail.port=9000
mail.from=mailer@mail.com

Spring的属性名字匹配支持很多格式，如下所示所有的格式都可以和hostName进行匹配：

mail.hostName
mail.hostname
mail.host_name
mail.host-name
mail.HOST_NAME

如果你不想使用@Configuration，那么需要在@EnableConfigurationProperties注解中手动导入配置文件如下：

@SpringBootApplication
@EnableConfigurationProperties(ConfigProperties.class)
publicclassConfigPropApp{
publicstaticvoidmain(String[]args){
SpringApplication.run(ConfigPropApp.class,args);
}
}

我们也可以在@ConfigurationPropertiesScan中指定Config文件的路径:

@SpringBootApplication
@ConfigurationPropertiesScan("com.flydean.config")
publicclassConfigPropApp{
publicstaticvoidmain(String[]args){
SpringApplication.run(ConfigPropApp.class,args);
}
}

这样的话程序只会在com.flydean.config包中查找config文件。

属性嵌套

我们可以嵌套class，list，map，下面我们举个例子，先创建一个普通的POJO：

@Data
publicclassCredentials{
privateStringauthMethod;
privateStringusername;
privateStringpassword;
}

然后创建一个嵌套的配置文件：

@Data
@Configuration
@ConfigurationProperties(prefix="nestmail")
publicclassNestConfigProperties{
privateStringhost;
privateintport;
privateStringfrom;
privateListdefaultRecipients;
privateMapadditionalHeaders;
privateCredentialscredentials;
}

对应的属性文件如下：

#nestSimpleproperties
nestmail.hostname=mailer@mail.com
nestmail.port=9000
nestmail.from=mailer@mail.com

#Listproperties
nestmail.defaultRecipients[0]=admin@mail.com
nestmail.defaultRecipients[1]=owner@mail.com

#MapProperties
nestmail.additionalHeaders.redelivery=true
nestmail.additionalHeaders.secure=true

#Objectproperties
nestmail.credentials.username=john
nestmail.credentials.password=password
nestmail.credentials.authMethod=SHA1

@ConfigurationProperties和@Bean

@ConfigurationProperties也可以和@Bean一起使用如下所示：

@Data
publicclassItem{
privateStringname;
privateintsize;
}

看下怎么使用：

@Data
@Configuration
publicclassBeanConfigProperties{
@Bean
@ConfigurationProperties(prefix="item")
publicItemitem(){
returnnewItem();
}
}

属性验证

@ConfigurationProperties可以使用标准的JSR-303格式来做属性验证。我们举个例子：

@Data
@Validated
@Configuration
@ConfigurationProperties(prefix="mail")
publicclassConfigProperties{

@NotEmpty
privateStringhostName;
@Min(1025)
@Max(65536)
privateintport;
@Pattern(regexp="^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,6}$")
privateStringfrom;
}

如果我们的属性不满足上诉条件，可能出现如下异常：

Bindingtotargetorg.springframework.boot.context.properties.bind.BindException:Failedtobindpropertiesunder'mail'tocom.flydean.config.ConfigProperties$$EnhancerBySpringCGLIB$$f0f87cb9failed:

Property:mail.port
Value:0
Reason:最小不能小于1025

Property:mail.hostName
Value:null
Reason:不能为空


Action:

Updateyourapplication'sconfiguration


Processfinishedwithexitcode1

属性转换

@ConfigurationProperties也支持多种属性转换，下面我们以Duration和DataSize为例：

我们定义两个Duration的字段：

@ConfigurationProperties(prefix="conversion")
publicclassPropertyConversion{

privateDurationtimeInDefaultUnit;
privateDurationtimeInNano;
...
}

在属性文件中定义这两个字段：

conversion.timeInDefaultUnit=10
conversion.timeInNano=9ns

我们看到上面的属性可以带单位的。可选的单位是：ns,us,ms,s,m,h和d，分别对应纳秒，微妙，毫秒，秒，分钟，小时和天。默认单位是毫秒。我们也可以在注解中指定单位：

@DurationUnit(ChronoUnit.DAYS)
privateDurationtimeInDays;

对应的配置文件如下：

conversion.timeInDays=2

下面我们再看看DataSize怎么使用：

privateDataSizesizeInDefaultUnit;

privateDataSizesizeInGB;

@DataSizeUnit(DataUnit.TERABYTES)
privateDataSizesizeInTB;

对应的属性文件：

conversion.sizeInDefaultUnit=300
conversion.sizeInGB=2GB
conversion.sizeInTB=4

Datasize支持B,KB,MB,GB和TB。

自定义Converter

同样的SpringBoot也支持自定义属性转换器。我们先定义一个POJO类：

publicclassEmployee{
privateStringname;
privatedoublesalary;
}

对应的属性文件：

conversion.employee=john,2000

我们需要自己实现一个Converter接口的转换类：

@Component
@ConfigurationPropertiesBinding
publicclassEmployeeConverterimplementsConverter{

@Override
publicEmployeeconvert(Stringfrom){
String[]data=from.split(",");
returnnewEmployee(data[0],Double.parseDouble(data[1]));
}
}

本文的例子可以参看:https://github.com/ddean2009/learn-springboot2/tree/master/springboot-ConfigurationProperties

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

SpringBoot @ConfigurationProperties使用详解

热门推荐

随机推荐