@ConfigurationProperties注解（將配置文件中的配置，以屬性的形式自動注入到實(shí)體中）可以注入在application.properties配置文件中的屬性，和@Bean 或者 @Component 能生成spring bean 的注解結(jié)合起來使用；該類在加載過程中會調(diào)用AbstractAutowireCapableBeanFactory中的applyBeanPostProcessorsBeforeInitialization接口進(jìn)行一些前置處理。

@ConfigurationProperties 注解其對應(yīng)的bean的后置處理器為ConfigurationPropertiesBindingPostProcessor，它實(shí)現(xiàn)了Spring容器的postProcessBeforeInitialization方法，會在bean初始化之前被調(diào)用注解處理器會讀取@ConfigurationProperties 注解的對象獲取配置文件中的prefix，和注解對象的類成員變量然后遞歸將配置屬性賦值給類成員變量。

@Value獲取值和@ConfigurationProperties獲取值比較：

注意：

1、要特別說明的一個注屬性 ignoreUnknownFields = false 這個超好用，自動檢查配置文件中的屬性是否存在，不存在則在啟動時就報錯。

2、必須在pom.xml文件中配置該注解，否則報錯：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency>

3、@ConfigurationProperties注解支持屬性文件和javabean的映射，而@Value支持spel表達(dá)式。如果是多個屬性映射，而且常常被復(fù)用，推薦使用@ConfigurationProperties，如果只讀取單個屬性則使用@Value要方便許多。

4、在JavaBean類上或與@Bean注解使用時，必須在使用到的JavaBean類上面添加@Component否則在容器無法獲取，若只使用@ConfigurationProperties需要結(jié)合@EnableConfigurationProperties(PropertisInject.class)將其注冊到spring容器中。

例子：

application.properties 配置

#自動配置設(shè)置 service.properties.name=my-test-name service.properties.ip=192.168.1.1 service.user=kayle service.port=8080

對應(yīng)實(shí)體 Properties 就是對應(yīng)的配置文件中的 properties，注意也要給 get/set 也就是說，配置文件中的前綴是什么， prefix 中就使用什么。成員變量就是對應(yīng)的配置文件的第二級屬性名。

@Component //不加這個注解的話, 使用@Autowired 就不能注入進(jìn)去了 @ConfigurationProperties(prefix = "service",ignoreUnknownFields = false) public class MyConfigTest {private int port;private String user;private Properties Properties;public static class Properties {private String name;private String ip;public String getName() {return name;}public void setName(String name) {this.name = name;}public String getIp() {return ip;}public void setIp(String ip) {this.ip = ip;}}public int getPort() {return port;}public void setPort(int port) {this.port = port;}public String getUser() {return user;}public void setUser(String user) {this.user = user;}public MyConfigTest.Properties getProperties() {return Properties;}public void setProperties(MyConfigTest.Properties properties) {Properties = properties;} }

測試類

@RestController public class ConfigurationPropertiesController {@Autowiredprivate MyConfigTest myConfigTest;@RequestMapping("/getProperties")public String getProperties () {System.out.println(myConfigTest.getUser());return myConfigTest.getUser();}@RequestMapping("/getObjectProperties")public Object getObjectProperties () {System.out.println(myConfigTest.getUser());return myConfigTest.getProperties();} }

結(jié)果：{"name":"my-test-name","ip":"192.168.1.1"}

也可修飾配置類方法

@ConfigurationProperties(prefix = "foo") @Bean public FooComponent fooComponent() {}

總結(jié)

以上是生活随笔為你收集整理的SpringBoot——@ConfigurationProperties注解的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。