前言
ConfigurationProperties 是SpringBoot引入的一个和外部配置文件相关的注解类。它可以帮助我们更好的使用外置的配置文件属性。
源码解析
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConfigurationProperties {
@AliasFor("prefix")
String value() default "";
@AliasFor("value")
String prefix() default "";
boolean ignoreInvalidFields() default false;
boolean ignoreNestedProperties() default false;
boolean ignoreUnknownFields() default true;
@Deprecated
boolean exceptionIfInvalid() default true;
}
- prefix & value
- prefix 属性可以指定配置文件中配置项的前缀，如此，相同前缀的配置项就可以统一解析。
- ignoreInvalidFields
- 是否忽略不可用的字段，默认为false， 当配置项不能被正确转化为Java类的字段值时，会抛出异常。
- ignoreNestedProperties
- 是否忽略嵌套属性，默认为false，
- ignoreUnknownFields
- 是否忽略Java类不存在的字段，默认值为true。
- exceptionIfInvalid
- 如果Java类加了注解@Validated，并且校验失败了，是否抛出异常。默认true
@Configuration
@ConfigurationProperties
@PropertySource("classpath:configprops.properties")
public class ConfigProperties {
public static class Credentials {
@Length(max = 4, min = 1)
private String authMethod;
private String username;
private String password;
// standard getters and setters
}
@NotBlank
private String host;
@Min(1025)
@Max(65536)
private int port;
@Pattern(regexp = "^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,6}$")
private String from;
private Credentials credentials;
private List<String> defaultRecipients;
private Map<String, String> additionalHeaders;
// standard getters and setters
}
默认属性配置从application.properties文件中获取，也可以通过@PropertySource指定。@Configuration注解不可缺少。
资源文件内容如下：
#Simple properties
[email protected]
mail.port=9000
[email protected]
#List properties
mail.defaultRecipients[0][email protected]
mail.defaultRecipients[1][email protected]
#Map Properties
mail.additionalHeaders.redelivery=true
mail.additionalHeaders.secure=true
#Object properties
mail.credentials.username=john
mail.credentials.password=password
mail.credentials.authMethod=SHA1
内嵌类属性
mail.credentials.username可以注入到内嵌属性credentials中
列表字段mail.defaultRecipients[0]可以注入到类的列表(数组页可以)属性中。
map字段mail.additionalHeaders.redelivery格式的配置项也可以注入到Map类型的属性中。
@Bean
@ConfigurationProperties(prefix = "mail")
public ConfigProperties mailConfig() {
return new ConfigProperties();
}
@SpringBootApplication
@EnableConfigurationProperties({ConfigProperties.class})
public class Application {
public static void main(String[] args) throws Exception {
SpringApplication.run(Application.class, args);
}
}
属性校验
可以给属性类上加入javax.validation.constraints.*中的注解，来对配置项进行校验。配合exceptionIfInvalid可以更早的发现问题。