2. 程式人生 > 程式設計 >Spring Boot中@ConfigurationProperties註解實現原理原始碼解析

Spring Boot中@ConfigurationProperties註解實現原理原始碼解析

阿新 • • 發佈：2019-12-31

0. 開源專案推薦

Pepper Metrics是我與同事開發的一個開源工具(github.com/zrbcool/pep…)，其通過收集jedis/mybatis/httpservlet/dubbo/motan的執行效能統計，並暴露成prometheus等主流時序資料庫相容資料，通過grafana展示趨勢。其外掛化的架構也非常方便使用者擴充套件並整合其他開源元件。
請大家給個star，同時歡迎大家成為開發者提交PR一起完善專案。

1. 概述

不用說大家都知道Spring Boot非常的方便，快捷，讓開發的同學簡單的幾行程式碼加上幾行配置甚至零配置就能啟動並使用一個專案，專案當中我們也可能經常使用 @ConfigurationProperties將某個Bean與properties配置當中的prefix相繫結，使配置值與定義配置的Bean分離，方便管理。
那麼，這個@ConfigurationProperties是什麼機制，如何實現的呢？我們今天來聊聊這個話題

2. 正文

2.1 從EnableConfigurationProperties說起

為什麼從EnableConfigurationProperties講？ Spring Boot專案自身當中大量autoconfigure都是使用EnableConfigurationProperties註解啟用XXXProperties功能，例如spring-data-redis的 這個RedisAutoConfiguration

@Configuration
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class) //看這裡
 

