Nginx 缓存键设计如何配置 API 版本缓存键

陌强君_8675

陌强君_8675

2026-11-20

223人浏览

原创

配置 api 版本缓存键的核心做法是将版本号作为变量嵌入 $request_uri 或自定义路径中,并通过 proxy_cache_key 指令将其组合进缓存标识。这样做的结果是不同版本的 api 请求会生成独立的缓存文件,避免旧版本响应被新版本覆盖。若请求中包含动态查询参数,建议结合 $query_string 或使用 $uri 配合版本号前缀来确保缓存隔离。

Nginx 缓存键设计如何配置 API 版本缓存键

如何基于 URL 路径中的版本号设计缓存键

当 API 版本直接体现在 URL 路径中(如 /api/v1/...)时,最直接的方案是利用 Nginx 内置的 $uri 变量,因为它已经包含了路径信息但不包含查询字符串。通过设置 proxy_cache_key 为 $scheme$host$uri,Nginx 会自动根据路径中的版本号区分缓存。这种方法简单且高效,因为路径结构天然反映了资源版本。如果希望更明确地控制,也可以手动拼接 $uri 和 $args,但通常 $uri 已足够区分不同版本的路径。

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

    # 定义缓存路径
    proxy_cache_path /var/cache/nginx/api levels=1:2 keys_zone=api_cache:10m max_size=1g inactive=60m;

    location /api/ {
        # 核心配置:使用 URI 作为缓存键的一部分
        # $uri 自动包含 /api/v1/ 或 /api/v2/ 等版本路径
        proxy_cache_key "$scheme$host$uri";
        
        proxy_pass http://backend_servers;
        proxy_cache api_cache;
        
        # 可选:设置缓存过期时间
        proxy_cache_valid 200 10m;
    }
}

上述配置中,$uri 变量在 Nginx 内部处理时会保留原始请求的路径部分。对于 /api/v1/users 和 /api/v2/users,生成的缓存键分别为 http://api.example.com/api/v1/users 和 http://api.example.com/api/v2/users,从而实现了版本间的缓存隔离。无需额外正则提取版本号,路径结构本身即提供了足够的区分度。

如何处理带查询参数的 API 版本缓存键

当 API 版本通过查询参数传递(如 ?version=v1)或需要同时考虑路径和参数时,必须将 $query_string 显式加入缓存键。否则,/api/data?version=v1 和 /api/data?version=v2 可能会命中同一个缓存条目,导致数据混乱。此时应将 $uri 与 $query_string 组合,形成完整的唯一标识。这种组合方式确保了即使路径相同,只要参数不同,就会生成不同的缓存键。

Nginx Reverse Proxy
Nginx Reverse Proxy

配置 Nginx 反向代理,实现域名绑定。用户说“绑定域名”“配置 Nginx”“反向代理”时触发,将域名绑定到指定 IP:端口。

下载
server {
    listen 80;
    server_name api.example.com;

    proxy_cache_path /var/cache/nginx/api_query levels=1:2 keys_zone=api_query_cache:10m max_size=1g inactive=60m;

    location /api/data {
        # 核心配置:URI + 查询字符串作为缓存键
        # 确保 ?version=v1 和 ?version=v2 产生不同缓存
        proxy_cache_key "$scheme$host$uri?$query_string";
        
        proxy_pass http://backend_servers;
        proxy_cache api_query_cache;
        
        proxy_cache_valid 200 5m;
    }
}

在此配置下,$query_string 变量包含了完整的查询字符串(不含 ?)。例如,请求 /api/data?version=v1&format=json 会生成缓存键 http://api.example.com/api/data?version=v1&format=json。这保证了每个独特的参数组合都有独立的缓存空间。需要注意的是,如果某些参数不影响内容(如追踪 ID),应在后端或前端过滤掉,或在 Nginx 中使用 map 指令清理后再生成缓存键,以避免缓存爆炸。

基于特定输入条件验证缓存键冲突

为了验证缓存键是否真正隔离了不同版本,我们可以构造一个具体的测试场景:同一路径但不同版本参数。假设后端服务返回的内容严格依赖于 version 参数,我们将发送两个请求:/api/data?version=v1 和 /api/data?version=v2。如果配置正确,这两个请求应分别生成两个独立的缓存文件。我们可以通过检查 Nginx 缓存目录下的文件数量或内容哈希来确认。若未正确配置 $query_string,则第二个请求可能命中第一个请求的缓存,导致返回错误版本的数据。此验证方法直接针对缓存键的设计有效性,确保版本隔离在实际运行中生效。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nginx nginx 缓存

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4387

6

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

2023.08.04

7365

6

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

601

5

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.07.09

1516

5

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

2024.08.07

4018

3

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

122

12

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

617

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

179

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习