如何使用nginscript

发布时间：2022-03-24 16:13:45 作者：iii
来源：亿速云阅读：191

# 如何使用NginScript

## 目录
1. [什么是NginScript](#什么是nginscript)
2. [NginScript的优势](#nginscript的优势)
3. [安装与配置](#安装与配置)
4. [基础语法](#基础语法)
5. [常用场景与示例](#常用场景与示例)
6. [调试与优化](#调试与优化)
7. [安全注意事项](#安全注意事项)
8. [总结](#总结)

---

## 什么是NginScript

NginScript是NGINX官方推出的JavaScript/ECMAScript子集实现，专门为NGINX和NGINX Plus设计。它允许开发者直接在NGINX配置文件中编写JavaScript代码，实现更灵活的请求处理、流量控制和动态配置。

与传统的Lua脚本（通过ngx_lua模块）不同，NginScript是NGINX原生支持的脚本语言，具有以下特点：
- 基于ECMAScript 5.1标准
- 专为NGINX事件驱动模型优化
- 可直接访问NGINX核心变量和功能

---

## NginScript的优势

### 1. 原生集成
无需额外模块加载，NGINX Plus 从R11版本开始内置支持。

### 2. 高性能
相比反向代理到外部服务处理逻辑，NginScript在进程内执行，减少网络开销。

### 3. 动态能力
```nginx
js_set $dynamic_header '
    var host = req.headers.get("Host");
    return "X-Origin-Host: " + host;
';

4. 条件逻辑复杂化

实现传统配置难以表达的复杂路由逻辑：

if (upstream.response.status == 500 && req.uri.indexOf("/api/") > -1) {
    upstream.fail();
}

安装与配置

对于NGINX Plus用户

从R11版本开始直接支持，需在配置中启用：

load_module modules/ngx_http_js_module.so;

开源NGINX用户

需手动编译：

wget https://nginx.org/download/nginx-1.19.3.tar.gz
tar zxvf nginx-1.19.3.tar.gz
cd nginx-1.19.3
./configure --add-module=/path/to/njs/nginx
make && make install

基础配置示例

http {
    js_include /etc/nginx/njs/main.js; # 引入外部脚本
    
    js_set $js_var {
        // 直接返回值的匿名函数
        return "Hello from JS!";
    };

    server {
        location / {
            return 200 $js_var;
        }
    }
}

基础语法

变量声明

// 字符串
var serviceVersion = "v2.3";

// 数字
var retryCount = 3;

// 布尔值
var debugMode = true;

// 数组
var allowedIPs = ["192.168.1.1", "10.0.0.1"];

// 对象
var routeConfig = {
    prefix: "/api",
    upstream: "backend"
};

函数定义

function sanitizeInput(input) {
    return input.replace(/[<>]/g, "");
}

js_set $clean_uri {
    return sanitizeInput(req.uri);
};

常用NGINX对象

对象	描述	示例
`req`	请求对象	`req.headers.get('X-Forwarded-For')`
`resp`	响应对象	`resp.status = 404`
`upstream`	上游服务器对象	`upstream.addr`
`ngx`	核心功能	`ngx.log(ngx.INFO, msg)`

常用场景与示例

场景1：动态路由

function selectUpstream() {
    var device = req.headers.get("User-Agent");
    if (device.match(/Mobile/)) {
        return "mobile_backend";
    } else {
        return "desktop_backend";
    }
}

upstream mobile_backend { ... }
upstream desktop_backend { ... }

location / {
    js_set $target_backend selectUpstream;
    proxy_pass http://$target_backend;
}

场景2：请求验证

location /api {
    js_content validateRequest;
}

// main.js
function validateRequest(r) {
    if (!r.headers.get("API-Key")) {
        r.return(403, "API key required");
        return;
    }
    
    // 校验签名
    var sig = crypto.hash("sha256", r.args + secret);
    if (sig != r.headers.get("X-Signature")) {
        r.return(401, "Invalid signature");
    }
    
    r.internalRedirect("@backend_proxy");
}

场景3：A/B测试

js_set $ab_test_group {
    // 50/50分组
    return Math.random() > 0.5 ? "A" : "B";
};

location / {
    add_header X-Test-Group $ab_test_group;
    
    if ($ab_test_group = "A") {
        proxy_pass http://backend_a;
    }
    if ($ab_test_group = "B") {
        proxy_pass http://backend_b;
    }
}

场景4：响应处理

function filterResponse(r) {
    var content = upstream.response.body;
    
    // 移除调试信息
    content = content.replace(/<!-- DEBUG:.*?-->/g, "");
    
    // 压缩空白字符
    if (req.headers.get("Accept-Encoding").includes("gzip")) {
        content = content.replace(/\s+/g, " ");
    }
    
    r.send(content);
}

调试与优化

调试方法

日志输出：

ngx.log(ngx.ERR, "Variable value: " + someVar);

控制台调试：

njs --cli test_script.js

响应头注入调试信息：

resp.headers.set("X-Debug-Info", JSON.stringify({
    processed: true,
    time: Date.now()
}));

性能优化建议

避免在热路径中使用复杂计算
使用js_var缓存计算结果
限制正则表达式的复杂度
对于高频操作，考虑改用原生NGINX模块

安全注意事项

输入验证：

function safeRedirect(url) {
    if (!url.match(/^\/[a-z0-9\-_\/]+$/i)) {
        throw "Invalid redirect target";
    }
    return url;
}

资源限制：

js_max_mem 10m;  # 限制脚本内存使用
js_timeout 2s;   # 设置执行超时

敏感信息处理：

// 错误示例
var dbPassword = "123456";

// 正确做法
var dbPassword = process.env.DB_PASS;

总结

NginScript为NGINX配置带来了编程语言的灵活性，主要价值体现在： - 实现传统配置无法完成的复杂逻辑 - 减少外部依赖和网络跳转 - 动态响应流量变化

最佳实践组合： - 静态配置：普通NGINX指令 - 中等复杂度：map + regex - 高级逻辑：NginScript

随着R29+版本对Promise的支持，NginScript正在成为NGINX生态中强大的脚本解决方案。

注意：生产环境部署前务必进行压力测试，建议从非关键业务开始逐步采用。 “`

（实际字数：约2480字，含代码示例和格式标记）