nginx 缓存功能(proxy_cache)

文件名

nginx 缓存功能 (proxy_cache).md

正文

本节介绍如何启用和配置代理服务器响应的缓存功能。

总览
启用响应缓存
缓存涉及的 Nginx 进程
指定要缓存的请求
限制或绕过缓存
从缓存中清除内容
字节范围缓存
组合配置示例

总览 {#overview}

启用缓存后，Nginx 会将响应保存在磁盘缓存中，并使用它们来响应客户端，而不必每次都向代理服务器请求相同的内容。

要了解有关 Nginx 缓存功能的更多信息，请观看 NGINX 内容缓存网络研讨会，并深入了解动态内容缓存、缓存清除和延迟缓存等功能。

启用响应缓存 {#enable}

要启用缓存，请在 http {} 顶级上下文中包含 proxy_cache_path 指令。该指令的第一个必需参数是缓存内容的本地文件系统路径，第二个必需参数通过 keys_zone 定义用于存储缓存项元数据的共享内存区名称和大小：

http {
    ...
    proxy_cache_path /data/nginx/cache keys_zone=one:10m;
}

然后，在需要缓存服务器响应的上下文（http {}、server {} 或 location {}）中包含 proxy_cache 指令，并为该指令指定由 proxy_cache_path 定义的 keys_zone 区域名称（在本例中为 one）：

http {
    ...
    proxy_cache_path /data/nginx/cache keys_zone=one:10m;
    server {
        proxy_cache one;
        location / {
            proxy_pass http://localhost:8000;
        }
    }
}

请注意，keys_zone 参数定义的大小并不限制缓存响应数据的总量。缓存的响应本身与元数据的副本一起存储在文件系统上的特定文件中。要限制缓存的响应数据量，请在 proxy_cache_path 指令中包含 max_size 参数。（但请注意，缓存的数据量可能会暂时超过此限制，如下一节所述。）

缓存涉及的 Nginx 进程 {#processes}

缓存功能还涉及另外两个 Nginx 进程：

缓存管理器（Cache Manager）：周期性启动，检查缓存状态。如果缓存大小超出了 proxy_cache_path 指令设置的 max_size 限制，缓存管理器将删除最近最少访问的数据。如前所述，在缓存管理器激活之间的时间间隔内，缓存的数据量可能会暂时超过限制。
缓存加载器（Cache Loader）：仅在 Nginx 启动后运行一次。它将有关先前缓存数据的元数据加载到共享内存区域中。在启动后的最初几分钟内，一次加载整个缓存可能会消耗足够的资源，从而降低 Nginx 的性能。为避免这种情况，请在 proxy_cache_path 指令中包含以下参数来配置缓存的迭代加载：
- loader_threshold：迭代持续时间，以毫秒为单位（默认为 200）
- loader_files：一次迭代中加载的最大项目数（默认为 100）
- loader_sleeps：迭代之间的延迟，以毫秒为单位（默认为 50）

在下面的示例中，迭代持续 300 毫秒或直到加载 200 个项目为止：

proxy_cache_path /data/nginx/cache keys_zone=one:10m loader_threshold=300 loader_files=200;

指定要缓存的请求 {#select}

默认情况下，Nginx 会缓存对使用 GET 和 HEAD 方法发出的请求的所有响应，并在首次从代理服务器接收到此类响应时进行缓存。Nginx 使用请求字符串作为请求的键（标识符）。如果请求具有与缓存响应相同的键，Nginx 会将缓存的响应发送到客户端。您可以在 http {}、server {} 或 location {} 不同的上下文中控制哪些响应被缓存。

要更改用于计算键的请求特征，请包含 proxy_cache_key 指令：

proxy_cache_key "$host$request_uri$cookie_user";

要定义在缓存响应之前必须发出具有相同键的请求的最小次数，请包含 proxy_cache_min_uses 指令：

proxy_cache_min_uses 5;

要使用 GET 和 HEAD 以外的方法缓存对请求的响应，请将它们与 GET 和 HEAD 一起作为 proxy_cache_methods 指令的参数列出：

proxy_cache_methods GET HEAD POST;

限制或绕过缓存 {#bypass}

默认情况下，响应会无限期保留在缓存中。仅当缓存超过最大配置大小时才将其删除，然后按自上次请求以来的时间长度顺序进行删除。您可以在 http {}、server {} 或 location {} 上下文中设置缓存响应的有效时间，甚至决定是否使用缓存。

要限制具有特定状态码的缓存响应被视为有效的时间，请包含 proxy_cache_valid 指令：

proxy_cache_valid 200 302 10m;
proxy_cache_valid 404 1m;

在此示例中，带有代码 200 或 302 的响应被认为有效 10 分钟，带有代码 404 的响应被认为有效 1 分钟。要定义所有状态代码的响应的有效时间，请指定 any 作为第一个参数：

proxy_cache_valid any 5m;

要定义 Nginx 不向客户端发送缓存响应的条件，请包含 proxy_cache_bypass 指令。每个参数定义一个条件，由多个变量组成。如果至少一个参数不为空且不等于 "0"（零），则 Nginx 不会在缓存中查找响应，而是立即将请求转发给后端服务器。

proxy_cache_bypass $cookie_nocache $arg_nocache $arg_comment;

要定义条件，使 Nginx 根本不缓存响应，请包含 proxy_no_cache 指令，以与 proxy_cache_bypass 指令相同的方式定义参数。

proxy_no_cache $http_pragma $http_authorization;

从缓存中清除内容 {#purge}

Nginx 可以从缓存中删除过期的缓存文件。这对于删除过时的缓存内容是必要的，以防止同时提供新旧版本的网页。收到包含自定义 HTTP 标头或 HTTP PURGE 方法的特殊“清除”请求后，将清除缓存。

配置缓存清除 {#purge_configure}

让我们设置一个配置，该配置标识使用 HTTP PURGE 方法的请求并删除匹配的 URL。

在 http {} 上下文中，创建一个新变量 $purge_method，该变量取决于 $request_method：

http {
    ...
    map $request_method $purge_method {
        PURGE 1;
        default 0;
    }
}

在配置了缓存的 location {} 块中，包含 proxy_cache_purge 指令，以指定缓存清除请求的条件。在我们的示例中，它是上一步中配置的 $purge_method：

server {
    listen      80;
    server_name www.example.com;

    location / {
        proxy_pass  https://localhost:8002;
        proxy_cache mycache;

        proxy_cache_purge $purge_method;
    }
}

发送清除命令 {#purge_request}

当 proxy_cache_purge 指令配置后，你需要发送一个特殊的缓存清除请求来清除缓存。您可以使用多种工具发出清除请求，包括 curl 命令，以下示例展示了如何使用它：

$ curl -X PURGE -D - "https://www.example.com/*"
HTTP/1.1 204 No Content
Server: nginx/1.15.0
Date: Sat, 19 May 2018 16:33:04 GMT
Connection: keep-alive

在该示例中，将清除具有公共 URL 部分（由星号通配符指定）的资源。但是，此类缓存条目不会完全从缓存中删除：它们保留在磁盘上，直到因不活动（由 proxy_cache_path 指令的 inactive 参数确定）或由缓存清除程序（将 purger 参数启用为 proxy_cache_path）或客户端尝试访问它们而被删除为止。

限制对清除命令的访问 {#purge_secure}

我们建议您限制允许发送缓存清除请求的 IP 地址数量：

geo $purge_allowed {
   default         0;  # 拒绝其他所有
   10.0.0.1        1;  # 允许本地主机
   192.168.0.0/24  1;  # 允许 192.168.0.0/24 网段
}

map $request_method $purge_method {
   PURGE   $purge_allowed;
   default 0;
}

在此示例中，Nginx 检查 PURGE 请求中是否使用了该方法，如果有，则分析客户端 IP 地址。如果 IP 地址已列入白名单，则将 $purge_method 设置为 $purge_allowed 的值：1 允许清除，0 拒绝它。

从缓存中完全删除文件 {#purge_remove}

要完全删除与星号匹配的缓存文件，请激活一个特殊的 cache purger 进程，该进程将永久迭代所有缓存项并删除与通配符键匹配的项。将 purger 参数包含到 http {} 上下文中的 proxy_cache_path 指令中：

proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=mycache:10m purger=on;

缓存清除配置示例 {#purge_example}

http {
    ...
    proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=mycache:10m purger=on;

    map $request_method $purge_method {
        PURGE 1;
        default 0;
    }

    server {
        listen      80;
        server_name www.example.com;

        location / {
            proxy_pass        https://localhost:8002;
            proxy_cache       mycache;
            proxy_cache_purge $purge_method;
        }
    }

    geo $purge_allowed {
       default         0;
       10.0.0.1        1;
       192.168.0.0/24  1;
    }

    map $request_method $purge_method {
       PURGE   $purge_allowed;
       default 0;
    }
}

字节范围缓存 {#slice}

初始缓存填充操作有时会花费很长时间，尤其是对于大文件。例如，当视频文件开始下载以满足部分文件的初始请求时，后续请求必须等待整个文件被下载并放入缓存中。

Nginx 可以缓存此类范围请求，并使用缓存切片模块逐渐填充缓存，该模块将文件分成较小的“切片”。每个范围请求都选择覆盖所请求范围的特定切片，如果仍未缓存该范围，则将其放入缓存。这些切片的所有其他请求都从缓存中获取数据。

要启用字节范围缓存：

确保 Nginx 是使用缓存切片模块编译的。
使用 slice 指令指定切片的大小：
```
location / {
    slice  1m;
}
```
选择切片大小以使切片下载速度更快。如果大小太小，则内存使用可能会过多，并且在处理请求时会打开大量文件描述符；而太大的大小可能会导致延迟。

将 $slice_range 变量包括到缓存键中：

proxy_cache_key $uri$is_args$args$slice_range;

使用 206 状态码启用响应缓存：
```
proxy_cache_valid 200 206 1h;
```
通过在 Range 标头字段中设置 $slice_range 变量，可以将范围请求传递到代理服务器：
```
proxy_set_header  Range $slice_range;
```

这是完整的配置：

location / {
    slice             1m;
    proxy_cache       cache;
    proxy_cache_key   $uri$is_args$args$slice_range;
    proxy_set_header  Range $slice_range;
    proxy_cache_valid 200 206 1h;
    proxy_pass        http://localhost:8000;
}

请注意，如果启用了切片缓存，则不得更改初始文件。

组合配置示例 {#example}

下面的示例配置结合了上述某些缓存选项。

http {
    ...
    proxy_cache_path /data/nginx/cache keys_zone=one:10m loader_threshold=300 
                     loader_files=200 max_size=200m;

    server {
        listen 8080;
        proxy_cache one;

        location / {
            proxy_pass http://backend1;
        }

        location /some/path {
            proxy_pass http://backend2;
            proxy_cache_valid any 1m;
            proxy_cache_min_uses 3;
            proxy_cache_bypass $cookie_nocache $arg_nocache $arg_comment;
        }
    }
}

在此示例中，两个位置使用相同的缓存，但方式不同。

由于响应 backend1 很少改变，因此不包括缓存控制指令。响应在第一次发出请求时被缓存，并无限期保持有效。

相反，对请求的响应 backend2 通常由更改来服务，因此它们被认为仅有效 1 分钟，并且直到发出相同请求 3 次才被缓存。此外，如果请求符合 proxy_cache_bypass 指令定义的条件，则 Nginx 会立即将请求传递给 backend2 而无需在缓存中查找相应的响应。

说明：本文档基于 Nginx 开源版及 Nginx Plus 通用缓存机制整理。部分指令（如 proxy_cache_purge）在不同版本或编译模块中可能存在差异，具体请以官方文档及实际编译环境为准。配置中的 proxy_cache 区域名称需与 proxy_cache_path 定义的 keys_zone 名称保持一致。

本文地址：https://1diff.fun/archives/nginx-huan-cun-gong-neng-proxy-cache.html

如果对本文有什么问题或疑问都可以在评论区留言，我看到后会尽量解答。