为包中所有控制器类的 URL 添加前缀

Question

我正在使用 Spring 3.0 开发一个在 Tomcat Apache 6.0 环境上运行的 RESTful 服务。 Spring DispatcherServlet 配置在“/spring/*”。 Spring servlet 处理多个客户端，并在应用程序中拥有许多控制器。我正在为 REST 服务添加一个新的控制器。我希望所有控制器类都有一个像“ws”（Web 服务）这样的标识前缀，以便资源的完整 URL 如下所示：
http://://spring/ws/service1

我发现 Spring 注释的唯一方法是像这样使用 @RequestMapping

@Controller
@RequestMapping("/ws/service1")
public class Service1 {

@RequestMapping(method=RequestMethod.GET)
@ResponseBody
public String getHtml() { ... }  

....
}

：有几十个类，我不想在每个类中添加“/ws”前缀。这样，如果另一个开发人员添加了新服务，他不必记住添加此前缀，而且如果我们决定将前缀名称从“/ws”更改为其他名称，我也不必更改所有文件。我发现 @RequestMapping 注释仅适用于方法或类，而不适用于包级别。

有什么方法可以配置我的所有 REST 控制器都使用前缀访问吗？

请注意，我无法更改 Spring servlet 的 web.xml URL 映射，因为还有其他控制器正在使用该 URL 运行。

Answer 1

您可能想查看约定优于配置< /a> 支持 Spring 3，特别是 ControllerClassNameHandlerMapping。实际上，您不会在 @RequestMapping 中定义 URL 的位置，而是由处理程序的包位置定义。

如果您想让映射的 URL 反映控制器的包名称，那么您应该设置 ControllerClassNameHandlerMapping 的 basePackage 属性。 文档 说

设置用于生成路径映射的基础包，包括该包下面的所有子包作为路径元素。
默认值为 null，使用生成路径的短类名，控制器的包未在路径中表示。指定一个像“com.mycompany.myapp”这样的基础包，以包含该基础包内的子包作为路径元素，例如为类名“com.mycompany.myapp.mymodule.BuyForm”生成路径“/mymodule/buyform”。子包层次结构表示为单独的路径元素，例如类名“com.mycompany.myapp.mymodule.mysubmodule.BuyForm”的“/mymodule/mysubmodule/buyform”。

因此，bean 定义的示例可能是

<bean class="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping">
    <property name="basePackage" value="com.company.project"/>
</bean>
<context:component-scan base-package="com.company.project.ws"/>

并且您的控制器可能看起来像

package com.company.project.ws;
@Controller
public class Service1 {
    // your controller methods
}

Answer 2

我实现的另一种方法（非常基本且简单）是定义多个 Dispatcher servlet，然后为每个 servlet 映射不同的 URL。 Servlet 共享根 Spring 上下文，除此之外，还有自己的 bean 定义。阅读更多内容 Java 文档。

所以我的 web.xml 看起来像：

<servlet>
    <servlet-name>flex</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>

<!-- Mappings for BlazeDS requests -->
<servlet-mapping>
    <servlet-name>flex</servlet-name>
    <url-pattern>/spring/messagebroker/*</url-pattern>
</servlet-mapping>

<!-- Second dispatcher servlet for Web Services API -->
<servlet>
    <servlet-name>wsapi</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>wsapi</servlet-name>
    <url-pattern>/spring/ws/*</url-pattern>
</servlet-mapping>

基本上，我保留了现有的调度程序 servlet，只为具有不同 URL 映射的 REST 控制器添加了一个新的 servlet。这样我就可以分别控制这些 servlet 的 URL。此后，我不再需要在每个控制器上添加 URL 前缀。