NGINX JavaScript (njs) 项目教程
2024-09-18 23:43:39作者:侯霆垣
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
- 创建一个 njs 脚本文件,例如
http.js
:
function hello(r) {
r.return(200, "Hello world\n");
}
export default { hello };
- 在 NGINX 配置文件中启用 njs 模块并指定脚本文件:
load_module modules/ngx_http_js_module.so;
events {}
http {
js_import http.js;
server {
listen 8000;
location / {
js_content http.hello;
}
}
}
- 启动或重新加载 NGINX:
sudo nginx -s reload
- 访问
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 的功能,还为开发者提供了丰富的工具和资源来构建复杂的应用。
热门项目推荐
- CangjieCommunity为仓颉编程语言开发者打造活跃、开放、高质量的社区环境Markdown6710
- redis-sdk仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。Cangjie32226
- Yi-CoderYi Coder 编程模型,小而强大的编程助手305
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTypeScript15.77 K1.48 K
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript76.1 K19.07 K
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript35.52 K4.79 K
- CommunityCangjie-TPC(Third Party Components)仓颉编程语言三方库社区资源汇总252
- Wwindows暂无简介Shell16.14 K1.35 K
- byzer-langByzer(以前的 MLSQL):一种用于数据管道、分析和人工智能的低代码开源编程语言。Scala1.88 K551
- AanacondaAnaconda turns your Sublime Text 3 in a full featured Python development IDE including autocompletion, code linting, IDE features, autopep8 formating, McCabe complexity checker Vagrant and Docker support for Sublime Text 3 using Jedi, PyFlakes, pep8, MyPy, PyLint, pep257 and McCabe that will never freeze your Sublime Text 3Python2.22 K263
热门内容推荐
展开
项目优选
收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
7
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K