### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

- 本章是《spring4.1.8擴充套件實戰》系列的第六篇，目標是學習如何透過自己寫程式碼的方式，向spring容器中註冊bean；

### 關於註冊bean到容器
- 我們開發的類，如果想註冊到spring容器，讓spring來完成例項化，常用方式如下：
1. xml中透過bean節點來配置；
2. 使用@Service、@Controller、@Conponent等註解；
- 其實，除了以上方式，spring還支援我們透過程式碼來將指定的類註冊到spring容器中，也就是今天我們要實踐的主要內容，接下來就從spring原始碼開始，先學習原始碼再動手實戰；

### 本章概要
- 本章由以下幾部分組成：
1. 瞭解BeanDefinitionRegistryPostProcessor介面；
2. 分析spring容器如何使用BeanDefinitionRegistryPostProcessor介面；
3. 實戰，開發BeanDefinitionRegistryPostProcessor介面的實現類，驗證透過程式碼註冊bean的功能；

### 瞭解BeanDefinitionRegistryPostProcessor介面
- 實現註冊bean功能的關鍵是BeanDefinitionRegistryPostProcessor介面，來看看這介面的繼承關係，如下圖：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220615/1655305086271757303.png)

- BeanDefinitionRegistryPostProcessor繼承了BeanFactoryPostProcessor介面，關於BeanFactoryPostProcessor我們在上一章[《spring4.1.8擴充套件實戰之五：改變bean的定義(BeanFactoryPostProcessor介面)》](http://blog.itpub.net/70017844/viewspace-2900595/)已做了詳細的分析和實戰，知道BeanFactoryPostProcessor的實現類在其postProcessBeanFactory方法被呼叫時，可以對bean的定義進行控制，因此BeanDefinitionRegistryPostProcessor的實現類一共要實現以下兩個方法：
- void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException：
該方法的實現中，主要用來對bean定義做一些改變，這些在上一章[《spring4.1.8擴充套件實戰之五：改變bean的定義(BeanFactoryPostProcessor介面)》](http://blog.itpub.net/70017844/viewspace-2900595/)有詳細說明；

- void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException：
該方法用來註冊更多的bean到spring容器中，詳細觀察入參BeanDefinitionRegistry介面，看看這個引數能帶給我們什麼能力：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220615/1655305105035792274.png)

- 從上圖可以看到，為了能讓我們透過程式碼將bean註冊到spring環境，BeanDefinitionRegistry提供了豐富的方法來操作bean定義，判斷、註冊、反註冊等方法都準備好了，我們在編寫postProcessBeanDefinitionRegistry方法的內容時，就能直接使用入參registry的這些方法來完成判斷和註冊、反註冊等操作；

### 分析spring容器如何使用BeanDefinitionRegistryPostProcessor介面
- 來看看BeanDefinitionRegistryPostProcessor介面的實現類，是在哪裡被spring容器使用的：
- 如下圖所示，紅框中的invokeBeanFactoryPostProcessors方法用來找出所有beanFactory後置處理器，並且呼叫這些處理器來改變bean的定義：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220615/1655305125418811873.png)

- 開啟invokeBeanFactoryPostProcessors方法，如下所示，實際操作是委託PostProcessorRegistrationDelegate去完成的：

```java
protected void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory) {
        PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());
    }
```

- 繼續看PostProcessorRegistrationDelegate類的invokeBeanFactoryPostProcessors方法，該方法內容太豐富，我們只看重點，第一個重點如下圖紅框所示，==當前的beanFactory是否實現了介面BeanDefinitionRegistry==：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220615/1655305146863571654.png)

- 為了搞清楚這個問題，我們應該看看當前beanFactory的繼承和實現，以springboot中的應用為例，當前beanFactory的型別是DefaultListableBeanFactory，來看看它的類圖：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220615/1655305161738704635.png)

- 從上圖紅框可見，beanFactory實現了BeanDefinitionRegistry介面，因此我們的關注點是if條件滿足後的執行邏輯；
- 繼續看PostProcessorRegistrationDelegate類的invokeBeanFactoryPostProcessors方法，以下片段就是操作BeanDefinitionRegistryPostProcessor的核心邏輯：

