在Spring Boot中使用 @ConfigurationProperties 註解

但 Spring Boot 提供了另外一種方式 ，可以根據類型校驗和管理application中的bean。 這裏會介紹如何使用@ConfigurationProperties。
繼續使用mail作例子。配置放在mail.properties文件中。屬性必須命名規範才能綁定成功。舉例:
1 protocol and PROTOCOL will be bind to protocol field of a bean
2 smtp-auth , smtp_auth , smtpAuth will be bind to smtpAuth field of a bean
3 smtp.auth will be bind to … hmm to smtp.auth field of a 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。

方案1:

@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時候被發現了。

總結：

@ConfigurationProperties很方便使用。 比用@Value註解好嗎? 在特定的方案中是的,這只是一個選擇問題。

做者：crocodile_b 連接：http://www.jianshu.com/p/df57fefe0ab7 來源：簡書 著做權歸做者全部。商業轉載請聯繫做者得到受權，非商業轉載請註明出處。