js_import

`js_import` 指令通过允许导入 NJS 脚本,将 JavaScript 模块集成到 NGINX 配置中。

语法js_import string; | js_import string string string;
默认值none
上下文stream, stream server
参数1 or 3

说明

js_import 指令是 NGINX 的 JavaScript (NJS) 模块中的一项强大功能,允许用户将 JavaScript 文件和模块直接导入到他们的 NGINX 配置中。该指令便于重用 JavaScript 函数,使得在处理请求处理、过滤和响应处理等各种 Web 服务器任务时可以采用模块化设计。它支持一或三个参数,根据用例提供灵活的配置。

在指定该指令时,用户可以使用单个参数导入单个 JavaScript 文件,或者用三个参数提供 JavaScript 文件名、可选的模块别名以及在导入时要调用的函数。此功能对于将较大的应用程序组织成可管理的单元尤其有用,同时遵循代码重用原则。js_import 指令的行为确保导入的函数可以在配置中被引用,使脚本具有动态性和强大功能。

js_import 的工作方式与 NJS 的现有功能紧密相关,NJS 用于使用 JavaScript 语法扩展 NGINX 的能力。因此,导入的脚本可以利用 NJS 的全部功能范围,包括对 ECMAScript 5.1 及更高版本构造的支持,为脚本化 NGINX 操作提供丰富且现代的能力。

配置示例

js_import my_script.js;

# or with parameters:
js_import my_script.js my_module myFunction;

确保 JavaScript 文件路径相对于 NGINX 配置目录是正确的。

如果使用多个 imports,请注意 functions 或 variables 之间的命名冲突。

检查 JavaScript 语法错误,因为它们可能导致 NGINX 重载失败。

← 返回所有指令