```java
boolean reiterate = true;
while (reiterate) {
	reiterate = false;
	//查出所有實現了BeanDefinitionRegistryPostProcessor介面的bean名稱
	postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
	for (String ppName : postProcessorNames) {
		//前面的邏輯中，已經對實現了PriorityOrdered和Ordered的bean都處理過了，因此透過processedBeans過濾，processedBeans中沒有的才會在此處理
		if (!processedBeans.contains(ppName)) {
			//根據名稱和型別獲取bean
			BeanDefinitionRegistryPostProcessor pp = beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class);
			//把已經呼叫過postProcessBeanDefinitionRegistry方法的bean全部放在registryPostProcessors中
			registryPostProcessors.add(pp);
			//把已經呼叫過postProcessBeanDefinitionRegistry方法的bean的名稱全部放在processedBeans中
			processedBeans.add(ppName);
			//執行此bean的postProcessBeanDefinitionRegistry方法
			pp.postProcessBeanDefinitionRegistry(registry);
			//改變退出while的條件
			reiterate = true;
		}
	}
}

//registryPostProcessors中儲存了所有執行過postProcessBeanDefinitionRegistry方法的bean，
//現在再來執行這些bean的postProcessBeanFactory方法
invokeBeanFactoryPostProcessors(registryPostProcessors, beanFactory);
//regularPostProcessors中儲存的是所有入參中帶來的BeanFactoryPostProcessor實現類，並且這裡面已經剔除了BeanDefinitionRegistryPostProcessor的實現類，現在要讓這些bean執行postProcessBeanFactory方法
invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory);
```
- 如上述程式碼所示，所有實現了BeanDefinitionRegistryPostProcessor介面的bean，其postProcessBeanDefinitionRegistry方法都會呼叫，然後再呼叫其postProcessBeanFactory方法，這樣一來，我們如果自定義了BeanDefinitionRegistryPostProcessor介面的實現類，那麼我們開發的postProcessBeanDefinitionRegistry和postProcessBeanFactory方法都會被執行一次；

- 到這裡，我們的原始碼學習部分就完成了，接下來看開始實戰吧；

### 實戰，開發BeanDefinitionRegistryPostProcessor介面的實現類
- 本次實戰的內容是建立一個springboot工程，在裡面自定義一個BeanDefinitionRegistryPostProcessor介面的實現類，如果您不想敲程式碼，也可以去github下載原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章原始碼在資料夾customizebeandefinitionregistrypostprocessor下，如下圖紅框所示：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220615/1655305180627587339.png)

- 接下來開始實戰吧：
- 基於maven建立一個springboot的web工程，名為customizebeandefinitionregistrypostprocessor，pom.xml如下：

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelversion>4.0.0</modelversion>

<groupid>com.bolingcavalry</groupid>
	<artifactid>customizebeandefinitionregistrypostprocessor</artifactid>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

<name>customizebeandefinitionregistrypostprocessor</name>
	<description>Demo project for customize BeanDefinitionRegistryPostProcessor</description>

<parent>
		<groupid>org.springframework.boot</groupid>
		<artifactid>spring-boot-starter-parent</artifactid>
		<version>1.5.15.RELEASE</version>
		<relativepath></relativepath> 
	</parent>

<dependencies>
		<dependency>
			<groupid>org.springframework.boot</groupid>
			<artifactid>spring-boot-starter-web</artifactid>
		</dependency>

<dependency>
			<groupid>org.springframework.boot</groupid>
			<artifactid>spring-boot-starter-test</artifactid>
			<scope>test</scope>
		</dependency>
	</dependencies>

<build>
		<plugins>
			<plugin>
				<groupid>org.springframework.boot</groupid>
				<artifactid>spring-boot-maven-plugin</artifactid>
			</plugin>
		</plugins>
	</build>
</project>
```

- 定義一個服務介面CalculateService：

```java
package com.bolingcavalry.customizebeandefinitionregistrypostprocessor.service;

public interface CalculateService {
    /**
     * 整數加法
     * @param a
     * @param b
     * @return
     */
    int add(int a, int b);

/**
     * 返回當前實現類的描述資訊
     * @return
     */
    String getServiceDesc();
}

```

- 建立CalculateService介面的實現類CalculateServiceImpl，==注意，不要將其宣告為spring的bean==：

```java
package com.bolingcavalry.customizebeandefinitionregistrypostprocessor.service.impl;

import com.bolingcavalry.customizebeandefinitionregistrypostprocessor.service.CalculateService;

public class CalculateServiceImpl implements CalculateService {

private String desc = "desc from class";

public void setDesc(String desc) {
        this.desc = desc;
    }

@Override
    public int add(int a, int b) {
        return a + b;
    }

@Override
    public String getServiceDesc() {
        return desc;
    }
}

```

- 建立工具類Utils，裡面是些工具方法，例如在日誌中列印出當前執行緒的執行堆疊：

```java
package com.bolingcavalry.customizebeandefinitionregistrypostprocessor.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @Description : 提供一些常用的工具方法
 * @Author : zq2599@gmail.com
 * @Date : 2018-08-14 05:51
 */
public class Utils {

private static final Logger logger = LoggerFactory.getLogger(Utils.class);

/**
     * 列印當前執行緒堆疊資訊
     * @param prefix
     */
    public static void printTrack(String prefix){
        StackTraceElement[] st = Thread.currentThread().getStackTrace();

if(null==st){
            logger.info("invalid stack");
            return;
        }

StringBuffer sbf =new StringBuffer();

for(StackTraceElement e:st){
            if(sbf.length()>0){
                sbf.append("  [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

spring4.1.8擴充套件實戰之六：註冊bean(BeanDefinitionRegistryPostProcessor)

相關文章