Spring系列（一）Spring MVC bean 解析、注册、实例化流程源码剖析

Posted 2023-04-17

参考技术A 最近在使用Spring MVC过程中遇到了一些问题，网上搜索不少帖子后虽然找到了答案和解决方法，但这些答案大部分都只是给了结论，并没有说明具体原因，感觉总是有点不太满意。

更重要的是这些所谓的结论大多是抄来抄去，基本源自一家，真实性也有待考证。

那作为程序员怎么能知其所以然呢？

此处请大家内心默读三遍。

用过Spring 的人都知道其核心就是IOC和AOP，因此要想了解Spring机制就得先从这两点入手，本文主要通过对IOC部分的机制进行介绍。

在开始阅读之前，先准备好以下实验材料。

IDEA 是一个优秀的开发工具，如果还在用Eclipse的建议切换到此工具进行。

IDEA有很多的快捷键，在分析过程中建议大家多用Ctrl+Alt+B快捷键，可以快速定位到实现函数。

Spring bean的加载主要分为以下6步：

查看源码第一步是找到程序入口，再以入口为突破口，一步步进行源码跟踪。

Java Web应用中的入口就是web.xml。

在web.xml找到ContextLoaderListener ，此Listener负责初始化Spring IOC。

contextConfigLocation参数设置了bean定义文件地址。

下面是ContextLoaderListener的官方定义：

翻译过来ContextLoaderListener作用就是负责启动和关闭Spring root WebApplicationContext。

具体WebApplicationContext是什么？开始看源码。

从源码看出此Listener主要有两个函数，一个负责初始化WebApplicationContext，一个负责销毁。

继续看initWebApplicationContext函数。

在上面的代码中主要有两个功能：

进入CreateWebAPPlicationContext函数

进入determineContextClass函数。

进入configureAndReFreshWebApplicaitonContext函数。

WebApplication Context有很多实现类。 但从上面determineContextClass得知此处wac实际上是XmlWebApplicationContext类，因此进入XmlWebApplication类查看其继承的refresh()方法。

沿方法调用栈一层层看下去。

获取beanFactory。

beanFactory初始化。

加载bean。

读取XML配置文件。

XmlBeanDefinitionReader读取XML文件中的bean定义。

继续查看loadBeanDefinitons函数调用栈，进入到XmlBeanDefinitioReader类的loadBeanDefinitions方法。

最终将XML文件解析成Document文档对象。

上一步完成了XML文件的解析工作，接下来将XML中定义的bean注册到webApplicationContext，继续跟踪函数。

用BeanDefinitionDocumentReader对象来注册bean。

解析XML文档。

循环解析XML文档中的每个元素。

下面是默认命名空间的解析逻辑。

不明白Spring的命名空间的可以网上查一下，其实类似于package，用来区分变量来源，防止变量重名。

这里我们就不一一跟踪，以解析bean元素为例继续展开。

解析bean元素，最后把每个bean解析为一个包含bean所有信息的BeanDefinitionHolder对象。

接下来将解析到的bean注册到webApplicationContext中。接下继续跟踪registerBeanDefinition函数。

跟踪registerBeanDefinition函数，此函数将bean信息保存到到webApplicationContext的beanDefinitionMap变量中，该变量为map类型，保存Spring 容器中所有的bean定义。

Spring 实例化bean的时机有两个。

一个是容器启动时候，另一个是真正调用的时候。

相信用过Spring的同学们都知道以上概念，但是为什么呢？

继续从源码角度进行分析，回到之前XmlWebApplication的refresh（）方法。

可以看到获得beanFactory后调用了 finishBeanFactoryInitialization()方法，继续跟踪此方法。

预先实例化单例类逻辑。

获取bean。

doGetBean中处理的逻辑很多，为了减少干扰，下面只显示了创建bean的函数调用栈。

创建bean。

判断哪种动态代理方式实例化bean。

不管哪种方式最终都是通过反射的形式完成了bean的实例化。

我们继续回到doGetBean函数，分析获取bean的逻辑。

上面方法中首先调用getSingleton(beanName)方法来获取单例bean，如果获取到则直接返回该bean。方法调用栈如下：

getSingleton方法先从singletonObjects属性中获取bean 对象,如果不为空则返回该对象，否则返回null。

那 singletonObjects保存的是什么？什么时候保存的呢？

回到doGetBean（）函数继续分析。如果singletonObjects没有该bean的对象，进入到创建bean的逻辑。处理逻辑如下：

