小言_互联网的博客

关于Spring体系的各种启动流程

399人阅读  评论(0)

在介绍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类,来实现项目的启动 下面我们来看下通过注解的方式来启动的情况,注解容器定义如下:


   
  1. public AnnotationConfigApplicationContext(Class<?>... componentClasses) {
  2. this();
  3. register(componentClasses);
  4. refresh();
  5. }
  6. public AnnotationConfigApplicationContext() {
  7. this.reader = new AnnotatedBeanDefinitionReader( this);
  8. this.scanner = new ClassPathBeanDefinitionScanner( this);
  9. }

创建了注解定义bean读取器和配置文件定义bean扫描器

2、注解定义bean读取器

进入该类构造器中,可以看到最终会执行该方法:


   
  1. public static Set<BeanDefinitionHolder> registerAnnotationConfigProcessors(
  2. BeanDefinitionRegistry registry, @Nullable Object source) {
  3. DefaultListableBeanFactory beanFactory = unwrapDefaultListableBeanFactory(registry);
  4. if (beanFactory != null) {
  5. if (!(beanFactory.getDependencyComparator() instanceof AnnotationAwareOrderComparator)) {
  6. beanFactory.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE);
  7. }
  8. if (!(beanFactory.getAutowireCandidateResolver() instanceof ContextAnnotationAutowireCandidateResolver)) {
  9. beanFactory.setAutowireCandidateResolver(new ContextAnnotationAutowireCandidateResolver());
  10. }
  11. }
  12. Set<BeanDefinitionHolder> beanDefs = new LinkedHashSet<>( 8);
  13. if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) {
  14. RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class);
  15. def.setSource(source);
  16. beanDefs.add(registerPostProcessor(registry, def, CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME));
  17. }
  18. if (!registry.containsBeanDefinition(AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) {
  19. RootBeanDefinition def = new RootBeanDefinition(AutowiredAnnotationBeanPostProcessor.class);
  20. def.setSource(source);
  21. beanDefs.add(registerPostProcessor(registry, def, AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME));
  22. }
  23. ...
  24. }

注册了6个RootBeanDefinition,即系统级别的BeanDefinition。同时,经过调用registerPostProcessor->registerBeanDefinition,可以看到注册BeanDefinition其实就是放到BeanFactory的缓存中。


   
  1. DefaultListableBeanFactory.java类中
  2. public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException {
  3. ...
  4. this.beanDefinitionMap.put(beanName, beanDefinition);
  5. ...
  6. }

上面的6个beanDefinition的实例参数中都有一个postprocessor后缀的类,我们分别点击进入查看即继承关系,可以看到,最终都继承自``接口


   
  1. public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor {
  2. void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry var1) throws BeansException;
  3. }
  4. @FunctionalInterface
  5. public interface BeanFactoryPostProcessor {
  6. void postProcessBeanFactory(ConfigurableListableBeanFactory var1) throws BeansException;
  7. }

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、示例代码如下:


   
  1. @Repository
  2. public class OrderDao {
  3. public void query() {
  4. System.out.println( "OrderDao query...");
  5. }
  6. }
  7. public class OrderService {
  8. private OrderDao orderDao;
  9. public void setDao(OrderDao orderDao) {
  10. this.orderDao = orderDao;
  11. }
  12. public void init() {
  13. System.out.println( "OrderService init...");
  14. }
  15. public void query() {
  16. orderDao.query();
  17. }
  18. }
  19. @Component
  20. public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
  21. @Override
  22. public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
  23. //向Spring容器中注册OrderService
  24. BeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(OrderService.class)
  25. //这里的属性名是根据setter方法
  26. .addPropertyReference("dao", "orderDao")
  27. .setInitMethodName("init")
  28. .setScope(BeanDefinition.SCOPE_SINGLETON)
  29. .getBeanDefinition();
  30. registry.registerBeanDefinition("orderService", beanDefinition);
  31. }
  32. @Override
  33. public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
  34. // 在这里修改orderService bean的scope为PROTOTYPE
  35. BeanDefinition beanDefinition = beanFactory.getBeanDefinition( "orderService");
  36. beanDefinition.setScope(BeanDefinition.SCOPE_PROTOTYPE);
  37. }
  38. }

