NGINX JavaScript (njs) 项目教程

1. 项目介绍

NGINX JavaScript (njs) 是一个动态模块，允许使用熟悉的 JavaScript 语法扩展 NGINX 的内部功能。njs 是 JavaScript 语言的一个子集，符合 ECMAScript 5.1（严格模式），并包含一些 ECMAScript 6 及更高版本的扩展。njs 的主要目标是提供一种简单且高效的方式来编写复杂的访问控制、安全检查、响应头操作以及灵活的异步内容处理程序和过滤器。

2. 项目快速启动

安装 njs

首先，确保你已经安装了 NGINX。然后，你可以通过以下命令安装 njs 模块：

# 对于 Ubuntu 或 Debian 系统
sudo apt install nginx-module-njs

# 对于 RHEL、CentOS 或其他 RedHat 衍生系统
sudo yum install nginx-module-njs

# 对于 Alpine 或其他类似系统
sudo apk add nginx-module-njs@nginx

# 对于 SuSE 或其他类似系统
sudo zypper install nginx-module-njs

配置 NGINX 使用 njs

1. 创建一个 njs 脚本文件，例如 http.js：

function hello(r) {
    r.return(200, "Hello world\n");
}

export default { hello };

2. 在 NGINX 配置文件中启用 njs 模块并指定脚本文件：

load_module modules/ngx_http_js_module.so;

events {}

http {
    js_import http.js;

    server {
        listen 8000;

        location / {
            js_content http.hello;
        }
    }
}

3. 启动或重新加载 NGINX：

sudo nginx -s reload

4. 访问 http://localhost:8000，你应该会看到 "Hello world" 的响应。

3. 应用案例和最佳实践

复杂访问控制和安全检查

njs 可以用于在请求到达上游服务器之前执行复杂的访问控制和安全检查。例如，你可以编写一个脚本来验证请求的来源 IP 地址是否在允许的列表中。

function check_ip(r) {
    const allowed_ips = ["192.168.1.1", "10.0.0.1"];
    if (!allowed_ips.includes(r.remoteAddress)) {
        r.return(403, "Forbidden\n");
    } else {
        r.internalRedirect("@backend");
    }
}

export default { check_ip };

响应头操作

你可以使用 njs 来动态修改响应头，例如添加或删除特定的头信息。

function modify_headers(r) {
    r.headersOut["X-Custom-Header"] = "MyValue";
    r.internalRedirect("@backend");
}

export default { modify_headers };

异步内容处理

njs 支持异步操作，可以用于处理需要等待外部资源的情况。

async function async_handler(r) {
    const response = await fetch("https://api.example.com/data");
    const data = await response.json();
    r.return(200, JSON.stringify(data));
}

export default { async_handler };

4. 典型生态项目

NGINX OpenID Connect

该项目扩展了 NGINX Plus 的功能，使其能够直接与 OIDC 兼容的身份提供者通信，验证用户并授权通过 NGINX Plus 提供的内容。

NGINX SAML

这是一个参考实现，将 NGINX Plus 作为 SAML 认证的服务提供者。

njs-prometheus-module

该项目提供了一个 Prometheus 指标端点，可以直接从 NGINX Plus 暴露 Prometheus 指标。

通过这些生态项目，njs 不仅扩展了 NGINX 的功能，还为开发者提供了丰富的工具和资源来构建复杂的应用。