记一次nginxproxy_cache配置

不念不忘少年蓝@ 2022-09-01 14:55 374阅读 0赞

在浏览器和应用服务器之间，存在多种“潜在”缓存，如：

客户端浏览器缓存  
中间缓存  
内容分发网络（CDN）  
服务器上的负载均衡和反向代理

缓存，仅在反向代理和负载均衡的层面，就对性能提高有很大的帮助。  
为什么要用缓存？  
网站的访问速度更快  
减轻源服务器的负担  
提高负载平衡器、反向代理和应用服务器前端web服务的性能  
nginx代理模块缓存指令  
指令 说明  
proxy\_cache 定义缓存的共享内存区域  
proxy\_cache\_bypass 一个或者多个字符串变量，变量的值为非空或者非零将会导致响应从上游服务器获取而不是缓存  
proxy\_cache\_key 用来区分缓存文件的key，作为缓存key的一个字符串，用于存储或者获取缓存值。默认值为 s c h e m e scheme schemeproxy\_host u r i uri uriis\_args$args  
proxy\_cache\_lock 启用这个指令，当多个客户端请求一个缓存中不存在的文件（或称之为一个MISS），只有这些请求中的第一个被允许发送至服务器。其他请求在第一个请求得到满意结果之后在缓存中得到文件。  
proxy\_cache\_lock\_timeout 等待一个请求将出现在缓存或者proxy\_cache\_lock锁释放的时间长度  
proxy\_cache\_min\_uses 在一个响应被缓存为一个key之前需要请求的最小次数  
proxy\_cache\_path 一个放置缓存响应和共享zone（keys\_zone=name:size）的目录，用于存放key和响应的元数据。  
proxy\_cache\_path:keys\_zone 设置一个共享内存区，用于存储缓存键和元数据，有些类似计时器的用途。  
proxy\_cache\_path:levels 冒号用于分隔在每个级别（1或2）的子目录名长度，最多三级深；  
proxy\_cache\_path:inactive 在一个不活动的响应被驱除出缓存之前待在缓存中的最大时间长度；例如设置如60m，则文件如果在60分钟之内没有被请求，则缓存管理会自动将其在内存中删除，不管文件是否过期。  
proxy\_cache\_path:max\_size 缓存的最大值，当大小超过这个值，缓存管理器溢出最近最少使用的缓存条目；  
proxy\_cache\_path:loader\_files 缓存文件的最大数量，它们的元数据被每个缓存载入进程迭代载入；  
proxy\_cache\_path:loader\_sleep 在每个迭代缓存载入进程之间停顿的毫秒数；  
proxy\_cache\_path:loader\_threshold 缓存载入进程迭代花去时间的最大值  
proxy\_cache\_use\_stale 在访问上游服务器的时候发生错误，在这种情况下接受提供过期的缓存数据。参数updating告知NGINX在客户端请求的项目的更新正在原服务器中下载时发送旧内容，而不是向服务器转发重复的请求  
proxy\_cache\_valid 缓存的有效期；指定对200、301或者302有效代码缓存的时间长度。特定参数any表示对任何响应都缓存一定时间长度。  
proxy\_cache\_methods 缓存支持的方法，默认为GET，可以改为POST，OPTIONS等  
缓存策略  
首页缓存1分钟，因为它所包含的链接及文件列表经常更新  
每篇文章都被缓存1天，因为一旦写完它们将不会改变，但我们又不希望缓存被填满，因此需要移除一些旧的缓存内容以便满足空间的需要。  
尽量地缓存所有图像，因为从磁盘检索图像文件是一件比较“昂贵”的操作。

http { 
    proxy_cache_path /usr/local/nginx/cache/api_cache levels=1:2 keys_zone=api_cache:10m max_size=20m inactive=15s use_temp_path=off;
    server { 
            listen       443 ssl;
    
            server_name  api.test.com api2.test.com api3.test.com;
            access_log logs/api.test.com_access.log main;
            error_log logs/api.test.com_error.log;
    
            #ssl on;
            ssl_certificate   ssl/_.test.com.crt;
            ssl_certificate_key  ssl/_.test.com.key;
            ssl_session_timeout 5m;
            ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
            ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
            ssl_prefer_server_ciphers on;
            location /api/config/banner { 
                    limit_req zone=allipsd burst=30 nodelay;
                    proxy_pass http://sgp_api;
                    proxy_set_header   Host    $host;
                    proxy_set_header   Remote_Addr    $remote_addr;
                    proxy_set_header   X-Real-IP    $remote_addr;
                    proxy_set_header   X-Forwarded-For    $proxy_add_x_forwarded_for;
                    proxy_cache_valid 200 304 10s;
                    proxy_cache_valid any 10s;
                    proxy_cache_key $host$uri$is_args$args;
                    proxy_cache api_cache;
    
    # index index;
    # proxy_set_header Upgrade $http_upgrade;
    # proxy_set_header Connection "upgrade";
    # proxy_http_version 1.1;
            }
                    location /api/reg/initRegPageData { 
                    proxy_pass http://api_url;
                    proxy_set_header   Host    $host;
                    proxy_set_header   Remote_Addr    $remote_addr;
                    proxy_set_header   X-Real-IP    $remote_addr;
                    proxy_set_header   X-Forwarded-For    $proxy_add_x_forwarded_for;
                    proxy_cache_valid 200 304 10s;
                    proxy_cache_valid any 10s;
                    proxy_cache_key $host$uri$is_args$args;
                    proxy_cache_methods POST;
                    proxy_cache api_cache;
            }
    }
    }