回到上面,我们拿ConfigurationClassPostProcessor来说:在Spring中ConfigurationClassPostProcessor同时实现了BeanDefinitionRegistryPostProcessor接口和其父类接口中的方法。

  • 1、ConfigurationClassPostProcessor#postProcessBeanFactory:主要负责对Full Configuration 配置进行增强,拦截@Bean方法来确保增强执行@Bean方法的语义。

  • 2、ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry:负责扫描我们的程序,根据程序的中Bean创建BeanDefinition,并注册到容器中。

我们进入到:


   
  1. private void loadBeanDefinitionsForConfigurationClass(
  2. ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) {
  3. if (trackedConditionEvaluator.shouldSkip(configClass)) {
  4. String beanName = configClass.getBeanName();
  5. if (StringUtils.hasLength(beanName) && this.registry.containsBeanDefinition(beanName)) {
  6. this.registry.removeBeanDefinition(beanName);
  7. }
  8. this.importRegistry.removeImportingClass(configClass.getMetadata().getClassName());
  9. return;
  10. }
  11. if (configClass.isImported()) {
  12. registerBeanDefinitionForImportedConfigurationClass(configClass);
  13. }
  14. for (BeanMethod beanMethod : configClass.getBeanMethods()) {
  15. loadBeanDefinitionsForBeanMethod(beanMethod);
  16. }
  17. loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());
  18. loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars());
  19. }

其中,我们可以看到:

  • 1、通过检查是否有·@import·注解,来注册该导入类到容器中


   
  1. if (configClass.isImported()) {
  2. registerBeanDefinitionForImportedConfigurationClass(configClass);
  3. }
  • 2、遍历@Configuration类中的@bean注解,将其类注册到容器中


   
  1. if (configClass.isImported()) {
  2. registerBeanDefinitionForImportedConfigurationClass(configClass);
  3. }

4、refresh

这个方法就是正式进行bean的处理的主要逻辑


   
  1. @Override
  2. public void refresh() throws BeansException, IllegalStateException {
  3. synchronized ( this.startupShutdownMonitor) {
  4. // Prepare this context for refreshing.
  5. prepareRefresh();
  6. // Tell the subclass to refresh the internal bean factory.
  7. ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
  8. // Prepare the bean factory for use in this context.
  9. prepareBeanFactory(beanFactory);
  10. try {
  11. // Allows post-processing of the bean factory in context subclasses.
  12. postProcessBeanFactory(beanFactory);
  13. // Invoke factory processors registered as beans in the context.
  14. invokeBeanFactoryPostProcessors(beanFactory);
  15. // Register bean processors that intercept bean creation.
  16. registerBeanPostProcessors(beanFactory);
  17. // Initialize message source for this context.
  18. initMessageSource();
  19. // Initialize event multicaster for this context.
  20. initApplicationEventMulticaster();
  21. // Initialize other special beans in specific context subclasses.
  22. onRefresh();
  23. // Check for listener beans and register them.
  24. registerListeners();
  25. // Instantiate all remaining (non-lazy-init) singletons.
  26. finishBeanFactoryInitialization(beanFactory);
  27. // Last step: publish corresponding event.
  28. finishRefresh();
  29. }
  30. catch (BeansException ex) {
  31. if (logger.isWarnEnabled()) {
  32. logger.warn( "Exception encountered during context initialization - " +
  33. "cancelling refresh attempt: " + ex);
  34. }
  35. // Destroy already created singletons to avoid dangling resources.
  36. destroyBeans();
  37. // Reset 'active' flag.
  38. cancelRefresh(ex);
  39. // Propagate exception to caller.
  40. throw ex;
  41. }
  42. finally {
  43. // Reset common introspection caches in Spring's core, since we
  44. // might not ever need metadata for singleton beans anymore...
  45. resetCommonCaches();
  46. }
  47. }
  48. }

