采用原生JSP实现页面静态化技术

0x0 前言

最近学习了页面静态化技术。在MVC框架中，该技术使用freemarker、velocity等模板引擎，通过Model获取相应的对象，进而生成相应的html页面（也就是View），然后，将生成的html页面缓存起来，下次如果客户端访问相同页面，那么可以直接从缓存中获取页面返回，从而避免了查询数据库等操作，提升了访问效率。

话说回来，jsp本身也是一种模板引擎，利用el表达式也可以根据动态内容生成静态html页面返回到前端。于是，我利用jsp和过滤器，采用装饰者模式，也实现了页面静态化。

0x1 原理

过滤器拦截请求，判断缓存中是否存在请求的页面

若存在请求的页面： 从缓存中读取页面html并响应到前端，然后返回（不放行）

若不存在请求的页面：
1. 截取response对象，包装成自定义的CachedResponse对象，该对象重写了getWriter方法，返回自定义的CachedWriter包装对象，这个CachedWriter对象可以将jsp输出流的内容缓存起来；
2. 将包装的CachedResponse对象传给doFilter方法（放行）；
3. 通过CachedResponse的getCache方法获取jsp生成的html字符串；
4. 将html字符串存入缓存（可以使用redis或本地文件）。

0x2 代码

首先是filter的代码：

package com.fly.filter;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;

import com.fly.util.RedisUtils;

@WebFilter("/*")
public class CacheFilter implements Filter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        //获取请求的uri和参数字符串
        String uri = ((HttpServletRequest)request).getRequestURI();
        String params = ((HttpServletRequest)request).getQueryString();
        //将二者拼接作为存在redis中的key
        String key = uri + "?" + params;
        //从缓存中查找对应的html
        String html = RedisUtils.get(key);
        //如果存在，将html输出并返回
        if (html != null) {
            System.out.println("从缓存中读取html页面！");
            response.setContentType("text/html;charset=UTF-8");
            response.getWriter().write(html);
            return;
        }

        //如果不存在缓存页面
        //包装response，将response的getWriter方法返回值修改为自定义的CachedWriter
        CachedResponse cachedResponse = new CachedResponse((HttpServletResponse) response);

        // 将包装后的response传入chain
        chain.doFilter(request, cachedResponse);

        //获取页面html的字符串
        html = cachedResponse.getCache();

        //将html字符串存入缓存
        RedisUtils.set(key, html);
        //控制台打印消息
        System.out.println("不存在缓存页面，生成新的页面：");
        System.out.println(html);

    }

    @Override
    public void destroy() {
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
    }

}

其中，自定义的包装类CachedResponse和CachedWriter如下：

/**
 * response的包装类
 * 重写了父类的getWriter方法
 * 返回自定义的writer
 */
class CachedResponse extends HttpServletResponseWrapper {

    public CachedResponse(HttpServletResponse response) {
        super(response);
    }

    private CachedWriter cachedWriter = null;

    /***********************************
     * 重写父类的getWriter方法
     * 返回writer的包装类CachedWriter对象
    ***********************************/
    @Override
    public PrintWriter getWriter() throws IOException {
        if (cachedWriter == null) {
            cachedWriter = new CachedWriter(super.getWriter());
        }
        return cachedWriter;
    }

    /***********************************
     * 获取writer中缓存的页面html字符串
     ***********************************/
    public String getCache() {
        return cachedWriter.getCache();
    }
}


/**
 * 自定义一个带缓存的PrintWriter
 */
class CachedWriter extends PrintWriter {

    //用于缓存页面html字符串
    private StringBuilder cache = new StringBuilder();

    /***********************************
     * 构造方法，传入被包装的writer
     ***********************************/
    public CachedWriter(Writer out) {
        super(out);
    }

    /***********************************
     * 这个方法是jsp输出时调用的write方法
     * 如果不放心，可以将所有write方法都加上cache
     ***********************************/
    @Override
    public void write(char[] buf, int off, int len) {
        cache.append(buf, off, len);
        super.write(buf, off, len);
    }

    /***********************************
     * 返回缓存的html字符串
     ***********************************/
    public String getCache() {
        return cache.toString();
    }

}

其中RedisUtils是一个访问redis的工具类，如下：

package com.fly.util;

import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;

public class RedisUtils {
     //初始化Jedis池
    private static JedisPoolConfig config;
    private static JedisPool pool;
    static {
        config = new JedisPoolConfig();
        config.setMaxTotal(30);
        config.setMaxIdle(10);
        //填入你的redis服务器地址，我的redis在虚拟机上
        pool = new JedisPool(config, "192.168.233.200", 6379);
    }

    public static Jedis getJedis() {
        // 通过连接池对象获得Jedis对象
        Jedis jedis = pool.getResource();
        return jedis;
    }

    public static void set(String key, String value) {
        getJedis().set(key, value);
    }

    public static String get(String key) {
        return getJedis().get(key);
    }

}

0x3 测试效果

以上基本就完成了，测试一下效果：
先看下redist缓存：empty

随便定义了一个页面，页面有一个name的参数，访问该页面，并设置name=aaa：

看看控制台：

不存在缓存页面，生成新的页面：

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
    <h1>Hello:aaa</h1>
    <div>
        你好，这是你的页面： aaa!
    </div>
</body>
</html>

看看redis缓存：

看起来已经缓存了该页面，那么我们再次访问该页面：
控制台输出如下：

从缓存中读取html页面！

完事了！