applicationContext 找不到 Servlet 上下文的控制器

Posted 2023-02-27

【中文标题】applicationContext 找不到 Servlet 上下文的控制器

【英文标题】：applicationContext not finding Controllers for Servlet context

【发布时间】：2012-07-12 07:16:51

【问题描述】：

我有一个带有 applicationContext.xml 和 dispatcher-servlet.xml 配置的 Spring Web 应用程序。我在 applicationContext.xml 中定义了 <context:component-scan />，但是当我运行我的应用程序时，除非我还将 <context:component-scan /> 添加到 dispatcher-servlet.xml 中，否则找不到控制器。我在两者中都使用相同的基本包，所以这不是问题。

我很困惑，因为我认为 applicationContext.xml 是dispatcher-servlet.xml 的父级。将<context:component-scan /> 放入applicationContext.xml 不够吗？

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">


<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>dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

</web-app>

编辑：我还在 dispatcher-servlet.xml 中使用 mvc:annotation-driven，它应该用来获取控制器（我想？）。

编辑 2：这是配置文件。我从 applicationContext.xml 中删除了一堆 Spring Security 和 OAuth 设置（出于安全原因，它们可能无论如何都不相关）。

applicationContext.xml

<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:sec="http://www.springframework.org/schema/security" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p" xmlns:c="http://www.springframework.org/schema/c"
xmlns:context="http://www.springframework.org/schema/context" xmlns:oauth="http://www.springframework.org/schema/security/oauth2"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
      http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security-3.1.xsd
      http://www.springframework.org/schema/security/oauth2 http://www.springframework.org/schema/security/spring-security-oauth2.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd">

<context:component-scan base-package="bar.foo"/>
<context:property-placeholder location="classpath:my.properties" />
<bean class="bar.foo.ServicesConfig" />

</beans>

调度程序-servlet.xml

<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p" xmlns:c="http://www.springframework.org/schema/c"
xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
      http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd">

<context:component-scan base-package="bar.foo.controller" />
<mvc:annotation-driven/>
<mvc:default-servlet-handler />

<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/jsp/" />
    <property name="suffix" value=".jsp" />
    <property name="order" value="2" />
</bean>

<bean id="contentViewResolver" class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
    <property name="mediaTypes">
        <map>
            <entry key="json" value="application/json" />
        </map>
    </property>
    <property name="defaultViews">
        <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
    </property>
    <property name="order" value="1" />
</bean>

</beans>

编辑 3：好的，这很有趣。我的服务和 dao 类位于我从 Web 项目中引用的不同项目 (JAR) 中。我正在使用基于 java 的配置并从 applicationContext.xml 引用它：

<bean class="bar.foo.config.ServicesConfig" />

所以，这意味着我的 Web 项目（applicationContext.xml 所在的位置）中只有 Controller 注释。回想起来，从我的 applicationContext.xml 中删除 context:component-scan 应该不会有任何影响，因为除了 @Controller 之外没有任何注释（修复到编辑：有一些 @Autowired 注释）。但是，当我从 applicationContext.xml 中删除 context:component-scan 时，它说控制器（从调度程序 servlet 扫描中找到）找不到我的服务类。对 ServicesConfig 的引用还不够吗？这是用于引用的 ServicesConfig 类 - 它有自己的服务组件扫描，这些组件与 applicationContext.xml 扫描的包不同。

@Configuration
@ComponentScan( "some.other.package", "another.package" )
@ImportResource( "classpath:commonBeans.xml" )
@PropertySource( "classpath:services.properties",
"classpath:misc.properties" )
public class ServicesConfig 
  // Bean definitions //

解决方案：

当我从根上下文中删除 context:component-scan 时，控制器没有拾取自动装配的服务 bean。这是因为根上下文引用了我的服务基于 java 的配置 Bean，但我没有设置根上下文来扫描组件。因此，当我将组件扫描添加到根上下文 (applicationContext.xml) 时，一切正常。这是我现在拥有的：

applicationContext.xml：

<bean class="bar.foo.config.ServicesConfig" />
<context:component-scan base-package="bar.foo.config" />