前面说的一些扩展点类都是在这里才处理的,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;示例配置如下:


   
  1. <!-- servlet定义:前端处理器,接受的HTTP请求和转发请求的类 -->
  2. <servlet>
  3. <servlet-name>court </servlet-name>
  4. <servlet-class>org.springframework.web.servlet.DispatcherServlet </servlet-class>
  5. <init-param>
  6. <!-- court-servlet.xml:定义WebAppliactionContext上下文中的bean -->
  7. <param-name>contextConfigLocation </param-name>
  8. <param-value>classpath*:court-servlet.xml </param-value>
  9. </init-param>
  10. <load-on-startup>0 </load-on-startup>
  11. </servlet>
  12. <servlet-mapping>
  13. <servlet-name>court </servlet-name>
  14. <url-pattern>/ </url-pattern>
  15. </servlet-mapping>
  16. <!-- 配置contextConfigLocation初始化参数:指定Spring IoC容器需要读取的定义了非web层的Bean(DAO/Service)的XML文件路径 -->
  17. <context-param>
  18. <param-name>contextConfigLocation </param-name>
  19. <param-value>/WEB-INF/court-service.xml </param-value>
  20. </context-param>
  21. <!-- 配置ContextLoaderListerner:Spring MVC在Web容器中的启动类,负责Spring IoC容器在Web上下文中的初始化 -->
  22. <listener>
  23. <listener-class>org.springframework.web.context.ContextLoaderListener </listener-class>
  24. </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的初始化,最终会调用下面的代码:


   
  1. public void contextInitialized(ServletContextEvent event) {
  2. this.initWebApplicationContext(event.getServletContext());
  3. }
  4. public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
  5. //PS : ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE=WebApplicationContext.class.getName() + ".ROOT" 根上下文的名称
  6. //PS : 默认情况下,配置文件的位置和名称是:DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml"
  7. //在整个web应用中,只能有一个根上下文
  8. if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
  9. 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!");
  10. }
  11. Log logger = LogFactory.getLog(ContextLoader. class);
  12. servletContext.log( "Initializing Spring root WebApplicationContext");
  13. if (logger.isInfoEnabled()) {
  14. logger.info( "Root WebApplicationContext: initialization started");
  15. }
  16. long startTime = System.currentTimeMillis();
  17. try {
  18. // Store context in local instance variable, to guarantee that
  19. // it is available on ServletContext shutdown.
  20. if ( this.context == null) {
  21. // 在这里执行了创建WebApplicationContext的操作
  22. this.context = createWebApplicationContext(servletContext);
  23. }
  24. if ( this.context instanceof ConfigurableWebApplicationContext) {
  25. ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
  26. if (!cwac.isActive()) {
  27. // The context has not yet been refreshed -> provide services such as
  28. // setting the parent context, setting the application context id, etc
  29. if (cwac.getParent() == null) {
  30. // The context instance was injected without an explicit parent ->
  31. // determine parent for root web application context, if any.
  32. ApplicationContext parent = loadParentContext(servletContext);
  33. cwac.setParent(parent);
  34. }
  35. configureAndRefreshWebApplicationContext(cwac, servletContext);
  36. }
  37. }
  38. // PS: 将根上下文放置在servletContext中
  39. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
  40. ClassLoader ccl = Thread.currentThread().getContextClassLoader();
  41. if (ccl == ContextLoader. class.getClassLoader()) {
  42. currentContext = this.context;
  43. } else if (ccl != null) {
  44. currentContextPerThread.put(ccl, this.context);
  45. }
  46. if (logger.isDebugEnabled()) {
  47. logger.debug( "Published root WebApplicationContext as ServletContext attribute with name [" +
  48. WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
  49. }
  50. if (logger.isInfoEnabled()) {
  51. long elapsedTime = System.currentTimeMillis() - startTime;
  52. logger.info( "Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
  53. }
  54. return this.context;
  55. } catch (RuntimeException ex) {
  56. logger.error( "Context initialization failed", ex);
  57. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
  58. throw ex;
  59. } catch (Error err) {
  60. logger.error( "Context initialization failed", err);
  61. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
  62. throw err;
  63. }
  64. }

我们注意到这样一句configureAndRefreshWebApplicationContext(cwac, servletContext); 这个就是具体创建容器的方法,我们进入去看看


   
  1. protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
  2. if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
  3. // The application context id is still set to its original default value
  4. // -> assign a more useful id based on available information
  5. String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
  6. if (idParam != null) {
  7. wac.setId(idParam);
  8. }
  9. else {
  10. // Generate default id...
  11. wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
  12. ObjectUtils.getDisplayString(sc.getContextPath()));
  13. }
  14. }
  15. wac.setServletContext(sc);
  16. String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
  17. if (configLocationParam != null) {
  18. wac.setConfigLocation(configLocationParam);
  19. }
  20. // The wac environment's #initPropertySources will be called in any case when the context
  21. // is refreshed; do it eagerly here to ensure servlet property sources are in place for
  22. // use in any post-processing or initialization that occurs below prior to #refresh
  23. ConfigurableEnvironment env = wac.getEnvironment();
  24. if (env instanceof ConfigurableWebEnvironment) {
  25. ((ConfigurableWebEnvironment) env).initPropertySources(sc, null);
  26. }
  27. customizeContext(sc, wac);
  28. wac.refresh();
  29. }

