使用javascript轻松扩展nginx的功能

njs是 nginx 官方推出的一个基于 JavaScript 的扩展，启用后可以通过 javascript 脚本来扩展 nginx 功能。安装完成njs模块即可使用njs的相关指令导入和运行js代码实现相关功能了。

一、安装njs模块

njs模块有两种安装方式：包管理器安装和源码编译安装。这里都以Ubuntu22.04LTS版本为例。

1.1、包管理器安装

包管理器安装比较省事，不用操心软件包之间的依赖。但是直接apt install nginx的话，安装的版本比较旧，是1.18.0版本，而不是前最新稳定版1.24.0，而且还没有njs模块可安装。所以必须要按照nginx官网的说明文档先添加nginx的apt源。

# 添加apt源，见：http://nginx.org/en/linux_packages.html#Ubuntu
sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring
curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
echo -e "Package: *\nPin: origin nginx.org\nPin: release o=nginx\nPin-Priority: 900\n" | sudo tee /etc/apt/preferences.d/99nginx
sudo apt update
# 安装nginx和njs模块
sudo apt install nginx
sudo apt install nginx-module-njs
# 修改配置文件，加载模块，在events之前加一行：load_module modules/ngx_stream_js_module.so;
sudo vi /etc/nginx/nginx.conf

1.2、源码编译安装

这njs模块并不能简单的通过configure --with参数添加，需要单独下载源码构建才行。

# 安装源码管理工具mercurial
sudo apt install mercurial
# 下载源码，会自动在当前目录下创建njs目录
hg clone http://hg.nginx.org/njs
# 安装编译所需的软件包
sudo apt install gcc libpcre3-dev zlib1g zlib1g-dev libssl-dev make libxslt1-dev
# 配置和构建，添加--add-module参数
./configure --prefix=/usr/local/nginx --with-http_gzip_static_module --with-http_realip_module --with-stream --with-http_ssl_module --with-http_v2_module --add-module=/home/user/njs/nginx
make && sudo make install

二、在Nginx当中运行javascript代码

假定目标是处理rtsp推流预读，将rtsp的url记录到日志，可以编写js代码/etc/nginx/njs/rtsp_log.js，内容如下：

function onpreread(s) {
    s.on("upload", function(data, flags){
        var _idx, _str;
        if(data != null && (_idx = data.indexOf("\r\n")) > 0) {
            _str = data.substr(0, _idx);
            if(_str.substr(0, 8) == "OPTIONS ") {
                s.variables.rtsp_preread_url = _str.substr(8);
                s.allow();
                return;
            }
            s.deny();
        }
    });
}
export default {onpreread};

修改nginx配置文件/etc/nginx/nginx.conf，增加如下配置

stream {
    # 定义一个nginx的全局变量，可通过js代码读写
    js_var $rtsp_preread_url;
    # 导入js代码，并处理预读，记录到变量
    js_import rtsp from njs/rtsp_log.js;
    js_preread rtsp.onpreread;
    # 将预读的结果(变量$rtsp_preread_url)记录到日志
    log_format basic '$remote_addr:$remote_port [$time_local] $protocol '
    '$server_port $rtsp_preread_url '
    '$status $bytes_received $bytes_sent $session_time';
    access_log /var/log/nginx/stream-access.log basic buffer=32k;

    server {
        listen 10554;
        proxy_pass 127.0.0.1:554; # 转发给rtsp流媒体服务器
    }
}

重启nginx，rtsp推流一下，再次重启nginx（日志量不够32k，不重启不会写到磁盘）再查看日志文件，可看到如下日志：

192.168.1.102:55382 [23/Sep/2023:06:47:41 +0000] TCP 10554 rtsp://***:554/live/demostream RTSP/1.0 200 902 1044 8.544