如何利用NJS动态根据请求头判定是否执行HTTPS重定向-Nginx-PHP中文网

njs模块支持基于请求头的动态https重定向判断。通过编写javascript函数读取user-agent、x-skip-https等请求头执行业务逻辑，返回布尔值，再由js_set定义变量并在if指令中匹配字符串"true"触发301跳转。

如何利用njs动态根据请求头判定是否执行https重定向

Nginx JavaScript（NJS）模块可以实现比传统 map + if 更灵活、可编程的重定向逻辑。当你需要根据请求头（如 User-Agent、X-Forwarded-For、自定义 Header）动态决定是否跳转 HTTPS，而不是仅依赖 IP 段时，NJS 是更自然的选择。

核心思路是：在 NJS 脚本中读取请求头，执行业务判断逻辑，返回布尔值或状态码，再由 Nginx 的 return 或 rewrite 指令消费该结果。

✅ 前提条件

Nginx 已启用 NJS 模块（通常需编译时带 --add-dynamic-module=nginx-js，或使用官方预编译包如 nginx-plus / nginx:alpine 含 njs 的版本）
验证 NJS 可用：nginx -V 2>&1 | grep -o with-http_js_module

✅ 步骤一：编写 NJS 函数判定是否跳转

在 nginx.conf 的 http { } 块外（推荐放在 /etc/nginx/njs/https_redirect.js）写：

小鸽子助手

一款AI开发辅助工具，主要用于一款集成于WPS/Word的智能写作插件，适合需要提升相关任务效率的用户。

下载

function shouldRedirectToHttps(r) {
    // 示例：禁止特定 User-Agent（如内部监控探针）跳转
    const ua = r.headersIn['User-Agent'] || '';
    if (/HealthChecker|curl|monitor-agent/i.test(ua)) {
        r.log('Skip HTTPS redirect for UA: ' + ua);
        return false;
    }

    // 示例：允许携带 X-Skip-HTTPS: 1 的请求跳过重定向
    if (r.headersIn['X-Skip-HTTPS'] === '1') {
        r.log('Skip HTTPS redirect due to X-Skip-HTTPS header');
        return false;
    }

    // 示例：对特定 Referer 来源放行 HTTP（如内网调试页）
    const referer = r.headersIn['Referer'] || '';
    if (referer.includes('http://localhost:') || referer.includes('http://192.168.')) {
        return false;
    }

    // 其他情况默认跳转
    return true;
}

⚠️ 注意：NJS 中不能直接 return 301；它只负责计算并返回 true/false 或字符串，重定向动作仍由 Nginx 配置层触发。

✅ 步骤二：在 nginx.conf 中加载并调用该函数

# 加载 NJS 脚本（放在 http 块顶部）
js_import /etc/nginx/njs/https_redirect.js;

# 定义一个变量，供后续 use（注意：NJS 变量必须用 js_set）
js_set $should_redirect https_redirect.shouldRedirectToHttps;

✅ 步骤三：在 80 端口 server 中应用判断

server {
    listen 80;
    server_name example.com;

    # 若 NJS 返回 true，则 301 跳转 HTTPS
    if ($should_redirect = "true") {
        return 301 https://$host$request_uri;
    }

    # 否则继续处理：静态资源、健康检查、代理等
    location /healthz {
        return 200 "OK";
    }

    location / {
        proxy_pass http://backend;
    }
}

✅ js_set 生成的变量 $should_redirect 是字符串 "true" 或 "false"，所以 if 中必须用双引号匹配。

✅ 补充说明与避坑点

NJS 函数中不能修改响应头或直接发响应，只能做判断和日志（r.log() / r.warn()）
js_set 变量是在 rewrite 阶段早期计算的，适用于所有标准指令（如 if, return）
不建议在 location 内重复 js_import，应统一在 http 块导入一次
若需基于客户端真实 IP（非代理转发后），确保 real_ip_header 和 set_real_ip_from 已正确配置，否则 r.remoteAddress 可能不准
NJS 调用开销略高于原生 map，但对大多数场景影响极小；如 QPS 超 10k+，建议压测验证

✅ 对比传统 map 方案的优势

场景	`map` + 正则	NJS
判断 `User-Agent` 是否含多个关键词	需多行正则，难维护	一行 JS 正则 `/a\\|b\\|c/i`
解析 JSON 类型 Header（如 `X-Context: {"env":"dev"}`）	不支持	可 `JSON.parse()`
根据 Header 值查外部缓存或调用 API	不支持	可扩展 `r.subrequest()`（需配合 async）
动态日志记录决策原因	不支持	`r.log()` 直接输出上下文