调度程序-servlet.xml：

<context:component-scan base-package="bar.foo.controller" />

我有网络上下文设置来获取控制器包中的控制器、自动装配和任何其他注释 - 我不确定这是否是最佳实践。

【问题讨论】：

也许你应该将你的spring配置xmls添加到问题中，这很可能是一个配置问题。

你不需要在applicationContext.xml中写

显然在我的设置中是必要的，因为如果不包含 Bean（不包括控制器），则找不到它。

【参考方案1】：

你是对的 - 有两个不同的应用程序上下文，由 ContextLoaderListener 加载的根应用程序上下文（此时 ServletContext 被初始化）和 Web 上下文（由 DispatcherServlet 加载），根应用程序上下文是父应用程序上下文Web 上下文。

现在，由于这是两个不同的应用程序上下文，它们的作用不同 - 如果您在应用程序上下文中为您的服务定义 component-scan，那么服务的所有 bean 都会在此处创建。

当您的 Dispatcher servlet 加载时，它将开始创建 Web 上下文，在某个时候（由 <mvc:annotation-driven/> 驱动，它将为您的 uri 到处理程序方法创建一个映射，它将获取应用程序上下文中的 bean 列表（这将是 Web 应用程序上下文，而不是根应用程序上下文）并且由于您没有在此处定义 component-scan，因此将找不到与控制器相关的 bean 并且不会创建映射，这就是您必须定义的原因调度程序 servlets 上下文中的组件扫描。

一个好的做法是在根应用程序上下文中排除与控制器相关的 bean：

<context:component-scan base-package="package">
    <context:exclude-filter expression="org.springframework.stereotype.Controller" type="annotation"/>
</context:component-scan>

并且只有在 Web 应用程序上下文中与控制器相关的控制器：

<context:component-scan base-package="package" use-default-filters="false">
    <context:include-filter expression="org.springframework.stereotype.Controller" type="annotation" />
</context:component-scan>

【讨论】：

“使用默认过滤器”的目的是什么？

在 Web 上下文或根上下文中拥有控制器是最佳实践吗？有关系吗？

是的，这很重要，它应该在 Web 上下文中，否则在创建处理程序映射时将不会检测到它们。我已在 Web 上下文中将 use-default-filters 设置为关闭，以便仅在 Web 上下文中加载与控制器相关的 bean 定义（通过包含过滤器），服务等应来自根上下文

如果我的控制器中有 Autowired 服务，我应该让 Web 上下文扫描这些服务还是根上下文？对此有最佳实践吗？我的部分困惑源于控制器中有 Autowired bean。

这帮助我更好地了解不同的上下文如何协同工作，并最好地帮助解决问题。谢谢。

【参考方案2】：

在我们的应用程序中，我们在 dispatcher-servlet.xml 中定义

我相信这是它应该在的地方，而不是在 applicationContext.xml 中

Spring 文档的这一部分应该提供更多信息：

http://static.springsource.org/spring/docs/current/spring-framework-reference/html/mvc.html

从 16.2 节中的一张图可以看出，dispatcher-servlet 位于上下文层次结构中的 applicationContext 之上。

【讨论】：

如果我从 applicationContext.xml 中删除 context:component-scan （并在 dispatcher-servlet.xml 中将基本包设置为更高级别的包），那么我在启动 Tomcat 时会收到 NoSuchBeanDefinitionExceptions。

【参考方案3】：

我遇到了同样的问题，在将我的 web.xml 代码与 this tutorial 进行比较后，我对其进行了更改，并且成功了。这是我的web.xml 文件：

<web-app xmlns="http://java.sun.com/xml/ns/javaee"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:mvc="http://www.springframework.org/schema/mvc"
     xsi:schemaLocation="
    http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
     version="3.0">
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:spring/business-config.xml</param-value>
</context-param>

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<servlet>
    <servlet-name>mvc-dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>

<servlet-mapping>
    <servlet-name>mvc-dispatcher</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

context-param 和 listener 是我错过的。

希望对你有帮助。