Spring體系的各種啟動流程詳解
在介紹spring的啟動之前，先來說下啟動過程中使用到的幾個類
基本組件
1、BeanFactory：spring底層容器，定義瞭最基本的容器功能，註意區分FactoryBean
2、ApplicationContext：擴展於BeanFactory，擁有更豐富的功能。例如：添加事件發佈機制、父子級容器，一般都是直接使用ApplicationContext。
3、Resource：bean配置文件，一般為xml文件。可以理解為保存bean信息的文件。
4、BeanDefinition：beandifinition定義瞭bean的基本信息，根據它來創造bean
基礎流程
不管是哪種系列的spring（springframework、springmvc、springboot、springcloud），Spring的啟動過程主要可以分為兩部分：
第一步：解析成BeanDefinition：將bean定義信息解析為BeanDefinition類，不管bean信息是定義在xml中，還是通過@Bean註解標註，都能通過不同的BeanDefinitionReader轉為BeanDefinition類，將BeanDefinition向Map中註冊 Map<name,beandefinition>。這裡分兩種BeanDefinition，RootBeanDefintion和BeanDefinition。RootBeanDefinition這種是系統級別的，是啟動Spring必須加載的6個Bean。BeanDefinition是我們定義的Bean。
第二步：參照BeanDefintion定義的類信息，通過BeanFactory生成bean實例存放在緩存中。這裡的BeanFactoryPostProcessor是一個攔截器，在BeanDefinition實例化後，BeanFactory生成該Bean之前，可以對BeanDefinition進行修改。BeanFactory根據BeanDefinition定義使用反射實例化Bean，實例化和初始化Bean的過程中就涉及到Bean的生命周期瞭，典型的問題就是Bean的循環依賴。接著，Bean實例化前會判斷該Bean是否需要增強，並決定使用哪種代理來生成Bean。
Springframework
1、容器類
在一般性的spring項目中，大傢應該也都知道，一般是通過直接實例化applicationContext類，來實現項目的啟動 下面我們來看下通過註解的方式來啟動的情況，註解容器定義如下：
public AnnotationConfigApplicationContext(Class<?>... componentClasses) {
this();
register(componentClasses);
refresh();
}
public AnnotationConfigApplicationContext() {
this.reader = new AnnotatedBeanDefinitionReader(this);
this.scanner = new ClassPathBeanDefinitionScanner(this);
}
創建瞭註解定義bean讀取器和配置文件定義bean掃描器
2、註解定義bean讀取器
進入該類構造器中，可以看到最終會執行該方法：
public static Set<BeanDefinitionHolder> registerAnnotationConfigProcessors(
BeanDefinitionRegistry registry, @Nullable Object source) {
DefaultListableBeanFactory beanFactory = unwrapDefaultListableBeanFactory(registry);
if (beanFactory != null) {
if (!(beanFactory.getDependencyComparator() instanceof AnnotationAwareOrderComparator)) {
beanFactory.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE);
}
if (!(beanFactory.getAutowireCandidateResolver() instanceof ContextAnnotationAutowireCandidateResolver)) {
beanFactory.setAutowireCandidateResolver(new ContextAnnotationAutowireCandidateResolver());
}
}
Set<BeanDefinitionHolder> beanDefs = new LinkedHashSet<>(8);
if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) {
RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class);
def.setSource(source);
beanDefs.add(registerPostProcessor(registry, def, CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME));
}
if (!registry.containsBeanDefinition(AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) {
RootBeanDefinition def = new RootBeanDefinition(AutowiredAnnotationBeanPostProcessor.class);
def.setSource(source);
beanDefs.add(registerPostProcessor(registry, def, AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME));
}
...
}
註冊瞭6個RootBeanDefinition，即系統級別的BeanDefinition。同時，經過調用registerPostProcessor->registerBeanDefinition，可以看到註冊BeanDefinition其實就是放到BeanFactory的緩存中。
DefaultListableBeanFactory.java類中
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException {
...
this.beanDefinitionMap.put(beanName, beanDefinition);
...
}
上面的6個beanDefinition的實例參數中都有一個postprocessor後綴的類，我們分別點擊進入查看即繼承關系，可以看到，最終都繼承自“接口
public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor {
void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry var1) throws BeansException;
}
@FunctionalInterface
public interface BeanFactoryPostProcessor {
void postProcessBeanFactory(ConfigurableListableBeanFactory var1) throws BeansException;
}
3、BeanFactoryPostProcessor
1、BeanFactoryPostProcessor是spring初始化bean的擴展點。
官文翻譯如下：允許自定義修改應用程序上下文的bean定義，調整上下文的基礎bean工廠的bean屬性值。應用程序上下文可以在其bean定義中自動檢測BeanFactoryPostProcessor bean，並在創建任何其他bean之前先創建BeanFactoryPostProcessor。
BeanFactoryPostProcessor可以與bean定義交互並修改bean定義，但絕不能與bean實例交互。這樣做可能會導致bean過早實例化，違反容器並導致意外的副作用。如果需要bean實例交互，請考慮實現BeanPostProcessor。實現該接口，可以允許我們的程序獲取到BeanFactory，從而修改BeanFactory，可以實現編程式的往Spring容器中添加Bean。
也就是說，我們可以通過實現BeanFactoryPostProcessor接口，獲取BeanFactory，操作BeanFactory對象，修改BeanDefinition，但不要去實例化bean。
2、BeanDefinitionRegistryPostProcessor是BeanFactoryPostProcessor的子類，在父類的基礎上，增加瞭新的方法，允許我們獲取到BeanDefinitionRegistry，從而編碼動態修改BeanDefinition。
例如往BeanDefinition中添加一個新的BeanDefinition。
這兩個接口是在AbstractApplicationContext#refresh方法中執行到invokeBeanFactoryPostProcessors(beanFactory);方法時被執行的。
3、示例代碼如下：
@Repository
public class OrderDao {
public void query() {
System.out.println("OrderDao query...");
}
}
public class OrderService {
private OrderDao orderDao;
public void setDao(OrderDao orderDao) {
this.orderDao = orderDao;
}
public void init() {
System.out.println("OrderService init...");
}
public void query() {
orderDao.query();
}
}
@Component
public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
//向Spring容器中註冊OrderService
BeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(OrderService.class)
//這裡的屬性名是根據setter方法
.addPropertyReference("dao", "orderDao")
.setInitMethodName("init")
.setScope(BeanDefinition.SCOPE_SINGLETON)
.getBeanDefinition();
registry.registerBeanDefinition("orderService", beanDefinition);
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
// 在這裡修改orderService bean的scope為PROTOTYPE
BeanDefinition beanDefinition = beanFactory.getBeanDefinition("orderService");
beanDefinition.setScope(BeanDefinition.SCOPE_PROTOTYPE);
}
}
回到上面，我們拿ConfigurationClassPostProcessor來說：在Spring中ConfigurationClassPostProcessor同時實現瞭BeanDefinitionRegistryPostProcessor接口和其父類接口中的方法。
1、ConfigurationClassPostProcessor#postProcessBeanFactory：主要負責對Full Configuration 配置進行增強，攔截@Bean方法來確保增強執行@Bean方法的語義。
2、ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry：負責掃描我們的程序，根據程序的中Bean創建BeanDefinition，並註冊到容器中。
我們進入到：
private void loadBeanDefinitionsForConfigurationClass(
ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) {
if (trackedConditionEvaluator.shouldSkip(configClass)) {
String beanName = configClass.getBeanName();
if (StringUtils.hasLength(beanName) && this.registry.containsBeanDefinition(beanName)) {
this.registry.removeBeanDefinition(beanName);
}
this.importRegistry.removeImportingClass(configClass.getMetadata().getClassName());
return;
}
if (configClass.isImported()) {
registerBeanDefinitionForImportedConfigurationClass(configClass);
}
for (BeanMethod beanMethod : configClass.getBeanMethods()) {
loadBeanDefinitionsForBeanMethod(beanMethod);
}
loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());
loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars());
}
其中，我們可以看到：
1、通過檢查是否有·@import·註解，來註冊該導入類到容器中
if (configClass.isImported()) {
registerBeanDefinitionForImportedConfigurationClass(configClass);
}
2、遍歷@Configuration類中的@bean註解，將其類註冊到容器中
if (configClass.isImported()) {
registerBeanDefinitionForImportedConfigurationClass(configClass);
}
4、refresh
這個方法就是正式進行bean的處理的主要邏輯
@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// Prepare this context for refreshing.
prepareRefresh();
// Tell the subclass to refresh the internal bean factory.
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.
prepareBeanFactory(beanFactory);
try {
// Allows post-processing of the bean factory in context subclasses.
postProcessBeanFactory(beanFactory);
// Invoke factory processors registered as beans in the context.
invokeBeanFactoryPostProcessors(beanFactory);
// Register bean processors that intercept bean creation.
registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.
initMessageSource();
// Initialize event multicaster for this context.
initApplicationEventMulticaster();
// Initialize other special beans in specific context subclasses.
onRefresh();
// Check for listener beans and register them.
registerListeners();
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
resetCommonCaches();
}
}
}
前面說的一些擴展點類都是在這裡才處理的，spring的擴展機制後面會有專門的文章來講解。
SpringMVC
而在web項目中，我們一般都是使用的spring mvc，Spring Framework本身沒有Web功能，Spring MVC使用WebApplicationContext類擴展ApplicationContext，使得擁有web功能。
那麼，Spring MVC是如何在web環境中創建IoC容器呢？web環境中的IoC容器的結構又是什麼結構呢？web環境中，Spring IoC容器是怎麼啟動呢？
1、配置
以Tomcat為例，在Web容器中使用Spirng MVC，必須進行四項的配置：
修改web.xml，添加servlet定義；
編寫servletname-servlet.xml（servletname是在web.xm中配置DispactherServlet時使servlet-name的值）配置；
contextConfigLocation初始化參數
配置ContextLoaderListerner；示例配置如下：
<!-- servlet定義：前端處理器，接受的HTTP請求和轉發請求的類 --> <servlet> <servlet-name>court</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <!-- court-servlet.xml：定義WebAppliactionContext上下文中的bean --> <param-name>contextConfigLocation</param-name> <param-value>classpath*:court-servlet.xml</param-value> </init-param> <load-on-startup>0</load-on-startup> </servlet> <servlet-mapping> <servlet-name>court</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <!-- 配置contextConfigLocation初始化參數：指定Spring IoC容器需要讀取的定義瞭非web層的Bean（DAO/Service）的XML文件路徑 --> <context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/court-service.xml</param-value> </context-param> <!-- 配置ContextLoaderListerner：Spring MVC在Web容器中的啟動類，負責Spring IoC容器在Web上下文中的初始化 --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener>
在web.xml配置文件中，有兩個主要的配置：ContextLoaderListener和DispatcherServlet。
同樣的關於spring配置文件的相關配置也有兩部分：context-param和DispatcherServlet中的init-param。
那麼，這兩部分的配置有什麼區別呢？它們都擔任什麼樣的職責呢？
在Spring MVC中，Spring Context是以父子的繼承結構存在的。
Web環境中存在一個ROOT Context，這個Context是整個應用的根上下文，是其他context的雙親Context。
同時Spring MVC也對應的持有一個獨立的Context，它是ROOT Context的子上下文。
對於這樣的Context結構在Spring MVC中是如何實現的呢？下面就先從ROOT Context入手，ROOT Context是在ContextLoaderListener中配置的，ContextLoaderListener讀取context-param中的contextConfigLocation指定的配置文件，創建ROOT Context。
2、啟動過程
Spring MVC啟動過程大致分為兩個過程：
- ContextLoaderListener初始化，實例化IoC容器，並將此容器實例註冊到ServletContext中；
- DispatcherServlet初始化；
tomcat在啟動的時候，會依次執行listeners的初始化，也就是執行該ContextLoaderListener的初始化，最終會調用下面的代碼:
public void contextInitialized(ServletContextEvent event) {
this.initWebApplicationContext(event.getServletContext());
}
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
//PS : ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE=WebApplicationContext.class.getName() + ".ROOT" 根上下文的名稱
//PS : 默認情況下，配置文件的位置和名稱是：DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml"
//在整個web應用中，隻能有一個根上下文
if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
throw new IllegalStateException("Cannot initialize context because there is already a root application context present - " + "check whether you have multiple ContextLoader* definitions in your web.xml!");
}
Log logger = LogFactory.getLog(ContextLoader.class);
servletContext.log("Initializing Spring root WebApplicationContext");
if (logger.isInfoEnabled()) {
logger.info("Root WebApplicationContext: initialization started");
}
long startTime = System.currentTimeMillis();
try {
// Store context in local instance variable, to guarantee that
// it is available on ServletContext shutdown.
if (this.context == null) {
// 在這裡執行瞭創建WebApplicationContext的操作
this.context = createWebApplicationContext(servletContext);
}
if (this.context instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
if (!cwac.isActive()) {
// The context has not yet been refreshed -> provide services such as
// setting the parent context, setting the application context id, etc
if (cwac.getParent() == null) {
// The context instance was injected without an explicit parent ->
// determine parent for root web application context, if any.
ApplicationContext parent = loadParentContext(servletContext);
cwac.setParent(parent);
}
configureAndRefreshWebApplicationContext(cwac, servletContext);
}
}
// PS: 將根上下文放置在servletContext中
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
ClassLoader ccl = Thread.currentThread().getContextClassLoader();
if (ccl == ContextLoader.class.getClassLoader()) {
currentContext = this.context;
} else if (ccl != null) {
currentContextPerThread.put(ccl, this.context);
}
if (logger.isDebugEnabled()) {
logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +
WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
}
if (logger.isInfoEnabled()) {
long elapsedTime = System.currentTimeMillis() - startTime;
logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
}
return this.context;
} catch (RuntimeException ex) {
logger.error("Context initialization failed", ex);
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
throw ex;
} catch (Error err) {
logger.error("Context initialization failed", err);
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
throw err;
}
}
我們註意到這樣一句configureAndRefreshWebApplicationContext(cwac, servletContext); 這個就是具體創建容器的方法，我們進入去看看
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
// The application context id is still set to its original default value
// -> assign a more useful id based on available information
String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
if (idParam != null) {
wac.setId(idParam);
}
else {
// Generate default id...
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
ObjectUtils.getDisplayString(sc.getContextPath()));
}
}
wac.setServletContext(sc);
String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
if (configLocationParam != null) {
wac.setConfigLocation(configLocationParam);
}
// The wac environment's #initPropertySources will be called in any case when the context
// is refreshed; do it eagerly here to ensure servlet property sources are in place for
// use in any post-processing or initialization that occurs below prior to #refresh
ConfigurableEnvironment env = wac.getEnvironment();
if (env instanceof ConfigurableWebEnvironment) {
((ConfigurableWebEnvironment) env).initPropertySources(sc, null);
}
customizeContext(sc, wac);
wac.refresh();
}
我們註意到wac.refresh();看起來是不是有點熟悉瞭，進入看看：
public final void refresh() throws BeansException, IllegalStateException {
try {
super.refresh();
}
catch (RuntimeException ex) {
WebServer webServer = this.webServer;
if (webServer != null) {
webServer.stop();
}
throw ex;
}
}
這裡的super根據繼承關系，我們知道，最終就是進入到瞭springframework中的refresh中，這個方法我們在上面已經說過瞭。
SpringBoot
啟動入口方法如下：
public static void main(String[] args) {
SpringApplication.run(ConsulApplication.class, args);
}
通過代碼的層層調用，最終會走到這樣的代碼中:
public ConfigurableApplicationContext run(String... args) {
StopWatch stopWatch = new StopWatch();
stopWatch.start();
ConfigurableApplicationContext context = null;
Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList();
this.configureHeadlessProperty();
SpringApplicationRunListeners listeners = this.getRunListeners(args);
listeners.starting();
Collection exceptionReporters;
try {
ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments);
this.configureIgnoreBeanInfo(environment);
Banner printedBanner = this.printBanner(environment);
context = this.createApplicationContext();
exceptionReporters = this.getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[]{ConfigurableApplicationContext.class}, context);
this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);
this.refreshContext(context);
this.afterRefresh(context, applicationArguments);
stopWatch.stop();
if (this.logStartupInfo) {
(new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);
}
listeners.started(context);
this.callRunners(context, applicationArguments);
} catch (Throwable var10) {
this.handleRunFailure(context, var10, exceptionReporters, listeners);
throw new IllegalStateException(var10);
}
try {
listeners.running(context);
return context;
} catch (Throwable var9) {
this.handleRunFailure(context, var9, exceptionReporters, (SpringApplicationRunListeners)null);
throw new IllegalStateException(var9);
}
}
可以看到，又走到瞭大傢都熟悉的spring啟動代碼裡面去瞭。
綜上：可以看出，不管是哪種系列的spring，最終都會走到spring基本的啟動流程中，無非就是根據自己的特性需要加瞭一些額外的處理罷瞭。
總結
到此這篇關於Spring體系的各種啟動流程的文章就介紹到這瞭,更多相關Spring啟動流程內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- Spring實現內置監聽器
- spring Bean創建的完整過程記錄
- Dubbo3的Spring適配原理與初始化流程源碼解析
- Spring源碼BeanFactoryPostProcessor詳解
- 基於Spring上下文工具類 ApplicationContextUtil