前言
在编程世界里，JavaScript 以其无与伦比的灵活性和广泛的应用场景而闻名。
从前端到后端，从桌面到移动设备，JavaScript 的身影无处不在。但你有没有想过，JavaScript 竟然也能在 Nginx 中大展身手？
没错，今天，我们就来聊聊如何用 JavaScript 扩展 Nginx 的功能，探索 njs（Nginx JavaScript Engine）的奥秘。
什么是 njs？
njs 是 JavaScript 语言的子集，允许我们在 Nginx 中直接运行 JavaScript 代码，从而扩展 Nginx 的功能。
它基于 ECMAScript 5.1（严格模式）创建，并兼容一些 ECMAScript 6 及更高版本的新特性。这意味着，你可以用熟悉的 JavaScript 语法来编写 Nginx 模块，实现复杂的访问控制、安全检查、响应头操作等功能。
Next.js 搭配 Headless CMS 搞网站真香！
njs 的用武之地
njs 的用例非常广泛，以下是一些常见的应用场景：
复杂的访问控制和安全检查：在请求到达上游服务器之前，使用 njs 进行细粒度的控制和检查。 操作响应标头：灵活地修改 HTTP 响应头，以满足特定的业务需求。 异步内容处理程序和过滤器：编写异步的内容处理逻辑，提高 Nginx 的处理能力。
基本 HTTP 示例
让我们通过一个简单的示例来感受 njs 的魅力。以下是一个基本的 HTTP 示例，展示了如何在 Nginx 中使用 njs 来返回一个简单的 "Hello world!" 响应。
njs 脚本（http.js）
function hello(r) {
r.return(200, "Hello world!");
}
export default {hello};
Nginx 配置
load_module modules/ngx_http_js_module.so;
events {}
http {
js_import http.js;
server {
listen 8000;
location / {
js_content http.hello;
}
}
}
通过上述配置，当访问 Nginx 的根目录时，njs 脚本将被触发，并返回 "Hello world!" 的响应。
njs 的高级功能
njs 不仅能处理基本的 HTTP 请求和响应，它还提供了一系列的高级功能，包括文件系统操作、异步处理、共享内存等。
文件系统操作
njs 提供了对文件系统的访问能力，使得在 Nginx 中进行文件操作成为可能。以下是一些常用的文件系统操作函数：
access()：检查文件的访问权限。open()：打开文件，支持同步和异步操作。readdir()：读取目录内容。realpath()：将相对路径转换为绝对路径。rename()：重命名文件或目录。unlink()：删除文件。rmdir()：删除目录，支持递归删除。stat()：获取文件状态信息。symlink()：创建符号链接。
异步处理
njs 支持异步操作，这对于处理 I/O 密集型任务非常有用，因为它不会阻塞 Nginx 的事件循环。
function asyncExample(r) {
// 异步读取文件
fs.promises.access('/path/to/file', fs.constants.R_OK).then(() => {
r.return(200, 'File is accessible');
}).catch(() => {
r.return(403, 'File is not accessible');
});
}
export default { asyncExample };
共享内存
njs 提供了共享内存的功能，允许多个 Nginx 工作进程之间共享数据。
// 设置共享内存区
function setSharedData(r) {
const shared = ngx.shared.my_shared_zone;
shared.set('key', 'value');
r.return(200, 'Data set in shared memory');
}
// 获取共享内存区的数据
function getSharedData(r) {
const shared = ngx.shared.my_shared_zone;
const value = shared.get('key');
r.return(200, value || 'No data found');
}
export default { setSharedData, getSharedData };
响应客户端
njs 提供了多种方式来响应客户端请求。
function respondExample(r) {
// 发送响应头
r.sendHeader();
// 发送响应体的一部分
r.send('Hello, ');
// 发送响应体的另一部分
r.send('world!');
// 完成响应
r.finish();
}
export default { respondExample };
日志记录
njs 允许你在 Nginx 的日志中记录不同级别的日志信息。
function logExample(r) {
// 记录普通日志
ngx.log(ngx.INFO, 'This is an info message.');
// 记录警告日志
ngx.log(ngx.WARN, 'This is a warning message.');
// 记录错误日志
ngx.log(ngx.ERR, 'This is an error message.');
r.return(200, 'Logged messages');
}
export default { logExample };
全局命名空间
njs 提供了 njs 和 ngx 两个全局命名空间，其中包含了许多有用的全局函数和变量。
function globalNamespaceExample(r) {
// 获取 njs 版本
njs.version; // '0.4.7'
// 写入 Nginx 日志
ngx.log(ngx.INFO, 'Using njs version: ' + njs.version);
// 访问共享内存
const shared = ngx.shared.my_shared_zone;
shared.set('key', 'value');
r.return(200, 'Global namespace example');
}
export default { globalNamespaceExample };
结语
通过这些代码示例，我们可以看到 njs 如何在 Nginx 中实现异步处理、共享内存、响应客户端请求、日志记录以及使用全局命名空间。这些高级功能使得 njs 成为一个强大的工具，可以极大地扩展 Nginx 的能力。
JavaScript 的力量不容小觑，它甚至已经渗透到了 Nginx 这样的服务器软件中。njs 为我们提供了一个强大的工具，让我们能够以全新的方式扩展 Nginx 的功能。
njs 的功能远不止于此，它的强大之处在于将 JavaScript 的灵活性与 Nginx 的高性能相结合。通过 njs，我们可以在 Nginx 中实现以前难以想象的功能，为 Web 服务器带来更多的可能性。
如果你对 njs 感兴趣，或者想要在你的项目中使用 njs，不妨深入研究这些高级功能。它们将为你打开一扇新的大门，让你的 Nginx 服务器变得更加强大和灵活。
