用 Spring 管理 Controller，你觉得可行吗？

末蓝、 2023-10-13 16:37 2阅读 0赞

聊了 Spring 容器中的父子容器问题，也和小伙伴们梳理了 Spring 容器和 SpringMVC 容器之间的关系，其中，Spring 容器是父容器，SpringMVC 是子容器，子容器可以访问父容器中的 Bean，但是父容器无法访问子容器中的 Bean。

在一个 SSM 项目中，你可以单纯使用 SpringMVC 容器，这个没问题，项目可以正常运行。但是，有的小伙伴可能要问了，如果把所有的 Bean 都扫描到 Spring 容器中行不行？

先来说结论：可以！但是需要额外配置。

阅读本文需要先了解 Spring 容器的父子容器哦，如果还不了解的话建议先阅读[上篇文章][Link 1]。

为什么不能把所有 Bean 都注册到 Spring 容器中呢？按照我们[上篇文章][Link 1]中的分析，所有 Bean 都注册到 Spring 容器之后，Spring 容器作为父容器，SpringMVC 作为子容器，按理说，由于子容器可以访问父容器中的 Bean，所以 SpringMVC 是可以正常访问 Spring 容器中的 Bean 的，所以，似乎把所有的 Bean 都扫描到 Spring 容器应该是没有问题的？

其实不然！

问题就出在 SpringMVC 容器查找 Controller 的方式上，SpringMVC 容器查找 Controller，默认情况下，只在当前容器中查找，并不会去父容器中查找，所以如果把 Controller 都扫描到父容器的话，对于 SpringMVC 来说，相当于系统中就没有 Controller 了，所以你一访问，直接就 404 了。

接下来，我结合源码和小伙伴们分析一下。

首先，小伙伴们知道，在 SpringMVC 中，当请求到达服务端之后，需要由处理器映射器 HandlerMapping 来确定这个请求应该由哪个处理器来处理，所以，按理说，HandlerMapping 中就会记录所有的处理器信息，也就是 Controller 的信息。一般我们在 SpringMVC 中使用的 HandlerMapping 都是 RequestMappingHandlerMapping，所以这里我们就通过 RequestMappingHandlerMapping 的初始化来看一下，SpringMVC 到底是如何查找 Controller 的。

在 RequestMappingHandlerMapping\#afterPropertiesSet 方法中，调用了父类的 afterPropertiesSet 方法，我们来看下：

AbstractHandlerMethodMapping\#afterPropertiesSet：

java

复制代码

`@Override public void afterPropertiesSet() { initHandlerMethods(); } protected void initHandlerMethods() { for (String beanName : getCandidateBeanNames()) { if (!beanName.startsWith(SCOPED_TARGET_NAME_PREFIX)) { processCandidateBean(beanName); } } handlerMethodsInitialized(getHandlerMethods()); }`

initHandlerMethods 方法就是初始化处理器的方法，也就是在这个方法中，去尝试找到所有的 Controller，并且把每一个接口方法都封装成 HandlerMethod 对象。

我们来看下 getCandidateBeanNames 方法，这个方法用来找到所有的候选的 Bean：

java

复制代码

`protected String[] getCandidateBeanNames() { return (this.detectHandlerMethodsInAncestorContexts ? BeanFactoryUtils.beanNamesForTypeIncludingAncestors(obtainApplicationContext(), Object.class) : obtainApplicationContext().getBeanNamesForType(Object.class)); }`

关键点就在这了，这里首先去判断 detectHandlerMethodsInAncestorContexts 变量的值，如果这个变量为 true，则调用 BeanFactoryUtils.beanNamesForTypeIncludingAncestors 方法去查询 Bean，这个方法在[上篇文章][Link 1]中松哥和大家分享过，用来查找 Bean 的名称，包括父容器中的 Bean 都会查找到并返回；如果 detectHandlerMethodsInAncestorContexts 变量为 false，则调用 getBeanNamesForType 方法去查找 Bean，getBeanNamesForType 方法我们[上篇文章][Link 1]也讲过，这个方法只找当前容器的 Bean，不会去父容器中查找。

所以现在问题的关键就在于 detectHandlerMethodsInAncestorContexts 变量了，这个变量默认是 false，**即，默认情况下，只去当前容器（SpringMVC 容器）查找 Bean。**

这里找到的 beanName 是当前容器中所有的 beanName，所以接下来还要去 processCandidateBean 方法走一圈，这个方法会去判断这个 Bean 是否是一个 Controller，如果是就将之收集到一起：

java

复制代码

`protected void processCandidateBean(String beanName) { Class<?> beanType = null; beanType = obtainApplicationContext().getType(beanName); if (beanType != null && isHandler(beanType)) { detectHandlerMethods(beanName); } } @Override protected boolean isHandler(Class<?> beanType) { return AnnotatedElementUtils.hasAnnotation(beanType, Controller.class); }`

可以看到，只有这类上有 `@Controller` 注解，这个类才会被留下来。

好啦，剩下的逻辑我们就不看了。

现在大家已经了解到这样一个情况：

SpringMVC 容器在初始化 HandlerMapping 的时候，会去查找所有的 Controller 并完成初始化，但是在默认情况下，只会去当前容器中查找，并不会去父容器中查找。

所以，如果把 Controller 让 Spring 容器扫描并管理，那么就会导致在默认情况下，SpringMVC 容器找不到 Controller，进而导致所有的请求 404。

在前面的讲解中，松哥都强调了**默认情况**，意思就是说这个事情还有转圜的余地，看了前面源码的小伙伴应该也发现了，只要我们把 detectHandlerMethodsInAncestorContexts 变量改为 true，那么 HandlerMapping 就会去父容器中查找 Bean，这样即使被 Spring 容器扫描并管理的 Bean，也就能够查找到了。

修改方式如下：

spring-servlet.xml：

xml

复制代码

`<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"> <property name="detectHandlerMethodsInAncestorContexts" value="true"/> </bean>`

在 Spring 容器中直接扫描所有 Bean：

xml

复制代码

`<context:component-scan base-package="org.javaboy.web"/>`

web.xml 中加载这两个配置文件：

xml

复制代码

`<context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:applicationContext.xml</param-value> </context-param> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <servlet> <servlet-name>springmvc</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring-servlet.xml</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>springmvc</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping>`

这样配置之后，就可以把所有 Bean 都扫描到 Spring 容器中了。

好啦，今天这篇文章**目的不是为了让小伙伴们去在 Spring 容器中管理 Controller，只是想借这样一个契机，一起来捋一捋 SpringMVC 中 HanderMapping 的原理。**

[Link 1]: https://link.juejin.cn?target=https%3A%2F%2Fmp.weixin.qq.com%2Fs%2F06Mmgnhhu98lQtQ8X13QBA