@ConfigurationProperties使用

@ConfigurationProperties是 springboot提供用于將配置文件中的屬性值映射到 Java bean對象上。通過使用該注解，我們可以方便地將屬性文件中的值綁定到一個(gè)實(shí)例化的類對象上，從而方便地在應(yīng)用程序中使用這些屬性。

@ConfigurationProperties注解有一個(gè)參數(shù)prefix用來指定屬性公共前綴

@Configuration
@ConfigurationProperties(prefix = "myconfig")
@Data
public class MyConfigProperty {
    private int port;
    //找不到的屬性不會(huì)注入
    private String hhh;
}

一般作為屬性注入對象，首先定義成一個(gè)@Configuration。然后使用@ConfigurationProperties指定關(guān)聯(lián)屬性的前綴。

這樣如果配置文件中有myconfig.port的值就會(huì)自動(dòng)綁定到MyConfigProperty類的port屬性上。前提要有對應(yīng)的set方法。

除了在類上標(biāo)注外，還可以在@Bean方法上

@Configuration
public class MyConfigByMethod {
    @Bean
    @ConfigurationProperties(prefix = "myconfig")
    public MyConfig myConfig(){
        return  new MyConfig();
    }
}

觀察spring的源碼，還會(huì)使用@EnableConfigurationProperties引入被@ConfigurationProperties修飾的bean

框架自動(dòng)裝配解析

在springboot框架自動(dòng)裝配中有一個(gè)內(nèi)置的用來處理@ConfigurationProperties注解的配置類ConfigurationPropertiesAutoConfiguration，該配置類引入@EnableConfigurationProperties,然后間接引入EnableConfigurationPropertiesRegistrar，EnableConfigurationPropertiesRegistrar在configuration初始化的時(shí)候會(huì)調(diào)用其registerBeanDefinitions()方法進(jìn)行配置類中擴(kuò)展beanDef的加載。

EnableConfigurationPropertiesRegistrar#registerBeanDefinitions

public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
		registerInfrastructureBeans(registry);
		registerMethodValidationExcludeFilter(registry);
		ConfigurationPropertiesBeanRegistrar beanRegistrar = new ConfigurationPropertiesBeanRegistrar(registry);
		getTypes(metadata).forEach(beanRegistrar::register);
	}

private Set<Class<?>> getTypes(AnnotationMetadata metadata) {
   return metadata.getAnnotations().stream(EnableConfigurationProperties.class)
         .flatMap((annotation) -> Arrays.stream(annotation.getClassArray(MergedAnnotation.VALUE)))
         .filter((type) -> void.class != type).collect(Collectors.toSet());
}
static void registerInfrastructureBeans(BeanDefinitionRegistry registry) {
		ConfigurationPropertiesBindingPostProcessor.register(registry);
		BoundConfigurationProperties.register(registry);
}

這里主要會(huì)完成兩件事件：

1、registerInfrastructureBeans會(huì)將ConfigurationPropertiesBindingPostProcessor注冊到容器中，這是一個(gè)后置處理其，屬性的賦值會(huì)在其后置方法里完成。

2、注冊合適的ConfigurationProperties類型bean， 當(dāng)前metadata是正在初始化的Configuration類，然后從其注解上獲取帶有EnableConfigurationProperties注解作為bean定義加載到容器中。

來看幾個(gè)自動(dòng)裝配的例子：

ServletWebServerFactoryAutoConfiguration

• ServletWebServerFactoryAutoConfiguration上帶有@EnableConfigurationProperties(ServerProperties.class)注解，則ServerProperties會(huì)作為一個(gè)bean進(jìn)行處理。
• ServerProperties上配置有@ConfigurationProperties(prefix = “server”, ignoreUnknownFields = true)，我們場景的server.port屬性就會(huì)注入到ServerProperties.port屬性上。

DataSourceAutoConfiguration

@EnableConfigurationProperties(DataSourceProperties.class)
public class DataSourceAutoConfiguration {}

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties{}

DataSourceProperties會(huì)被做為一個(gè)bean加載，"spring.datasource"下的屬性會(huì)注入到DataSourceProperties屬性中。

ConfigurationPropertiesBindingPostProcessor

ConfigurationPropertiesBindingPostProcessor是一個(gè)bean后置處理器，在bean實(shí)例化后會(huì)調(diào)用其后置方法

public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
   bind(ConfigurationPropertiesBean.get(this.applicationContext, bean, beanName));
   return bean;
}

ConfigurationPropertiesBean.get()方法會(huì)判斷當(dāng)前bean是否有ConfigurationProperties注解，如果有會(huì)進(jìn)行對應(yīng)的屬性綁定。

最后使用org.springframework.boot.context.properties.bind.Binder類進(jìn)行屬性綁定。

這里ConfigurationProperties會(huì)有兩部分，一是框架通過autoConfig自動(dòng)裝配的，一種是我們自己顯示使用@ConfigurationProperties修飾的bean。

這里看到我們在自定義@ConfigurationProperties時(shí)候不一定非用@Configuration進(jìn)行修飾，只要當(dāng)前類能被解析成一個(gè)bean，都會(huì)調(diào)用該后置方法進(jìn)行對應(yīng)配置屬性的賦值。

屬性元數(shù)據(jù)信息

可配置的屬性在每個(gè)jar包META-INFO/spring-configuration-metadata.json文件。這樣一般在IDEA配置application文件時(shí)候都能根據(jù)該文件里的元數(shù)據(jù)信息進(jìn)行提示配置。

例如server.port配置在spring-boot-autoconfigure.jar包中

{
  "name": "server.port",
  "type": "java.lang.Integer",
  "description": "Server HTTP port.",
  "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties",
  "defaultValue": 8080
},

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評論