nginx反向代理缓存

背景

nginx 一般用来做反向代理和负载均衡，将客户端请求发送到后端的 jetty，并将 jetty 的响应发送给客户端。后端的 jetty 通常不止一个，nginx 根据配置来选择其中一个 jetty，比较常见的选择策略是轮询。示意图如下

启动缓存支持以后，nginx 在将请求转发到 jetty 之前会在缓存里查找结果，如果缓存里存在匹配客户端请求的结果，则直接返回给客户端，不会将请求发送给 jetty；如果缓存没有命中，才会将请求发送给 jetty，接收到 jetty 返回的结果后，会将结果进行缓存以备客户端下次的请求。示意图如下：

缓存命中

缓存未命中

最简单的缓存设置

web 程序

首先我们有个简单的 web 程序，返回当前时间，如下

@Controller
public class TestController {

    @ResponseBody
    @RequestMapping("time.do")
    public Map<String, Long> time() {
        Map<String, Long> map = new HashMap<String, Long>();
        map.put("time", System.currentTimeMillis());
        return map;
    }
}

这个接口会返回当前时间，精确到毫秒，正常情况下每次刷新返回的值都应该是不一样的

nginx 配置

现在配置 nginx 的缓存，首先在 http 小节添加如下配置

http {
    ...

    # 设置缓存的路径和其他参数
    # proxy_cache_path path [levels=levels] keys_zone=name:size [inactive=time] [max_size=size] [loader_files=number] [loader_sleep=time] [loader_threshold=time];
    # 缓存路径 /data/nginx/cache 缓存结构为 2 层，即该路径下会有 2 层子目录，缓存文件会保存在最下层子目录
    # 缓存的 key 会保存在名为 web_cache 的内存区域，该内存区域大小为 50 m
    # 10 分钟内缓存没有被访问就会过期
    # 缓存文件最多占用 1g 空间
    proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=web_cache:50m inactive=10m max_size=1g;

    # proxy_cache_path 指令必须在 include 指令之前
    include vhosts/*.conf;

    ...
}

接下来在 server 小节 的 location / 小节添加如下配置

location / {
    proxy_store off;
    proxy_redirect off;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Host $http_host;
    proxy_pass http://my-server/;

    # 缓存使用前面定义的内存区域
    proxy_cache web_cache;
    # 这个貌似没啥用
    proxy_ignore_headers   Expires Set-Cookie;
    # 对于 200 和 304 的响应码进行缓存，过期时间为 2 分钟，这会覆盖前面定义的 10 分钟过期时间
    proxy_cache_valid 200 304 2m;
    # 设置缓存的 key，这里用到了 nginx 的内嵌变量，表示用整个 url 作 key
    proxy_cache_key  $scheme$proxy_host$request_uri;
    # 在返回的响应里添加响应头 X-Proxy-Cache，其值表示是否命中了缓存，貌似没啥用
    add_header X-Proxy-Cache $upstream_cache_status;
    # 返回的响应头里，设置过期时间为 10 分，貌似没啥用
    expires 10m;
    # 貌似没啥用
    add_header Access-Control-Allow-Origin "http://myserver.net";
    # 貌似没啥用
    add_header Access-Control-Allow-Credentials true;

}

缓存特定的参数

有的参数每个客户端都不一样，而且该参数的值并不影响返回的结果，如果我们用整个 url 作为缓存的 key，那么 key 的数量就太多了，导致缓存的命中率非常低。
例如，用户手机的 imei 是唯一的，如果 key 包括了 imei，那就会导致每个用户都有一个缓存，这显然不是我们需要的
那么，能不能把某些参数排除在 key 之外呢？答案是肯定滴，看看下面这个 web 程序

@ResponseBody
@RequestMapping("/test/user.do")
public Map<String, String> user(String imei, String sn, String phone, String name) {
    Map<String, String> map = new HashMap<String, String>();
    map.put("imei", imei);
    map.put("sn", sn);
    map.put("phone", phone);
    map.put("name", name);
    return map;
}

只用 phone 和 name 参数来构造缓存的 key，可以如下配置

location / {
    proxy_store off;
    proxy_redirect off;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Host $http_host;
    proxy_pass http://my-server/;

    # 缓存使用前面定义的内存区域
    proxy_cache web_cache;
    # 对于 200 和 304 的响应码进行缓存，过期时间为 2 分钟，这会覆盖前面定义的 10 分钟过期时间
    proxy_cache_valid 200 304 2m;
    # 设置缓存的 key，只用 phone 和 name 构造 key
    proxy_cache_key  $host$uri$is_args$arg_phone&$arg_name;

}

这次把貌似没用的配置都移除了，要指定某些参数来构造缓存的 key，关键是以下的内嵌变量

• $is_args
• $arg_{name}

缓存特定的接口

有时候不是所有接口都需要被 nginx 缓存，或者缓存的 key 采用不同的规则，可以通过不同的 location 来配置
例如，下面的配置就只对以 /test/ 开头的接口做缓存

location / {
    proxy_store off;
    proxy_redirect off;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Host $http_host;
    proxy_pass http://my-server/;

    # 不缓存 proxy_cache 默认值就是 off，所以也可以省略这一行
    proxy_cache off
}
location /test/ {
    proxy_store off;
    proxy_redirect off;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Host $http_host;
    proxy_pass http://my-server/test/;

    # 缓存使用前面定义的内存区域
    proxy_cache web_cache;
    # 对于 200 和 304 的响应码进行缓存，过期时间为 2 分钟，这会覆盖前面定义的 10 分钟过期时间
    proxy_cache_valid 200 304 2m;
    # 设置缓存的 key，只用 phone 和 name 构造 key
    proxy_cache_key  $host$uri$is_args$arg_phone&$arg_name;

}