@Import({ LettuceConnectionConfiguration.class,JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {
    // ...
}
複製程式碼

而RedisProperties中又帶有註解@ConfigurationProperties(prefix = "spring.redis")，這樣就將spring.redis這個字首的配置項與RedisProperties 這個實體類進行了繫結。

2.2 EnableConfigurationProperties內部實現解析

說完來由，我們就來說說內部實現，先來看看

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(EnableConfigurationPropertiesImportSelector.class)
public @interface EnableConfigurationProperties {
	Class<?>[] value() default {};
}
複製程式碼

@Import(EnableConfigurationPropertiesImportSelector.class)指明瞭這個註解的處理類EnableConfigurationPropertiesImportSelector， 檢視EnableConfigurationPropertiesImportSelector原始碼

class EnableConfigurationPropertiesImportSelector implements ImportSelector {

	private static final String[] IMPORTS = { ConfigurationPropertiesBeanRegistrar.class.getName(),ConfigurationPropertiesBindingPostProcessorRegistrar.class.getName() };

	@Override
	public String[] selectImports(AnnotationMetadata metadata) {
		return IMPORTS;
	}
	
	// 省略部分其他方法
}
複製程式碼

我們先看這塊關鍵部分返回了一個IMPORTS陣列，陣列中包含ConfigurationPropertiesBeanRegistrar.class，ConfigurationPropertiesBindingPostProcessorRegistrar.class兩個元素
根據@Import及ImportSelector介面的原理（其原理可以參考同事寫的一篇文章：相親相愛的@Import和@EnableXXX），我們得知spring會初始化上面兩個Registrar到spring容器當中，而兩個Registrar均實現了ImportBeanDefinitionRegistrar介面， 而ImportBeanDefinitionRegistrar會在處理Configuration時觸發呼叫（其原理可以參考文章：這塊找一篇文章），下面我們分別深入兩個Registrar的原始碼：

  • ConfigurationPropertiesBeanRegistrar
  • ConfigurationPropertiesBindingPostProcessorRegistrar

2.2.1 ConfigurationPropertiesBindingPostProcessorRegistrar

直接看程式碼

public class ConfigurationPropertiesBindingPostProcessorRegistrar implements ImportBeanDefinitionRegistrar {

	@Override
	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,BeanDefinitionRegistry registry) {
		if (!registry.containsBeanDefinition(ConfigurationPropertiesBindingPostProcessor.BEAN_NAME)) {
			registerConfigurationPropertiesBindingPostProcessor(registry);
			registerConfigurationBeanFactoryMetadata(registry);
		}
	}

	private void registerConfigurationPropertiesBindingPostProcessor(BeanDefinitionRegistry registry) {
		GenericBeanDefinition definition = new GenericBeanDefinition();
		definition.setBeanClass(ConfigurationPropertiesBindingPostProcessor.class);
		definition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
		registry.registerBeanDefinition(ConfigurationPropertiesBindingPostProcessor.BEAN_NAME,definition);
	}

	private void registerConfigurationBeanFactoryMetadata(BeanDefinitionRegistry registry) {
		GenericBeanDefinition definition = new GenericBeanDefinition();
		definition.setBeanClass(ConfigurationBeanFactoryMetadata.class);
		definition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
		registry.registerBeanDefinition(ConfigurationBeanFactoryMetadata.BEAN_NAME,definition);
	}
}
複製程式碼

可以看到註冊了兩個Bean到spring容器

  • ConfigurationPropertiesBindingPostProcessor
    • 其實現如下介面： BeanPostProcessor,PriorityOrdered,ApplicationContextAware,InitializingBean
      • PriorityOrdered
        Ordered.HIGHEST_PRECEDENCE + 1保證前期執行，且非最先
      • ApplicationContextAware
        獲取到ApplicationContext設定到內部變數
      • InitializingBean
        afterPropertiesSet方法在Bean建立時被呼叫，保證內部變數configurationPropertiesBinder被初始化，這個binder類就是使prefix與propertyBean進行值繫結的關鍵工具類
      • BeanPostProcessor postProcessBeforeInitialization方法處理具體的bind邏輯如下：
      @Override
      public Object postProcessBeforeInitialization(Object bean,String beanName) throws BeansException {
          ConfigurationProperties annotation = getAnnotation(bean,beanName,ConfigurationProperties.class);
          if (annotation != null) {
              bind(bean,annotation);
          }
          return bean;
      }
      private void bind(Object bean,String beanName,ConfigurationProperties annotation) {
          ResolvableType type = getBeanType(bean,beanName);
          Validated validated = getAnnotation(bean,Validated.class);
          Annotation[] annotations = (validated != null) ? new Annotation[] { annotation,validated }
                  : new Annotation[] { annotation };
          Bindable<?> target = Bindable.of(type).withExistingValue(bean).withAnnotations(annotations);
          try {
              // 在這裡完成了，關鍵的prefix到PropertyBean的值繫結部分，所以各種@ConfigurationProperties註解最終生效就靠這部分程式碼了
              this.configurationPropertiesBinder.bind(target);
          }
          catch (Exception ex) {
              throw new ConfigurationPropertiesBindException(beanName,bean,annotation,ex);
          }
      }
複製程式碼
  • ConfigurationBeanFactoryMetadata
    如果某些Bean是通過FactoryBean建立，則該類用於儲存FactoryBean的各種原資訊，用於ConfigurationPropertiesBindingPostProcessor當中的元資料查詢，這裡就不做展開

2.2.2 ConfigurationPropertiesBeanRegistrar

其實ConfigurationPropertiesBeanRegistrar是EnableConfigurationPropertiesImportSelector的靜態內部類，在前面貼程式碼時被省略的部分，上程式碼

	public static class ConfigurationPropertiesBeanRegistrar implements ImportBeanDefinitionRegistrar {

		@Override
		public void registerBeanDefinitions(AnnotationMetadata metadata,BeanDefinitionRegistry registry) {
			getTypes(metadata).forEach((type) -> register(registry,(ConfigurableListableBeanFactory) registry,type));
		}

		private List<Class<?>> getTypes(AnnotationMetadata metadata) {
			MultiValueMap<String,Object> attributes = metadata
					.getAllAnnotationAttributes(EnableConfigurationProperties.class.getName(),false);
			return collectClasses((attributes != null) ? attributes.get("value") : Collections.emptyList());
		}

		private List<Class<?>> collectClasses(List<?> values) {
			return values.stream().flatMap((value) -> Arrays.stream((Object[]) value)).map((o) -> (Class<?>) o)
					.filter((type) -> void.class != type).collect(Collectors.toList());
		}

		private void register(BeanDefinitionRegistry registry,ConfigurableListableBeanFactory beanFactory,Class<?> type) {
			String name = getName(type);
			if (!containsBeanDefinition(beanFactory,name)) {
				registerBeanDefinition(registry,name,type);
			}
		}

		private String getName(Class<?> type) {
			ConfigurationProperties annotation = AnnotationUtils.findAnnotation(type,ConfigurationProperties.class);
			String prefix = (annotation != null) ? annotation.prefix() : "";
			return (StringUtils.hasText(prefix) ? prefix + "-" + type.getName() : type.getName());
		}

		private void registerBeanDefinition(BeanDefinitionRegistry registry,String name,Class<?> type) {
			assertHasAnnotation(type);
			GenericBeanDefinition definition = new GenericBeanDefinition();
			definition.setBeanClass(type);
			registry.registerBeanDefinition(name,definition);
		}

		private void assertHasAnnotation(Class<?> type) {...}
		private boolean containsBeanDefinition(ConfigurableListableBeanFactory beanFactory,String name) {...}
	}
複製程式碼

邏輯解讀：
主邏輯入口（registerBeanDefinitions） 1 -> getTypes(metadata)拿到標註EnableConfigurationProperties註解的配置值，整理成List<Class<?>>然後逐個處理 2 -> 對每個元素（Class<?>）呼叫register方法處理 3 -> register方法通過類當中的ConfigurationProperties註解的prefix值加類名字作為beanName通過registry.registerBeanDefinition呼叫將Class<?>註冊到registry當中 當標註註解@ConfigurationProperties的XXXProperties的BeanDefinition加入到registry中後，Bean的初始化就交給spring容器， 而這個過程中前面提到的ConfigurationPropertiesBindingPostProcessorRegistrar就完成一系列的後置操作幫助我們完成最終的值繫結

3. 總結

@ConfigurationProperties的整體處理過程，本文已經基本講述完畢，現在大體總結一下： EnableConfigurationProperties完成ConfigurationPropertiesBindingPostProcessorRegistrar及ConfigurationPropertiesBeanRegistrar的引入 其中：

  • ConfigurationPropertiesBeanRegistrar完成標註@ConfigurationProperties的類的查詢並組裝成BeanDefinition加入registry
  • ConfigurationPropertiesBindingPostProcessorRegistrar完成ConfigurationPropertiesBindingPostProcessor及ConfigurationBeanFactoryMetadata
    • ConfigurationPropertiesBindingPostProcessor完成所有標註@ConfigurationProperties的Bean到prefix的properties值繫結
    • ConfigurationBeanFactoryMetadata僅用於提供上面處理中需要的一些元資料資訊

4. 作者其他文章

github.com/zrbcool/blo…

5. 微信訂閱號

相關推薦

Spring Boot中@ConfigurationProperties註解實現原理原始碼解析

0. 開源專案推薦 Pepper Metrics是我與同事開發的一個開源工具(github.com/zrbcool/pep…)，其通過收集jedis/mybatis/httpservlet/dubbo/motan的執行效能統計，並暴露成prometheus等主流時序資料庫相容資料，通過gra

Spring Boot中使用註解實現簡單工廠模式

前言 從設計模式的型別上來說，簡單工廠模式是屬於建立型模式，又叫靜態工廠模式（Simple Factory Pattern），但不屬於23種GOF設計模式之一。簡單工廠模式是由一個工廠物件決定創建出介面哪一種實現類的例項。簡單工

Spring Boot中常用註解@Configuration，@Component，@Service，@Controller的區別

之前學習Spring Boot有點囫圇吞棗的意味，沒有細究這些註解間的差異。現在空下來重新回過頭來閱讀官方文件才對這幾個註解有了重新的理解，專門寫下來好供日後查詢翻閱。

Spring Boot 中使用 Quartz 實現任務排程

Quartz 概述 Quartz 是 OpenSymphony 開源組織在 Job Scheduling 領域又一個開源專案，它可以與 J2EE、 J2SE 應用程式相結合也可以單獨使用。Quartz 可以用來建立簡單或為執行十個，百個，甚至是好幾萬個 Jobs 這樣複

spring-boot中IO流實現檔案下載（java端）

技術標籤：實踐筆記 spring-boot中IO流實現檔案下載（java端） @GetMapping("/exportFile")

Spring Boot中使用@Async實現非同步呼叫，加速任務的執行！

什麼是“非同步呼叫”？“非同步呼叫”對應的是“同步呼叫”，同步呼叫指程式按照定義順序依次執行，每一行程式都必須等待上一行程式執行完成之後才能執行；非同步呼叫指程式在順序執行時，不等待非同步呼叫的語句返

Spring Boot中Bean定義方呼叫方式解析

我們知道如果我們要在一個類使用spring提供的bean物件，我們需要把這個類注入到spring容器中，交給spring容器進行管理，但是在實際當中，我們往往會碰到在一個普通的Java類中，想直接使用spring提供的其他物件或者說

Spring Boot自定義favicon實現方法例項解析

自定義歡迎頁 Spring Boot 專案在啟動後，首先會去靜態資源路徑下查詢index.html作為首頁檔案，若查詢不到，則會去查詢動態的index檔案作為首頁檔案。例如，如果想使用靜態的index.html作為首頁，那麼只需在resource

Spring Boot中註解@ConfigurationProperties

在Spring Boot中註解@ConfigurationProperties有三種使用場景，而通常情況下我們使用的最多的只是其中的一種場景。本篇文章帶大家瞭解一下三種場景的使用情況。

springboot允許跨域註解_SpringBoot專案針對跨域問題的三種解決方案 在Spring Boot 中給我們提供了一個註解 @CrossOrigin 來實現跨域

springboot允許跨域註解_SpringBoot專案針對跨域問題的三種解決方案 1. 什麼是跨域

spring boot中的條件裝配bean的實現

條件裝配 從Spring Framework 3.1開始,允許在Bean裝配時增加前置條件判斷。 啥是條件裝配

spring-boot中使用spring-boot-devtools的實現程式碼

1. 什麼是 spring-boot-devtools spring-boot-devtools 是 spring-boot專案開發時的一個熱部署工具，安裝了 spring-boot-devtools 依賴，我們在修改原始碼後無需 mvn spring-boot:run 手動重啟spring-boot專案，spr

在Spring Boot中載入初始化資料的實現

在Spring Boot中，Spring Boot會自動搜尋對映的Entity，並且建立相應的table，但是有時候我們希望自定義某些內容，這時候我們就需要使用到data.sql和schema.sql。

Spring中@Async註解實現非同步調詳解

非同步呼叫 在解釋非同步呼叫之前，我們先來看同步呼叫的定義；同步就是整個處理過程順序執行，當各個過程都執行完畢，並返回結果。 非同步呼叫則是隻是傳送了呼叫的指令，呼叫者無需等待被呼叫的方法完全執行完畢,繼

Spring Boot 中使用 @Transactional 註解配置事務管理

事務管理是應用系統開發中必不可少的一部分。Spring 為事務管理提供了豐富的功能支援。Spring 事務管理分為程式設計式和宣告式的兩種方式。程式設計式事務指的是通過編碼方式實現事務；宣告式事務基於 AOP,將具體業務

聊聊 Spring Boot 中的 @Conditional 註解

閱讀 SpringBoot 自動配置原始碼的時候，可以看到很多以 @Conditional 開頭的註解，

Spring boot 自定義註解，Java通過反射獲取註解，及註解的說明，附原始碼下載！

內容簡介 　　本文介紹在Java中 Spring 框架下自定義註解的宣告和使用，並利用反射來獲取到自定義註解及註解的屬性和值。

Spring Boot 中實現定時任務的兩種方式【轉】

在 Spring + SpringMVC 環境中，一般來說，要實現定時任務，我們有兩中方案，一種是使用 Spring 自帶的定時任務處理器 @Scheduled 註解，另一種就是使用第三方框架 Quartz ，Spring Boot 源自 Spring+SpringMVC ，因

Spring Boot 自動配置註解原始碼解析

前言 為什麼Spring Boot這麼火？因為便捷，開箱即用，但是你思考過為什麼會這麼便捷嗎？傳統的SSM架構配置檔案至少要寫半天，而使用Spring Boot之後只需要引入一個starter之後就能直接使用，why？？？

@async 預設執行緒池_Spring 原始碼學習 @Async註解實現原理

技術標籤：@async 預設執行緒池@async註解@order註解exceptionhandler註解java註解的實現原理notnull註解