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風格的支持和靜態資源文件的引用