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

### 為什麼要自定義application context
- 在學習spring容器初始化的過程中，發現spring容器預留了一些擴充套件點，我們可以寫子類來做功能擴充套件，例如AbstractApplicationContext類的initPropertySources、postProcessBeanFactory、onRefresh等方法都是空方法，留給子類來擴充套件用；

### 在傳統spring框架下的擴充套件方式
- 傳統的spring框架下使用哪個ApplicationContext實現類，是自己寫程式碼來指定的，下面是基於spring框架的應用的啟動程式碼：
```java
public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        Simple bean = context.getBean(Simple.class);
        bean.execute();
        context.close();
    }
```
- 如果我們要用自定的ApplicationContext實現類，只要將上面的ClassPathXmlApplicationContext改成我們做的類即可；

### 探尋SpringBoot框架下的擴充套件方式
- 先看一段程式碼，以下是一個SpringBoot應用啟動的程式碼：
```java
@SpringBootApplication
public class CustomizeapplicationcontextApplication {

public static void main(String[] args) {
		SpringApplication springApplication = new SpringApplication(CustomizeapplicationcontextApplication.class);
		springApplication.run(args);
	}
}
```

- 從上述程式碼可知，我們需要去檢視SpingApplication的run方法原始碼，那裡應該有ApplicationContext初始化相關的資訊，在SpingApplication的run方法中，果然找到了有用資訊，如下圖紅框所示，是createApplicationContext方法建立了ApplicationContext實現類：

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

- 去看看createApplicationContext方法，如下圖：

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

- 上圖中有兩點需要注意：
1. 紅框中顯示，ApplicationContext實現類來自成員變數applicationContextClass，只要我們能設定成員變數applicationContextClass，就達到了目的：在應用中使用自定義的ApplicationContext實現類；
2. 綠框中顯示，如果沒有設定成員變數applicationContextClass，就把AnnotationConfigServletWebServerApplicationContext作為ApplicationContext實現類，用在spring環境中，所以，我們在自定義ApplicationContext實現類時，用AnnotationConfigServletWebServerApplicationContext作為父類最合適（除了我們自己擴充套件的東西，其他部分都和預設的保持一致）；

### 如何設定自定義的ApplicationContext實現類
- 從createApplicationContext方法可以看出，設定了成員變數applicationContextClass，就達到了使用自定義ApplicationContext實現類的目的，那麼如何設定成員變數applicationContextClass呢？就在下面這個setApplicationContextClass方法：
```java
public void setApplicationContextClass(
			Class extends ConfigurableApplicationContext> applicationContextClass) {
		this.applicationContextClass = applicationContextClass;
		if (!isWebApplicationContext(applicationContextClass)) {
			this.webApplicationType = WebApplicationType.NONE;
		}
	}
```

- 我們只要在啟動應用的時候，在呼叫springApplication的run方法之前先呼叫setApplicationContextClass方法就能指定ApplicationContext實現類了；

- 分析到此，您是否和我一樣有疑慮：setApplicationContextClass方法會不會被在其他地方被呼叫，導致我們的設定無效呢？透過以下兩種方法來檢查：
1. 在IntelliJ IDEA中，透過"Find Usages"的方式查詢該方法被呼叫的地方，結果只發現了一處SpringBootServletInitializer類的onStartup方法，這是war包形式的應用在配置Initializer的時候才會用到，main方法啟動的方式中不會用到；
2. 在setApplicationContextClass方法中打斷點，debug啟動應用，確認不會走進來；

### 實戰使用自定義的ApplicationContext實現類
- 理論分析完畢，可以實戰驗證了：
- 基於maven建立一個SpringBoot的web應用，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>customizeapplicationcontext</artifactid>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

<name>customizeapplicationcontext</name>
	<description>Demo project for Spring Boot</description>

<parent>
		<groupid>org.springframework.boot</groupid>
		<artifactid>spring-boot-starter-parent</artifactid>
		<version>2.0.4.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>
```
- 建立類CustomizeApplicationContext，繼承自AnnotationConfigServletWebServerApplicationContext，重寫了父類的幾個方法，如下：

```java
package com.bolingcavalry.customizeapplicationcontext;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext;

/**
 * @Description : 自定義的ApplicationContext實現類
 * @Author : zq2599@gmail.com
 * @Date : 2018-08-11 17:12
 */
public class CustomizeApplicationContext extends AnnotationConfigServletWebServerApplicationContext {

Log logger = LogFactory.getLog(CustomizeApplicationContext.class);

@Override
    protected void initPropertySources() {
        super.initPropertySources();
        logger.info("execute override initPropertySources");
    }

@Override
    protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
        super.postProcessBeanFactory(beanFactory);
        logger.info("execute override postProcessBeanFactory");
    }

@Override
    protected void onRefresh() {
        super.onRefresh();
        logger.info("execute override onRefresh");
    }
}

