spring mvc处理静态资源

时间 2019-12-01

标签 spring mvc 处理静态资源栏目 Spring 繁體版

原文原文链接

servlet的url映射定义为'/'表示映射所有路径css

struts的过滤器是*.action,在spring mvc中设置成*.action或者*.do......也是能够的,可是spring mvc就是霸气,它就是要处理一切路径.前端

对于静态资源,在tomcat服务器上,必须经过servlet才能访问,除此以外别无他法.java

即使是你本身不写servlet来访问静态资源,tomcat不管如何也要找到一个servlet来处理静态资源,因此别以为用servlet处理会慢,不管如何都要用servlet来处理.jquery

一言以蔽之,在tomcat容器中,处理资源的基本单位是servlet,进行数据操做计算的基本单位也是servlet.nginx

前人之述备矣,天下文章一大抄.web

Spring MVC 中的核心 servlet - DispatcherServlet，咱们在 web.xml 文件中一般这样定义：spring

<servlet>  
  <servlet-name>mvc</servlet-name>  
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
  <init-param>  
    <param-name>contextConfigLocation</param-name>  
    <param-value>/WEB-INF/classes/conf/spring/mvc-*.xml</param-value>  
  </init-param>  
  <load-on-startup>1</load-on-startup>  
</servlet>  
  
<servlet-mapping>  
  <servlet-name>mvc</servlet-name>  
  <url-pattern>/</url-pattern>  
</servlet-mapping>

        很明显，该 servlet 对应的 url-pattern 定义成 /，所以该 servlet 会匹配上诸如 /images/a.jpg, /css/hello.css 等这些静态资源，甚至包括 /jsp/stock/index.jsp 这些 jsp 也会匹配。可是并无定义相应的 Controller 来处理这些资源，所以这些请求一般是没法完成的。
        很麻烦？没有 Struts 方便？此言差矣，所以你在 Struts 定义其核心 filter 的 url-pattern 是 *.action，固然不会对处理 jsp 和静态资源操做影响了。Spring MVC 若也定义相似的 url-pattern，一样不存在问题。
        说到这里，咱们应该想一个问题。Tomcat 中，只有 servlet 可以处理请求，即便是 jsp，也会被编译成 servlet。咱们即使使用 Struts，定义 *.action 的url-pattern，那 .css, *.gfi 等这些静态资源究竟是谁来处理了？？？你可不要想固然的认为我不是输入了图片的路径了吗？如，/images/a/b/c.gif。请注意，servlet 容器中，只有 servlet 采用处理资源！
        由 servlet 处理这些资源那是必定了。不过，不一样的 servlet 容器/应用服务器，处理这些静态资源的 servlet 的名字不大同样： apache

Tomcat, Jetty, JBoss, and GlassFish：默认 Servlet 名字为 "default"
Google App Engine：默认 Servlet 名字为 "_ah_default"
Resin：默认 Servlet 名字为 "resin-file"
WebLogic：默认 Servlet 名字为 "FileServlet"
WebSphere：默认 Servlet 名字为 "SimpleFileServlet"

◇ 方案一：激活 Tomcat 的 defaultServlet 来处理静态资源缓存

<servlet-mapping>  
  <servlet-name>default</servlet-name>  
  <url-pattern>*.jpg</url-pattern>  
</servlet-mapping>  
<servlet-mapping>  
  <servlet-name>default</servlet-name>  
  <url-pattern>*.js</url-pattern>  
</servlet-mapping>  
<servlet-mapping>  
  <servlet-name>default</servlet-name>  
  <url-pattern>*.css</url-pattern>  
</servlet-mapping>

每种类型的静态资源须要分别配置一个 servlet-mapping，同时，要写在 DispatcherServlet 的前面，让 defaultServlet 先拦截。
◇ 方案二：Spring 3.0.4 之后版本提供了 <mvc:resources />tomcat

