SpringBoot@ConfigurationProperties使⽤详解简介
本⽂将会详细讲解@ConfigurationProperties在Spring Boot中的使⽤。
添加依赖关系
⾸先我们需要添加Spring Boot依赖：
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<relativePath/> <!-- lookup parent from repository -->
</parent>
⼀个简单的例⼦
@ConfigurationProperties需要和@Configuration配合使⽤，我们通常在⼀个POJO⾥⾯进⾏配置：
@Data
@Configuration
@ConfigurationProperties(prefix = "mail")
public class ConfigProperties {
private String hostName;
private int port;
private String from;
}
上⾯的例⼦将会读取properties⽂件中所有以mail开头的属性，并和bean中的字段进⾏匹配：
#Simple properties
mail.hostname=host@mail
mail.port=9000
mail.from=mailer@mail
Spring的属性名字匹配⽀持很多格式，如下所⽰所有的格式都可以和hostName进⾏匹配：
mail.hostName
mail.hostname
mail.host_name
mail.host-name
mail.HOST_NAME
如果你不想使⽤@Configuration，那么需要在@EnableConfigurationProperties注解中⼿动导⼊配置⽂件如下：
@SpringBootApplication
@EnableConfigurationProperties(ConfigProperties.class)
public class ConfigPropApp {
public static void main(String[] args) {
SpringApplication.run(ConfigPropApp.class,args);
}
}
我们也可以在@ConfigurationPropertiesScan中指定Config⽂件的路径:
@SpringBootApplication
@ConfigurationPropertiesScan("fig")
public class ConfigPropApp {
spring怎么读取properties
public static void main(String[] args) {
SpringApplication.run(ConfigPropApp.class,args);
}
}
这样的话程序只会在fig包中查config⽂件。
属性嵌套
我们可以嵌套class，list，map，下⾯我们举个例⼦，先创建⼀个普通的POJO：
@Data
public class Credentials {
private String authMethod;
private String username;
private String password;
}
然后创建⼀个嵌套的配置⽂件：
@Data
@Configuration
@ConfigurationProperties(prefix = "nestmail")
public class NestConfigProperties {
private String host;
private int port;
private String from;
private List<String> defaultRecipients;
private Map<String, String> additionalHeaders;
private Credentials credentials;
}
对应的属性⽂件如下：
# nest Simple properties
nestmail.hostname=mailer@mail
nestmail.from=mailer@mail
#List properties
nestmail.defaultRecipients[0]=admin@mail
nestmail.defaultRecipients[1]=owner@mail
#Map Properties
delivery=true
nestmail.additionalHeaders.secure=true
#Object properties
@ConfigurationProperties和@Bean
@ConfigurationProperties也可以和@Bean⼀起使⽤如下所⽰：
@Data
public class Item {
private String name;
private int size;
}
看下怎么使⽤：
@Data
@Configuration
public class BeanConfigProperties {
@Bean
@ConfigurationProperties(prefix = "item")
public Item item() {
return new Item();
}
}
属性验证
@ConfigurationProperties可以使⽤标准的JSR-303格式来做属性验证。我们举个例⼦：
@Data
@Validated
@Configuration
@ConfigurationProperties(prefix = "mail")
public class ConfigProperties {
@NotEmpty
private String hostName;
@Min(1025)
@Max(65536)
private int port;
@Pattern(regexp = "^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,6}$")
private String from;
}
如果我们的属性不满⾜上诉条件，可能出现如下异常：
Binding to target org.t.properties.bind.BindException: Failed to bind properties under 'mail' to fig.ConfigProperties$$EnhancerBySpringCGLIB$$f0f87cb9 failed:  Property: mail.port
Value: 0
Reason: 最⼩不能⼩于1025
Property: mail.hostName
Value: null
Reason: 不能为空
Action:
Update your application's configuration
Process finished with exit code 1
属性转换
@ConfigurationProperties也⽀持多种属性转换，下⾯我们以Duration和DataSize为例：
我们定义两个Duration的字段：
@ConfigurationProperties(prefix = "conversion")
public class PropertyConversion {
private Duration timeInDefaultUnit;
private Duration timeInNano;
...
}
在属性⽂件中定义这两个字段：
conversion.timeInDefaultUnit=10
conversion.timeInNano=9ns
我们看到上⾯的属性可以带单位的。可选的单位是：ns, us, ms, s, m, h 和 d，分别对应纳秒，微妙，毫秒，秒，分钟，⼩时和天。默认单位是毫秒。我们也可以在注解
@DurationUnit(ChronoUnit.DAYS)
private Duration timeInDays;
对应的配置⽂件如下：
conversion.timeInDays=2
下⾯我们再看看DataSize怎么使⽤：
private DataSize sizeInDefaultUnit;
private DataSize sizeInGB;
@DataSizeUnit(DataUnit.TERABYTES)
private DataSize sizeInTB;
对应的属性⽂件：
conversion.sizeInDefaultUnit=300
conversion.sizeInGB=2GB
conversion.sizeInTB=4
Datasize⽀持B, KB, MB, GB 和TB。
⾃定义Converter
同样的Spring Boot也⽀持⾃定义属性转换器。我们先定义⼀个POJO类：
public class Employee {
private String name;
private double salary;
}
对应的属性⽂件：
我们需要⾃⼰实现⼀个Converter接⼝的转换类：
@Component
@ConfigurationPropertiesBinding
public class EmployeeConverter implements Converter<String, Employee> {
@Override
public Employee convert(String from) {
String[] data = from.split(",");
return new Employee(data[0], Double.parseDouble(data[1]));
}
}
以上就是本⽂的全部内容，希望对⼤家的学习有所帮助，也希望⼤家多多⽀持。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。