http { 
    proxy_cache_path /var/spool/nginx/articles keys_zone=ARTICLES:16m levels=1:2 inactive=1d;
    proxy_cache_path /var/spool/nginx/images keys_zone=IMAGES:128m levels=1:2 inactive=30d;
    proxy_temp_path /var/spool/nginx;
    
    server { 
        location / { 
            # 首页
            proxy_cache_valid 1m;
        }
        location /articles { 
            proxy_cache_valid 1d;
        }
        location /img { 
            proxy_cache_valid 10y;
        }
    }

\}  
示例  
下面的配置设计缓存所有的响应6个小时，缓存大小为1GB。任何条目保存刷新，就是说，在6个小时内被调用为超时，有效期为1天。在此时间后，上游服务器将再次调用提供响应。如果上游服务器由于错误、超时、无效头或者是由于缓存条目被升级，那么过期的条目就会被使用。共享内存区、CACHE被定义为10MB，并且在location中使用，在这里设置缓存key，并且也可以从这里查询。

http { 
    proxy_temp_path /var/spool/nginx;
    
    proxy_cache_path  /var/spool/nginx  keys_zone=CACHE:10m  levels=1:2  inactive=6h max_size=1g;
    server { 
        location / { 
            # using include to bring in a file with commonly-used settings
            include proxy.conf;
            proxy_cache CACHE;
            proxy_cache_valid any 1d;
            proxy_cache_use_stale error timeout invalid_header updating http_500 http_502 http_503 http_504;
            proxy_pass http://upstream;
        }
    }
    }

实践  
1，检测缓存状态  
通过添加如下代码实现

server { 
    listen 80;
    server_name xx.fofpower.com;
    location / { 
    proxy_cache api_cache;
    proxy_cache_valid 200 206 304 301 302 1d;
    proxy_ignore_headers Cache-Control;
    add_header X-Cache-Status $upstream_cache_status; #添加此行
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_pass http://myapi;
    }
    }

浏览器上看到的状态可能有：

$upstream\_cache\_status可能值：  
1，MISS——响应在缓存中找不到，所以需要在服务器中取得。  
2，HIT——响应包含来自缓存的最新有效的内容  
3，EXPIRED——缓存中的某一项过期了，来自原始服务器的响应包含最新的内容  
4，STALE——内容陈旧是因为原始服务器不能正确响应。需要配置proxy\_cache\_use\_stale  
5，UPDATING——内容过期了，因为相对于之前的请求，响应的入口（entry）已经更新，并且proxy\_cache\_use\_stale的updating已被设置  
6，REVALIDATED——proxy\_cache\_revalidate命令被启用，NGINX检测得知当前的缓存内容依然有效(If-Modified-Since或者If-None-Match)

2，缓存POST请求  
NGINX默认支持GET请求的缓存，要增加POST，需要设置proxy\_cache\_methods。  
对于POST请求，url相同，body内容不同，如果使用默认的proxy\_cache\_key，会造成不同的post请求，用了一个缓存键，返回给前端的数据会错乱。  
解决方案是将post的请求参数也作为key的一部分。

server { 
    listen 80;
    server_name www.fofeasy.com;
    add_header X-Cache-Status $upstream_cache_status;
    location / { 
    proxy_cache web_cache;
    proxy_cache_valid 200 206 304 301 302 10d;
    proxy_cache_key $uri$request_body; #增加此行
    proxy_cache_methods GET POST; #增加此行
    proxy_ignore_headers Cache-Control;
    proxy_redirect off;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_pass http://myweb;
    }
    }

[NGINX缓存使用官方指南][NGINX]  
[使用 Nginx 反代并缓存动态内容][Nginx]

[NGINX]: https://link.jianshu.com/?t=https://linux.cn/article-5945-1.html
[Nginx]: https://link.jianshu.com/?t=https://blessing.studio/use-nginx-proxy-to-cache-dynamic-content/