<mvc:resources location="/resources/" mapping="/resources/**"/>

        /resources/** 映射到 ResourceHttpRequestHandler 进行处理，location 指定静态资源的位置，能够是 web application 根目录下、jar 包里面，这样能够把静态资源压缩到 jar 包中。cache-period 可使得静态资源进行 web cache。
        使用 <mvc:resources /> 元素，会把 mapping 的 URI 注册到 SimpleUrlHandlerMapping 的 urlMap 中，key 为 mapping 的 URI pattern 值，而 value 为 ResourceHttpRequestHandler，这样就巧妙的把对静态资源的访问由 HandlerMapping 转到 ResourceHttpRequestHandler 处理并返回，因此就支持 classpath 目录, jar 包内静态资源的访问。
    ◇ 方案三：使用 <mvc:default-servlet-handler />
        <mvc:default-servlet-handler /> 会把 "/**" url 注册到 SimpleUrlHandlerMapping 的 urlMap 中，把对静态资源的访问由 HandlerMapping 转到 org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler 处理并返回。DefaultServletHttpRequestHandler 使用就是各个 Servlet 容器本身的默认 Servlet。
        补充说明下以上提到的 HandlerMapping 的 order 的默认值：

DefaultAnnotationHandlerMapping：0
<mvc:resources /> 自动注册的 SimpleUrlHandlerMapping：2147483646
<mvc:default-servlet-handler/> 自动注册的 SimpleUrlHandlerMapping：2147483647

Spring 会先执行 order 值比较小的。当访问一个 a.jpg 图片文件时，先经过 DefaultAnnotationHandlerMapping 来找处理器，必定是找不到的，咱们没有叫 a.jpg 的 Controller。再按 order 值升序找，因为最后一个 SimpleUrlHandlerMapping 是匹配 "/**" 的，因此必定会匹配上，再响应图片。

Spring MVC 中，访问一个图片，还要走层层匹配。性能确定好不到哪里去。不只仅是 Spring MVC，即使 Struts，它们毕竟存活于 servlet 容器，只要由 servlet 容器处理这些静态资源，必然要将这些资源读入 JVM 的内存区中。因此，处理静态资源，咱们一般会在前端加 apache 或 nginx。

其中处理静态资源的类是org.springframework.web.servlet.resource.ResourceHttpRequestHandler，并且在location的描述中说明Each location must point to a valid directory. 即每一个location都必须指向一个有效的目录。

下面看一下org.springframework.web.servlet.resource.ResourceHttpRequestHandler中是如何处理静态资源请求的：

首先它实现了org.springframework.web.HttpRequestHandler这个接口的handleRequest方法：

public void handleRequest(HttpServletRequest request, HttpServletResponse response)  
        throws ServletException, IOException {  
    // 这里根据配置来设置缓存的header  
    checkAndPrepare(request, response, true);  
  
    // 获取要获取的资源，若是不存在，直接返回404错误  
    Resource resource = getResource(request);  
    if (resource == null) {  
        logger.debug("No matching resource found - returning 404");  
        response.sendError(HttpServletResponse.SC_NOT_FOUND);  
        return;  
    }  
  
    // 省略部分代码……  
    // 返回相应的资源，即把资源文件写到响应中  
    writeContent(response, resource);  
}

而getResource方法实现以下：

protected Resource getResource(HttpServletRequest request) {  
    String path = (String) request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);  
    // 省略部分处理和检验路径的代码……  
  
    // 这里循环从配置的location下查找请求的静态资源  
    for (Resource location : this.locations) {  
        try {  
            if (logger.isDebugEnabled()) {  
                logger.debug("Trying relative path [" + path + "] against base location: " + location);  
            }  
            Resource resource = location.createRelative(path);  
            // 判断资源存在并且可以读取  
            if (resource.exists() && resource.isReadable()) {  
                // 这里就是3.2.12及之后处理上的差异，在3.2.12前，不会判断该资源是否在指定的路径下，直接就返回了resource，而3.2.12及之后作了以下判断  
                if (isResourceUnderLocation(resource, location)) {  
                    if (logger.isDebugEnabled()) {  
                        logger.debug("Found matching resource: " + resource);  
                    }  
                    return resource;  
                }  
                else {  
                    if (logger.isTraceEnabled()) {  
                        logger.trace("resource=\"" + resource + "\" was successfully resolved " +  
                                "but is not under the location=\"" + location);  
                    }  
                    return null;  
                }  
            }  
            else if (logger.isTraceEnabled()) {  
                logger.trace("Relative resource doesn't exist or isn't readable: " + resource);  
            }  
        }  
        catch (IOException ex) {  
            logger.debug("Failed to create relative resource - trying next resource location", ex);  
        }  
    }  
    return null;  
}

下面看看isResourceUnderLocation的实现：

private boolean isResourceUnderLocation(Resource resource, Resource location) throws IOException {  
    if (!resource.getClass().equals(location.getClass())) {  
        return false;  
    }  
    String resourcePath;  
    String locationPath;  
    if (resource instanceof UrlResource) {  
        resourcePath = resource.getURL().toExternalForm();  
        locationPath = location.getURL().toExternalForm();  
    }  
    else if (resource instanceof ClassPathResource) {  
        resourcePath = ((ClassPathResource) resource).getPath();  
        locationPath = ((ClassPathResource) location).getPath();  
    }  
    else if (resource instanceof ServletContextResource) {  
        resourcePath = ((ServletContextResource) resource).getPath();  
        locationPath = ((ServletContextResource) location).getPath();  
    }  
    else {  
        resourcePath = resource.getURL().getPath();  
        locationPath = location.getURL().getPath();  
    }  
    // 这里是对路径的处理，若是咱们配置的是/res/**，那么直接拼接成了/res/**/，若是请求资源为/res/jquery.js，
   //那么会判断res/jquery.js是否以/res/**/开头，若是不是，则返回该location下没有该资源，致使不能404错误  
    locationPath = (locationPath.endsWith("/") ||  
            !StringUtils.hasLength(locationPath) ? locationPath : locationPath + "/");  
    if (!resourcePath.startsWith(locationPath)) {  
        return false;  
    }  
    if (resourcePath.contains("%")) {  
        // Use URLDecoder (vs UriUtils) to preserve potentially decoded UTF-8 chars...  
        if (URLDecoder.decode(resourcePath, "UTF-8").contains("../")) {  
            if (logger.isTraceEnabled()) {  
                logger.trace("Resolved resource path contains \"../\" after decoding: " + resourcePath);  
            }  
            return false;  
        }  
    }  
    return true;  
}

'/'表示根目录,以'/'结尾的路径表示文件夹,location为'/'表示该路径下的所有文件至关于'/**','/*'表示单级目录,因此'/'=='/**'>'/*'

mvc:resource能够设置多个属性

在@RequestMapping注解中,若是没有参数,则表示这个servlet是默认的servlet,会处理一切资源.

   <!-- 对静态资源文件的访问  方案一  -->  
    <mvc:default-servlet-handler/>  
      
    <!-- 对静态资源文件的访问  方案二 -->  
<mvc:resources mapping="/images/**" location="/images/" cache-period="31556926"/>  
<mvc:resources mapping="/js/**" location="/js/" cache-period="31556926"/>  
<mvc:resources mapping="/css/**" location="/css/" cache-period="31556926"/>

<!-- 对静态资源文件的访问  方案二的简便写法-->

 <mvc:resources location="/" mapping="/" />