Tomcat如何快速响应静态资源（DefaultServlet+浏览器缓存）

Posted 2021-07-30 徐同学呀

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Tomcat如何快速响应静态资源（DefaultServlet+浏览器缓存）相关的知识，希望对你有一定的参考价值。

文章目录

一、前言

Tomcat根据Servlet规范实现了Servlet容器，同时也具备HTTP服务器的功能。而Servlet在Tomcat中可以分为三种：普通Servlet、JspServlet和DefaultServlet。普通Servlet就是使用者自己根据业务定义的Servlet，后面两个Tomcat已经通过继承HttpServlet实现，JspServlet处理jsp页面，DefaultServlet处理静态资源。

一个请求到达Tomcat后将由URI映射器根据请求URI进行建模，计算出该请求该发往哪个Host容器的哪个Context容器的哪个Wrapper处理，在路由到Wrapper容器时会通过一定的算法选择不同的Servlet进行处理，最后找不到对应的Servlet处理时就会匹配到DefaultServlet。

使用DefaultServlet需要在web.xml里配置：

<servlet>
    <servlet-name>default</servlet-name>
    <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
    <init-param>
        <param-name>debug</param-name>
        <param-value>0</param-value>
    </init-param>
    <init-param>
        <param-name>listings</param-name>
        <param-value>true</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

二、DefaultServlet响应流程

DefaultServlet会先获取对应路径的静态资源映射WebResource，然后判断资源文件是否存在，可读，已修改等，最后读取文件内容响应给浏览器。

如果这个过程完全没有缓存的话，每次都进行io操作，可想这个性能是非常差的。Tomcat利用浏览器缓存，在第一次请求时，进行io操作读取文件内容返回给浏览器；第二次请求，如果文件没有修改过，则返回304状态码告知浏览器文件没有修改，可以直接从浏览器缓存中读取。第三次请求，此时文件修改了，则io读取文件内容返回给浏览器。

1、DefaultServlet如何判断文件是否修改

如下摘取DefaultServlet的一段源码：

org.apache.catalina.servlets.DefaultServlet#serveResource

当判断获取的资源是文件时，会去判断请求的headers（checkIfHeaders()）：

org.apache.catalina.servlets.DefaultServlet#checkIfHeaders

有四种判断headers的方法，因为默认Request Headers中有If-Modified-Since和If-None-Match，所以暂时只看checkIfNoneMatch。

304

首先判断request的headers中是否有If-None-Match，有则判断headerValue和eTag是否相等，相等则说明文件没有修改，返回状态码304。

protected boolean checkIfNoneMatch(HttpServletRequest request,
        HttpServletResponse response, WebResource resource)
        throws IOException {

    String eTag = resource.getETag();
    String headerValue = request.getHeader("If-None-Match");
    if (headerValue != null) {

        boolean conditionSatisfied = false;

        if (!headerValue.equals("*")) {

            StringTokenizer commaTokenizer =
                new StringTokenizer(headerValue, ",");

            // 比较eTag  eTag 是contentLength和lastModified根据一个算法生成的一个字符串
            while (!conditionSatisfied && commaTokenizer.hasMoreTokens()) {
                String currentToken = commaTokenizer.nextToken();
                if (currentToken.trim().equals(eTag))
                    // 二者相等，则没有修改
                    conditionSatisfied = true;
            }

        } else {
            conditionSatisfied = true;
        }

        if (conditionSatisfied) {
            if ( ("GET".equals(request.getMethod()))
                 || ("HEAD".equals(request.getMethod())) ) {
                // 没有修改，设置status=304，设置ETag给response的headers
                response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
                response.setHeader("ETag", eTag);

                return false;
            }
            response.sendError(HttpServletResponse.SC_PRECONDITION_FAILED);
            return false;
        }
    }
    return true;
}

除了checkIfNoneMatch其他三个方法的逻辑也很简单，核心思路就是通过比较文件的lastModified或者contentLength+lastModified是否和上次的一样，一样就是没有修改，不一样就是修改了。

整体思路就是，第一次请求，io读取文件内容，同时将Etag和Last-Modified设置到response里返回给浏览器，下次请求浏览器在请求头里回传If-Modified-Since和If-None-Match（内容上If-Modified-Since对应Last-Modified，If-None-Match对应Etag），DefaultServlet响应时判断这两个参数和资源文件当前的值是否相等。

Tomcat利用浏览器缓存响应静态资源

2、Tomcat对静态资源加缓存

Tomcat对静态资源做了一层封装WebResource（接口），WebResource对文件基础信息的获取进行了包装再调用，同时对io操作进行了封装，方便直接获取文件内容。Tomcat对WebResource做了一层缓存（包括lastModified、contentLength、canRead、isFile等基础信息以及文件内容），默认缓存失效时长为5秒。获取WebResource时先尝试获取CachedResource，CachedResource为空或者已经失效则获取FileResource，FileResource存在则加缓存CachedResource，一个常规的缓存获取和更新操作。（CachedResource和FileResource都实现了接口WebResource）