我们注意到wac.refresh();看起来是不是有点熟悉了,进入看看:


   
  1. public final void refresh() throws BeansException, IllegalStateException {
  2. try {
  3. super.refresh();
  4. }
  5. catch (RuntimeException ex) {
  6. WebServer webServer = this.webServer;
  7. if (webServer != null) {
  8. webServer.stop();
  9. }
  10. throw ex;
  11. }
  12. }

这里的super根据继承关系,我们知道,最终就是进入到了springframework中的refresh中,这个方法我们在上面已经说过了。

SpringBoot

启动入口方法如下:


   
  1. public static void main(String[] args) {
  2. SpringApplication.run(ConsulApplication.class, args);
  3. }

通过代码的层层调用,最终会走到这样的代码中:


   
  1. public ConfigurableApplicationContext run(String... args) {
  2. StopWatch stopWatch = new StopWatch();
  3. stopWatch.start();
  4. ConfigurableApplicationContext context = null;
  5. Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList();
  6. this.configureHeadlessProperty();
  7. SpringApplicationRunListeners listeners = this.getRunListeners(args);
  8. listeners.starting();
  9. Collection exceptionReporters;
  10. try {
  11. ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
  12. ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments);
  13. this.configureIgnoreBeanInfo(environment);
  14. Banner printedBanner = this.printBanner(environment);
  15. context = this.createApplicationContext();
  16. exceptionReporters = this.getSpringFactoriesInstances(SpringBootExceptionReporter. class, new Class[]{ConfigurableApplicationContext. class}, context);
  17. this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);
  18. this.refreshContext(context);
  19. this.afterRefresh(context, applicationArguments);
  20. stopWatch.stop();
  21. if (this.logStartupInfo) {
  22. (new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);
  23. }
  24. listeners.started(context);
  25. this.callRunners(context, applicationArguments);
  26. } catch (Throwable var10) {
  27. this.handleRunFailure(context, var10, exceptionReporters, listeners);
  28. throw new IllegalStateException(var10);
  29. }
  30. try {
  31. listeners.running(context);
  32. return context;
  33. } catch (Throwable var9) {
  34. this.handleRunFailure(context, var9, exceptionReporters, (SpringApplicationRunListeners) null);
  35. throw new IllegalStateException(var9);
  36. }
  37. }

可以看到,又走到了大家都熟悉的spring启动代码里面去了。

综上:可以看出,不管是哪种系列的spring,最终都会走到spring基本的启动流程中,无非就是根据自己的特性需要加了一些额外的处理罢了。


转载:https://blog.csdn.net/m0_47495420/article/details/114422268
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场