在 Spring Boot 中使用 @ConfigurationProperties 注解

@ConfigurationProperties 根据类型校验和管理 application 中的 bean。

Spring Boot 使用一些松的规则来绑定属性到@ConfigurationProperties bean 并且支持分层结构(hierarchical structure)。
开始创建一个@ConfigurationProperties bean:

1.  @ConfigurationProperties(locations = "classpath:mail.properties",   
2.                           ignoreUnknownFields = false,   
3.                           prefix = "mail")  
4.  public class MailProperties {   
5.    public static class Smtp {    
6.      private boolean auth;    
7.      private boolean starttlsEnable;    
8.      // ... getters and setters   
9.    }  
10.    @NotBlank private String host;  
11.    private int port;    
12.    private String from;   
13.    private String username;  
14.    private String password;   
15.    @NotNull private Smtp smtp;   
16.    // ... getters and setters  
17.  }  

mail.properties 文件

1.  mail.host=localhost  
2.  mail.port=25  
3.  mail.smtp.auth=false  
4.  mail.smtp.starttls-enable=false  
5.  mail.from=me@localhost  
6.  mail.username=  
7.  mail.password=  

上例中我们用@ConfigurationProperties注解就可以绑定属性了。ignoreUnknownFields = false告诉 Spring Boot 在有属性不能匹配到声明的域的时候抛出异常。开发的时候很方便! prefix 用来选择哪个属性的 prefix 名字来绑定。
请注意 setters 和 getters 需要在@ConfigurationProperties bean 中创建! 与@Value注解相反, 这带来了代码中的一些困扰 (特别是简单的业务中,个人观点).
OK,但是我们需要用属性来配置 application. 有至少两种方式来创建@ConfigurationProperties。即可以搭配@Configuration 注解来提供 @Beans 也可以单独使用并注入 @Configuration bean。


1. @Configuration 2. @ConfigurationProperties(locations = "classpath:mail.properties", 3. prefix = "mail") 4. public class MailConfiguration { 5. public static class Smtp { 6. private boolean auth; 7. private boolean starttlsEnable; 8. // ... getters and setters 9. } 10. 11. @NotBlank private String host; 12. private int port; 13. private String from; 14. private String username; 15. private String password; 16. 17. @NotNull private Smtp smtp; 18. // ... getters and setters 19. 20. @Bean public JavaMailSender javaMailSender() { 21. // omitted for readability 22. } 23. }
方案 2

我们和上面例子一样注解属性,然后用 Spring 的@Autowire来注入 mail configuration bean:


1. @Configuration 2. @EnableConfigurationProperties(MailProperties.class) 3. public class MailConfiguration { 4. @Autowired private MailProperties mailProperties; 5. 6. @Bean public JavaMailSender javaMailSender() { 7. // omitted for readability 8. } 9. }

请注意@EnableConfigurationProperties注解。 这个注解告诉 Spring Boot 使能支持@ConfigurationProperties。如果不指定会看到如下异常:

  1. org.springframework.beans.factory.NoSuchBeanDefinitionException:

  2. No qualifying bean of type [demo.mail.MailProperties] found for dependency:

  3. expected at least 1 bean which qualifies as autowire candidate for this dependency.

  4. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

注意: 还有其他办法 (Spring Boot 总是有其他办法!) 让@ConfigurationProperties beans 被添加 – 用@Configuration或者 @Component注解, 这样就可以在 component scan 时候被发现了。

不过也有采用读文件的方式去做的

  1. new ConfigTool().getClass().getResourceAsStream(“/config.properties”);

这个就不详细展开了

  1. spring.profiles.active=testdb

application.propreries 里面可以这样配置分支来区分线上
@Profile(“testdb”)

然后通过这个注解去执行