下面是判断容器中有没有注册bean的逻辑，此处beanDefinitionMap相信大家都不陌生，在注册bean的流程里已经说过所有的bean信息都会保存到该变量中。

如果该容器中已经注册过bean，继续往下走。先获取该bean的依赖bean，如果镩子依赖bean，则先递归获取相应的依赖bean。

依赖bean创建完成后，接下来就是创建自身bean实例了。

获取bean实例的处理逻辑有三种，即Singleton、Prototype、其它(request、session、global session)，下面一一说明。

如果bean是单例模式，执行此逻辑。

获取单例bean，如果已经有该bean的对象直接返回。如果没有则创建单例bean对象，并添加到容器的singletonObjects Map中，以后直接从singletonObjects直接获取bean。

把新生成的单例bean加入到类型为MAP 的singletonObjects属性中，这也就是前面singletonObjects（）方法中获取单例bean时从此Map中获取的原因。

Prototype是每次获取该bean时候都新建一个bean，因此逻辑比较简单，直接创建一个bean后返回。

从相应scope获取对象实例。

判断scope，获取实例函数逻辑。

在相应scope中设置实例函数逻辑。

以上就是Spring bean从无到有的整个逻辑。

从源码角度分析 bean的实例化流程到此基本接近尾声了。

回到开头的问题，ContextLoaderListener中初始化的WebApplicationContext到底是什么呢？

通过源码的分析我们知道WebApplicationContext负责了bean的创建、保存、获取。其实也就是我们平时所说的IOC容器，只不过名字表述不同而已。

本文主要是讲解了XML配置文件中bean的解析、注册、实例化。对于其它命名空间的解析还没有讲到，后续的文章中会一一介绍。

希望通过本文让大家在以后使用Spring的过程中有“一切尽在掌控之中”的感觉，而不仅仅是稀里糊涂的使用。

Spring MVC系列Spring MVC中请求转发中出现异常如何处理

底层配置可以参考上篇Spring MVC系列（一）、Spring MVC概述及ModelAndView(模型视图)

三、Spring MVC中请求转发中出现异常如何处理

在程序运行后报错了，首先我们要知道是何种错误，然后再去针对性的解决，这样才能不至于瞎胡改。

3.1 先在springmvc的核心配置文件中进行异常解析配置

• applicationContext-springmvc.xml

  <!--简单映射异常解析器-->
      <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
          <!-- 给异常命名一个别名 -->
          <property name="exceptionAttribute" value="ex"/>
          <!--异常映射-->
          <property name="exceptionMappings">
              <!--标注是啥异常错误（可以添加多个）-->
              <props>
                  <!--所有异常均可跳转到一个页面中-->
                  <!--异常默认跳转页面-->
                  <prop key="java.lang.RuntimeException">error</prop>
                  <!--数组下标越界异常-->
                  <prop key="java.lang.ArrayIndexOutOfBoundsException">error</prop>
          	</props>
          </property>
      </bean>		
  

  

3.2 在控制器Controller中访问登录界面

• SystemUserContoller类

  /**
       * 跳转登录界面
       * @return
       */
      @RequestMapping(method = RequestMethod.GET,value = {"/toLogin"})
      public String toLogin(HttpServletRequest request){
          System.out.println(1/0);//制造运行时异常
          return "login";
      }
  

  

3.3 error.jsp页面获取异常信息

• error.jp

  <%@ page contentType="text/html;charset=UTF-8" language="java" %>
  <html>
  <head>
      <title>Title</title>
  </head>
  <body>
  <h1>配置文件中检测到的error</h1>
  ${ex}<br/>
  
  </body>
  </html>
  

3.4 在地址栏请求toLogin

3.5 使用注解（@ExceptionHandler）标注在方法上的方式获取异常信息，并跳转至error.jsp页面

• Controller

  @ExceptionHandler(value = RuntimeException.class)
      public String exception(RuntimeException re,HttpServletRequest req){
          req.setAttribute("MSG",re.getMessage());
          return "error";
      }
  

• error.jspyemian

  <%@ page contentType="text/html;charset=UTF-8" language="java" %>
  <html>
  <head>
      <title>Title</title>
  </head>
  <body>
  <h1>配置文件中检测到的error</h1>
  ${requestScope.ex}<br/>
  
  <h1>注解中检测到的error</h1>
  ${requestScope.MSG}<br/>
  
  </body>
  </html>