Nginx 是一个免费开源且稳定高效的 Web 服务器程序,拥有反向代理以及负载平衡的功能,经常作为最前端的服务器。当它用作反向代理服务器或是 PHP 网页服务器时,无论是 proxy_pass 还是 fastcgi_pass,均有提供缓存的功能。然而,免费版本的 Nginx 并没有内置删除缓存的机制(官方的 proxy_cache_purge、fastcgi_cache_purge 命令可以用来清除缓存,只不过这功能只有商业版本才能使用,免费版本要另外编译第三方的 ngx_cache_purge 模块才有类似的命令),在没有额外脚本或程序的帮助下,我们大概也只能用 rm 等 Linux 指令来手动删除缓存目录中的文件,十分不方便,而且有一定的危险性。
如果您不知道如何在 Ubuntu Server 架设 Nginx 服务器,也不知道怎么使用 proxy_pass 的缓存功能的话,可以先参考这篇文章:
如果您是架设 PHP 网站的话,可以再参考这篇文章来了解 fastcgi_pass 的缓存功能:
Nginx Cache Purge
「Nginx Cache Purge」是一个高效 Nginx 缓存清除工具,是解决免费版本的 Nginx 不能使用 proxy_cache_purge 和 fastcgi_cache_purge 命令的替代方案。
GitHub:
安装和卸载 Nginx Cache Purge
透过 Cargo
如果系统环境中有安装「Cargo」的话,可以直接使用以下指令来下载「Nginx Cache Purge」的源代码项目,并进行编译安装。
cargo install nginx-cache-purge
若要卸载,运行以下这个指令即可:
cargo uninstall nginx-cache-purge
透过 GitHub(适用于 Linux x86_64)
运行以下指令,将最新的 Nginx Cache Purge 可执行文件从 GitHub 上下载下来,并移动到 /usr/local/bin 目录中。
curl -fL "$(curl -fsS https://api.github.com/repos/magiclen/nginx-cache-purge/releases/latest | sed -r -n 's/.*"browser_download_url": *"(.*\/nginx-cache-purge_'$(uname -m)')".*/\1/p')" -O && sudo mv nginx-cache-purge_$(uname -m) /usr/local/bin/nginx-cache-purge && sudo chmod +x /usr/local/bin/nginx-cache-purge
若要卸载,运行以下这个指令即可:
sudo rm /usr/local/bin/nginx-cache-purge
使用 Nginx Cache Purge
命令行界面
Nginx Cache Purge 有提供 CLI(命令行界面),指令用法如下:
CACHE_PATH 是使用 Nginx 的 proxy_cache_path 或是 fastcgi_cache_path 命令时所设置的缓存保存目录路径。LEVELS 是使用 Nginx 的 proxy_cache_path 或是 fastcgi_cache_path 命令时所设置的目录和目录文件名结构,格式为 x[:y[:z]]。KEY 是使用 Nginx 的 proxy_cache_key 或是 fastcgi_cache_key 命令时所设置的缓存键值。
建议把缓存的键值以 Nginx 的 $request_uri 为结尾,因为 Nginx Cache Purge 还有 Wildcard 清除功能。KEY 中可以使用星号 * 来表示任意数量的任意字符。
如果想避开清除到某些缓存,可以使用一个或多个 -e 参数再加上要保留的缓存的键值,同样支持 Wildcard 匹配。
Nginx + Nginx Cache Purge
启动 Nginx Cache Purge 服务
Nginx Cache Purge 自带 HTTP 服务,可以用来处理清除缓存的请求。使用以下指令可以启动该 HTTP 服务:
以上指令会使 Nginx Cache Purge 启动自带的 HTTP 服务,并监听 /tmp/nginx-cache-purge.sock,这个是 UDS (Unix Domain Socket)。
要让 Nginx Cache Purge 的服务在 Linux 开机之后自动启动,可以先参考以下这篇文章了解:
以下是参考用的 Systemd Unit 文件和激活指令:
[Unit]
Description=Nginx Cache Purge
After=network.target
[Service]
# same as the user/group of the nginx process
User=www-data
Group=www-data
ExecStart=/usr/local/bin/nginx-cache-purge start
Restart=always
RestartSec=3s
[Install]
WantedBy=multi-user.target
sudo systemctl daemon-reload
sudo systemctl start nginx-cache-purge
sudo systemctl status nginx-cache-purge
sudo systemctl enable nginx-cache-purge
有了 Nginx Cache Purge 服务后,就可以在 Nginx 设置档中将 HTTP 请求导给 Nginx Cache Purge 服务处理。我们在指定的 location 区块中,或是 location 区块内的 if 区块中,去调用 Nginx Cache Purge 的服务。
至于要在哪个 location 区块中或是 if 区块中去运行 Nginx Cache Purge,其实也没有一定的标准,大致上有两种作法。
HTTP 的 PURGE 请求方法
在有使用到 proxy_cache 或是 fastcgi_cache 命令的区块中,可以去判断客户端的请求方法是不是 PURGE。虽然 PURGE 请求方法并不在 HTTP 标准中,但许多人会用它来当作清除缓存的请求方法,有点约定俗成的感觉。
若要用这个方式来清除缓存,可以在 /etc/nginx/conf.d 目录中,添加 purge.conf 文件,文件内容如下:
map $request_method $is_purge {
default 0;
PURGE 1;
}
以上的 map 命令,可以去判断客户端的请求方法是不是 PURGE,如果是的话,$is_purge 变量的值就是 1,否则是 0。
接着就是在 location 区块内使用 if 命令判断 $is_purge 变量,并在 if 区块中使用 proxy_pass 命令将请求交给 Nginx Cache Purge 服务处理。假设 Nginx Cache Purge 服务监听的是 /tmp/nginx-cache-purge.sock,设置方式如下:
http {
...
map $request_method $is_purge {
default 0;
PURGE 1;
}
proxy_cache_path /tmp/cache levels=1:2 keys_zone=my_cache:10m;
proxy_cache_key $scheme$request_uri;
server {
...
location / {
if ($is_purge) {
set $my_cache_key $scheme$request_uri;
proxy_pass http://unix:/tmp/nginx-cache-purge.sock;
rewrite ^ /?cache_path=/tmp/cache&levels=1:2&key=$my_cache_key break;
}
proxy_cache my_cache;
proxy_pass upstream;
include proxy_params;
}
}
}
不过当然,我们还需要加入自己的访问验证机制,避免随便一个陌生人都可以连到我们的服务器上清除缓存。
以上的设置若成功,
- 发送
PURGE /path/to/abc请求,表示要清除GET /path/to/abc产生的缓存。 - 发送
PURGE /path/to/*请求,表示要清除GET /path/to/**/*产生的缓存,像是GET /path/to/、GET /path/to/abc、GET /path/to/123/456?a=bc。 - 发送
PURGE /path/to/*/foo/*/bar请求,表示要清除GET /path/to/**/foo/**/bar产生的缓存,像是GET /path/to/123/foo/456/bar、GET /path/to/a/foo/b/c?e=bar。
专门用来清除缓存的 location 区块
如果不想把清除缓存的功能和 proxy_cache 或是 fastcgi_cache 命令放在同一个 location 区块,并使用 PURGE 请求方法来切换功能。也是可以另外再创建出 location 区块,设置一个专门用来清除缓存的端点,不过缓存键值中 $request_uri 的部份就会需要在服务的请求查找中加上 remove_first 字段来移除多出来的网址部件。
例如:
http {
...
proxy_cache_path /tmp/cache levels=1:2 keys_zone=my_cache:10m;
proxy_cache_key $scheme$request_uri;
server {
...
location / {
proxy_pass upstream;
include proxy_params;
}
location /purge/ {
set $my_cache_key $scheme$request_uri;
proxy_pass http://unix:/tmp/nginx-cache-purge.sock;
rewrite ^ /?cache_path=/tmp/cache&levels=1:2&remove_first=/purge&key=$my_cache_key break;
}
}
}
如果 HTTP 服务有清除到缓存,就会回传 200 状态码;如果没有要清除的缓存,就会回传 202 状态码。
让某些缓存避免被清除
在服务的请求查找中加上一个或多个 exclude_keys 字段,可以设置要排除的缓存键值,同样支持 Wildcard 匹配。
不要 HTTP 服务
我们可能会想要直接在 Nginx 中搭配 lua-nginx-module 来调用 Nginx Cache Purge 的 CLI 界面。那么我们可以在编译 Nginx Cache Purge 时关闭其 service 特色,以此得到更小的可执行文件。
可以使用以下指令来安装没有自带 HTTP 服务的 Nginx Cache Purge:
