闲谈 Tomcat 性能优化，通过 ExpiresFilter 设置浏览器缓存

发表于

同 DefaultServlet 一样，ExpiresFilter 也是 Tomcat 里一个非常重要的类。

我们知道 DefaultServlet 可以处理静态资源（HTML，CSS，JS，图片）的请求，并支持缓存。即：能够返回资源的 ETag，并在下次请求时对比资源的 ETag 与请求提交上来的 ETag 值，对比一致则返回 304 状态码，这样避免了资源的重复下载，节省服务器带宽。

但这种机制浏览器还是需要浏览器发起请求，特别是在移动弱网情况下，我们希望充分利用浏览器缓存。

比如：随着前后端分离架构的发展，前端代码可以通过打包工具将打出的文件名带上文件哈希值，例如：http://127.0.0.1:8080/static/js/home.79a114b.js，那么这样的 URL 就能完全确保文件的唯一性，如果 home.js 这个文件被修改过了，它的哈希值会不一样，自然通过打包工具打出的完整文件名也会变更。

所以，我们希望这种资源，服务器能返回 Cache-Control 一个比较长的时间，让浏览器缓存，下次不发送请求。Tomcat 自带的 ExpiresFilter 就能处理这种问题。

配置和使用

ExpiresFilter 配置同一般的 Filter 一样：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<web-app>
    ...
    <filter>
        <filter-name>ExpiresFilter</filter-name>
        <filter-class>org.apache.catalina.filters.ExpiresFilter</filter-class>
        <init-param>
            <param-name>ExpiresByType image</param-name>
            <param-value>access plus 10 minutes</param-value>
        </init-param>
        <init-param>
            <param-name>ExpiresByType text/css</param-name>
            <param-value>access plus 10 minutes</param-value>
        </init-param>
        <init-param>
            <param-name>ExpiresByType application/javascript</param-name>
            <param-value>access plus 10 minutes</param-value>
        </init-param>
    </filter>
    ...
    <filter-mapping>
        <filter-name>ExpiresFilter</filter-name>
        <url-pattern>/*</url-pattern>
        <dispatcher>REQUEST</dispatcher>
    </filter-mapping>
    ...
</web-app>

需要注意这里的 init-param 配置，为的是告诉 ExpiresFilter，哪些类型的资源应该缓存多长时间。如：

1
2
3
4
<init-param>
    <param-name>ExpiresByType application/javascript</param-name>
    <param-value>access plus 10 minutes</param-value>
</init-param>

表示 JS 文件缓存 10 分钟。

具体配置格式为：

1
2
3
4
<init-param>
    <param-name>ExpiresByType type/encoding</param-name>
    <param-value> <base> [plus] (<num> <type>)* </param-value>
</init-param>

base，可设置为：

  • access；访问时间
  • now；当前时间，相当于访问时间
  • modification；文件的最后修改时间

plus，可选的，可以不填，没什么意义。

num，必须是个 int 值。

type，可设置为如下情况，每个值的含义通过单词就能理解了：

  • years
  • months
  • weeks
  • days
  • hours
  • minutes
  • seconds

而且 num type 的组合可以有多项，如：

1
2
3
4
<init-param>
    <param-name>ExpiresByType application/javascript</param-name>
    <param-value>access plus 1 days 10 hours</param-value> // 从上次访问后缓存一天十小时。
</init-param>

其它注意事项

如果代码在处理到 ExpiresFilter 前，Response 中已经设置了 Expires、Cache-Control 等头部的话，ExpiresFilter 是不会根据配置的规则再覆盖的，具体实现见源码的 isEligibleToExpirationHeaderGeneration 方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
protected boolean isEligibleToExpirationHeaderGeneration(HttpServletRequest request, XHttpServletResponse response) {
    boolean expirationHeaderHasBeenSet = response.containsHeader(HEADER_EXPIRES) || contains(response.getCacheControlHeader(), "max-age");
    if (expirationHeaderHasBeenSet) {
        if (log.isDebugEnabled()) {
            log.debug(sm.getString(
                "expiresFilter.expirationHeaderAlreadyDefined",
                request.getRequestURI(),
                Integer.valueOf(response.getStatus()),
                response.getContentType())
            );
        }
        return false;
    }
    
    for (int skippedStatusCode : this.excludedResponseStatusCodes) {
        if (response.getStatus() == skippedStatusCode) {
            if (log.isDebugEnabled()) {
                log.debug(sm.getString("expiresFilter.skippedStatusCode",
                    request.getRequestURI(),
                    Integer.valueOf(response.getStatus()),
                    response.getContentType())
                );
            }
            return false;
        }
    }
    
    return true;
}

参考文章

https://tomcat.apache.org/tomcat-8.0-doc/config/filter.html#Expires_Filter

https://tomcat.apache.org/tomcat-8.0-doc/api/index.html