大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!
高级前端进阶
今天给大家带来的主题是 njs,即 Javascript 在 nginx中的扩展。话不多说,直接开始!
1.什么是 njsnjs 是允许扩展 nginx 功能的 JavaScript/ECMAScript 语言的子集,实现了大部分的 JavaScript 语言功能,同时抛弃了 JavaScript 比较难懂的部分。 njs 是根据 ECMAScript 5.1(严格模式)创建的,带有一些 ECMAScript 6 和更高版本的扩展。
njs 是以 nginx 插件的方式存在,没有通过 V8 引擎实现,而是通过一个更小、能耗更低、更符合 nginx 应用场景的小型虚拟机,可以理解成 nginx 为其实现了一套自己的词法解析。
作为 nginx 的插件,njs 的安装方式是重新编译 nginx。
目前 njs 在 Github 有超过 700 的star、100 的fork、20 的代码贡献者,是一个值得关注的 JavaScript 扩展项目。
2.njs典型场景njs的典型用例包括:
- 在请求到达上游服务器之前,njs 中的复杂访问控制和安全检查
- 操纵响应头
- 编写灵活的异步内容处理程序和过滤器
比如下面的例子修改或删除上游服务器发送的cookies [http/response/modify_set_cookie]:
// nginx.conf配置
http {
js_path "/etc/nginx/njs/";
js_import main from http/response/modify_set_cookie.js;
// js_import 语法
server {
listen 80;
location /modify_cookies {
// 头部修改
js_header_filter main.cookies_filter;
proxy_pass http://localhost:8080;
}
}
server {
listen 8080;
location /modify_cookies {
add_header Set-Cookie "XXXXXX";
add_header Set-Cookie "BB";
add_header Set-Cookie "YYYYYYY";
return 200;
}
}
}
下面是example.js内容:
function cookies_filter(r) {
var cookies = r.headersOut['Set-Cookie'];
// 修改Set-Cookie头
r.headersOut['Set-Cookie'] = cookies.filter(v=>v.length > Number(r.args.len));
}
export default {cookies_filter};
可以通过如下的代码进行检测:
curl http://localhost/modify_cookies?len=1 -v
...
< Set-Cookie: XXXXXX
< Set-Cookie: BB
< Set-Cookie: YYYYYYY
curl http://localhost/modify_cookies?len=3 -v
...
< Set-Cookie: XXXXXX
< Set-Cookie: YYYYYYY
更多关于 njs 的用法示例可以参考文末资料。
3.njs的基本 HTTP 示例可以按照以下步骤在 nginx 中使用 njs:
安装 njs 脚本语言load_module modules/ngx_http_js_module.so;
// 或者
load_module modules/ngx_stream_js_module.so;
创建一个 njs 脚本文件
例如下面的 http.js 内容:
function hello(r) {
r.return(200, "Hello world!");
}
export default {hello};
启用 ngx_http_js_module 模块
在 nginx.conf 文件中,启用 ngx_http_js_module 模块并使用 http.js 脚本文件指定 js_import 指令:
load_module modules/ngx_http_js_module.so;
events {}
http {
js_import http.js;
// 导入http.js
server {
listen 8000;
location / {
js_content http.hello;
}
}
还有一个独立的命令行实用程序(文末参考资料),可以独立于 nginx 用于 njs 开发和调试。
4.本文总结ngx_http_js_module 模块:用于在 njs 中实现位置和变量处理程序,详情查看:https://nginx.org/en/docs/http/ngx_http_js_module.html
本文主要和大家介绍 njs,即 JavaScript 在 nginx 中的扩展。关于njs,文章并没有过多展开,如果有兴趣,可以在我的主页继续阅读,同时文末的参考资料提供了大量优秀文档以供学习。最后,欢迎大家点赞、评论、转发、收藏!
参考资料https://nginx.org/en/docs/njs/cli.html
https://www.oschina.net/news/236311/njs-0-7-12-released
https://github.com/nginx/njs
https://github.com/nginx/njs-examples/#modifying-response(NGINX JavaScript 更多用法示例)
https://www.nginx.com/blog/tag/nginx-javascript-module/(nginx官方更多博文)