```
- 啟動類CustomizeapplicationcontextApplication的main方法中，呼叫setApplicationContextClass方法，將ApplicationContext實現類設定為CustomizeApplicationContext：

```java
package com.bolingcavalry.customizeapplicationcontext;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class CustomizeapplicationcontextApplication {

public static void main(String[] args) {
		SpringApplication springApplication = new SpringApplication(CustomizeapplicationcontextApplication.class);
		springApplication.setApplicationContextClass(CustomizeApplicationContext.class);
		springApplication.run(args);
	}
}
```
- 啟動應用，檢視日誌如下，CustomizeApplicationContext中重寫的方法都被執行了，並且initPropertySources被執行了兩次，那是因為除了AbstractApplicationContext類中有呼叫，在ServletWebServerApplicationContext類的onRefresh中會執行createWebServer方法，而createWebServer方法中也會呼叫一次initPropertySources方法：

```shell
2018-08-11 17:21:18.833  INFO 5132 --- [           main] c.CustomizeapplicationcontextApplication : Starting CustomizeapplicationcontextApplication on zhaoqinwin10 with PID 5132 (D:\temp\201808\09\customizeapplicationcontext\target\classes started by 12167 in D:\temp\201808\09\customizeapplicationcontext)
2018-08-11 17:21:18.840  INFO 5132 --- [           main] c.CustomizeapplicationcontextApplication : No active profile set, falling back to default profiles: default
2018-08-11 17:21:18.957  INFO 5132 --- [           main] c.b.c.CustomizeApplicationContext        : Refreshing com.bolingcavalry.customizeapplicationcontext.CustomizeApplicationContext@5906ebcb: startup date [Sat Aug 11 17:21:18 CST 2018]; root of context hierarchy
2018-08-11 17:21:18.958  INFO 5132 --- [           main] c.b.c.CustomizeApplicationContext        : execute override initPropertySources
2018-08-11 17:21:18.967  INFO 5132 --- [           main] c.b.c.CustomizeApplicationContext        : execute override postProcessBeanFactory
2018-08-11 17:21:20.085  INFO 5132 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2018-08-11 17:21:20.102  INFO 5132 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2018-08-11 17:21:20.103  INFO 5132 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/8.5.32
2018-08-11 17:21:20.106  INFO 5132 --- [ost-startStop-1] o.a.catalina.core.AprLifecycleListener   : The APR based Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: [C:\jdk\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\ProgramData\Oracle\Java\javapath;C:\Program Files (x86)\Intel\iCLS Client\;C:\Program Files\Intel\iCLS Client\;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\Program Files (x86)\Intel\Intel(R) Management Engine Components\DAL;C:\Program Files\Intel\Intel(R) Management Engine Components\DAL;C:\Program Files (x86)\Intel\Intel(R) Management Engine Components\IPT;C:\Program Files\Intel\Intel(R) Management Engine Components\IPT;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\Intel\WiFi\bin\;C:\Program Files\Common Files\Intel\WirelessCommon\;C:\software\apache-maven-3.3.3\bin\;C:\software\Git\bin;E:\work\dubbo\zookeeper-3.3.6/bin;E:\work\dubbo\zookeeper-3.3.6/conf;D:\soft\gradle-1.1\bin;C:\jdk\bin;C:\software\svn\bin;D:\software\AndroidSdk\platform-tools;D:\software\calibre\;D:\software\gradle-2.14.1\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\Program Files\Git\cmd;C:\Users\12167\AppData\Local\Microsoft\WindowsApps;C:\Users\12167\AppData\Local\Programs\Fiddler;%USERPROFILE%\AppData\Local\Microsoft\WindowsApps;.]
2018-08-11 17:21:20.226  INFO 5132 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2018-08-11 17:21:20.227  INFO 5132 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1273 ms
2018-08-11 17:21:20.305  INFO 5132 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean  : Servlet dispatcherServlet mapped to [/]
2018-08-11 17:21:20.310  INFO 5132 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'characterEncodingFilter' to: [/*]
2018-08-11 17:21:20.310  INFO 5132 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
2018-08-11 17:21:20.310  INFO 5132 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'httpPutFormContentFilter' to: [/*]
2018-08-11 17:21:20.310  INFO 5132 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]
2018-08-11 17:21:20.330  INFO 5132 --- [           main] c.b.c.CustomizeApplicationContext        : execute override initPropertySources
2018-08-11 17:21:20.330  INFO 5132 --- [           main] c.b.c.CustomizeApplicationContext        : execute override onRefresh
```

### 實戰原始碼下載
- 本章實戰的原始碼可以在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專案中有多個資料夾，本章原始碼在資料夾customizeapplicationcontext下，如下圖紅框所示：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220609/1654750909582361292.png)

- 至此，我們透過檢視SpringApplication的原始碼，搞清楚了spring環境的ApplicationContext實現類在SpringBoot框架下如何指定，也做了一次簡單的自定義實戰，今後在研究和學習spring過程中，如果需要擴充套件spring容器就能在SpringBoot環境下進行了，相比傳統的war包部署、以及指定多個jar包的classpath等操作，springboot應用的單個jar包更方便省事。

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

SpringBoot應用使用自定義的ApplicationContext實現類

相關文章