Spring MVC下，RESTful风格 与 静态资源(static resource)路径映射问题

在使用 Spring 做 REST 接口开发时，大家对配置可能都很熟悉，如下：

<servlet>    <servlet-name>mvc-dispatch</servlet-name>    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>    <load-on-startup>1</load-on-startup></servlet><servlet-mapping>    <servlet-name>mvc-dispatch</servlet-name>    <url-pattern>/*</url-pattern></servlet-mapping>

这样一来，任何一个 REST 接口都会被该 servlet 进行处理，如：

@RestController@RequestMapping(value = "/performances")public class PerformanceController {    @RequestMapping(method = RequestMethod.GET)    public List<PerformanceDto> performances(@RequestParam String areaCode) {        // do sth...    }}

假设应用名为 test。
那么，可以发出下面这个 REST 接口：
http://localhost:8080:test/performances
它将会被上面的 servlet 进行处理。

本来这么做没有什么问题。但是现在需要把web前端与REST接口整合到一起，这就导致了浏览器发出的加载 css 等类型文件的时候，也会被该 servlet 所处理掉，但是我们并没有为 css 等类型文件编写相关的 REST 接口(也不应该编写这种接口)。

那么，问题来了，在同一个工程中，该如何让 REST 接口与 CSS等 静态资源 共享且不互相影响呢？

方法一：在 web.xml 中声明两个 servlet 一个用来处理 REST，一个用来处理 静态资源

<!-- 处理静态资源 --><servlet>    <servlet-name>mvc-dispatcher</servlet-name>    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>    <load-on-startup>1</load-on-startup></servlet><servlet-mapping>    <servlet-name>mvc-dispatcher</servlet-name>    <url-pattern>/route/*</url-pattern></servlet-mapping><!-- 处理 REST --><servlet>    <servlet-name>mvc-dispatcher-rest</servlet-name>    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>    <load-on-startup>1</load-on-startup></servlet><servlet-mapping>    <servlet-name>mvc-dispatcher-rest</servlet-name>    <url-pattern>/rest/*</url-pattern></servlet-mapping>

这样的话，按照 Spring 的约定，就必须存在两份 spring 的配置文件：

• mvc-dispatcher-servlet.xml
• mvc-dispatcher-rest-servlet.xml

其中，在 mvc-dispatcher-servlet.xml 中，我们可以通过如下配置来处理静态资源

<bean id="viewResolver" class="org.springframework.web.servlet.view.mustache.MustacheViewResolver">    <property name="cache" value="false"/>    <property name="prefix" value="/WEB-INF/pages/"/>    <property name="suffix" value=".html"/>    <property name="templateLoader">        <bean class="org.springframework.web.servlet.view.mustache.MustacheTemplateLoader">        </bean>    </property>    <property name="contentType" value="text/html; charset=utf-8" /></bean>

然后，我们可以发出以下请求：
- 静态资源(如，css): http://localhost:8080/test/resources/css/index.css
- REST接口：http://localhost:8080/test/rest/performances

方法二：在 web.xml 中只声明一个 servlet，用来同时处理 REST 和 静态资源

<!-- 就是最开始时的 xml 配置 --><servlet>    <servlet-name>mvc-dispatch</servlet-name>    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>    <load-on-startup>1</load-on-startup></servlet><servlet-mapping>    <servlet-name>mvc-dispatch</servlet-name>    <url-pattern>/*</url-pattern></servlet-mapping>

然后，在 mvc-dispatcher-servlet.xml 中，通过如下配置来处理 静态资源

<mvc:annotation-driven/><mvc:default-servlet-handler/><mvc:resources location="static/resources/" mapping="resources/**"/><bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">    <property name="prefix" value="/static/" />    <property name="suffix" value=".html" /></bean>

工程的文件夹结构如下：

test  |__static      |__resources          |__javascripts          |__stylesheets  |__WEB_INF

这样，我们就可以发出以下的请求了：

• 静态资源(如，css)： http://localhost:8080/test/resources/stylesheets/index.css
• REST 接口：http://localhost:8080/test/performances

参考博客

• SpringMVC REST 风格静态资源访问配置
• SpringMVC使用RESTful风格后对静态资源的处理
• SpringMVC对Rest风格的支持和静态资源文件的引用