在Spring Boot中使用 @ConfigurationProperties 注解

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


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

@ConfigurationProperties(locations = "classpath:mail.properties", 
                         ignoreUnknownFields = false, 
                         prefix = "mail")
public class MailProperties { 
  public static class Smtp {  
    private boolean auth;  
    private boolean starttlsEnable;  
    // ... getters and setters 
  }
  @NotBlank private String host;
  private int port;  
  private String from; 
  private String username;
  private String password; 
  @NotNull private Smtp smtp; 
  // ... getters and setters
}

 mail.properties 文件

mail.host=localhost
mail.port=25
mail.smtp.auth=false
mail.smtp.starttls-enable=false
mail.from=me@localhost
mail.username=
mail.password=

上例中我们用
@ConfigurationProperties
注解就可以绑定属性了。
ignoreUnknownFields = false
告诉
Spring Boot
在有属性不能匹配到声明的域的时候抛出异常。开发的时候很方便! 
prefix
 用来选择哪个属性的prefix名字来绑定。

请注意setters 和 getters 需要在
@ConfigurationProperties
 bean中创建! 与
@Value
注解相反, 这带来了代码中的一些困扰 (特别是简单的业务中,个人观点).

OK,但是我们需要用属性来配置 application. 有至少两种方式来创建
@ConfigurationProperties
。即可以搭配
@Configuration
 注解来提供 @Beans 也可以单独使用并注入 @Configuration bean。

@Configuration
@ConfigurationProperties(locations = "classpath:mail.properties", 
                         prefix = "mail")
public class MailConfiguration { 
  public static class Smtp {
    private boolean auth;
    private boolean starttlsEnable;
    // ... getters and setters
 }

 @NotBlank private String host; 
 private int port;
 private String from; 
 private String username;
 private String password; 

 @NotNull private Smtp smtp; 
 // ... getters and setters  

 @Bean public JavaMailSender javaMailSender() {
  // omitted for readability
 }
}

方案2

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

@Configuration
@EnableConfigurationProperties(MailProperties.class)
 public class MailConfiguration { 
    @Autowired private MailProperties mailProperties; 

    @Bean public JavaMailSender javaMailSender() {
      // omitted for readability
    }
 }

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

org.springframework.beans.factory.NoSuchBeanDefinitionException:
 No qualifying bean of type [demo.mail.MailProperties] found for dependency:
 expected at least 1 bean which qualifies as autowire candidate for this dependency.
 Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

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

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

new ConfigTool().getClass().getResourceAsStream("/config.properties");

这个就不详细展开了

spring.profiles.active=testdb

application.propreries 里面可以这样配置分支来区分线上 

@Profile
(
“testdb”
)

然后通过这个注解去执行



    原文作者:Spring Boot
    原文地址: https://blog.csdn.net/lafengwnagzi/article/details/55050677
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