语法: rewrite_by_lua_file <path-to-lua-script-file>
环境: http, server, location, location if
阶段: rewrite tail
除了通过文件<path-to-lua-script-file>
的内容指定 Lua 代码外,该指令与rewrite_by_lua是等价的,该指令从v0.5.0rc32
开始支持Lua/LuaJIT bytecode的执行。
在<path-to-lua-script-file>
中可以使用 Nginx 的内置变量用来提高灵活性,然而这带有一定的风险,通常并不推荐使用。
当给定了一个相对路径如foo/bar.lua
,它将会被转换成绝对路径,前面增加的部分路径是 Nginx 服务启动时通过命令行选项-p PATH
决定的server prefix
。
当 Lua 代码缓存开启(默认),用户代码在第一次请求时完成加载(只有一次)并缓存,当 Lua 文件被修改时,每次都要对 Nginx 配置进行重新加载。Lua 代码缓存是可以暂时被禁用,通过开关lua_code_cache在nginx.conf
中设置为off
,这样就可以避免反复重新加载 Nginx。
rewrite_by_lua_file
代码将永远在 rewrite
请求处理阶段后面,除非rewrite_by_lua_no_postpone配置开启。
支持通过 Nginx 变量完成动态调度文件路径,就像 content_by_lua_file 一样。
English source:
syntax: rewrite_by_lua_file <path-to-lua-script-file>
context: http, server, location, location if
phase: rewrite tail
Equivalent to rewrite_by_lua, except that the file specified by <path-to-lua-script-file>
contains the Lua code, or, as from the v0.5.0rc32
release, the Lua/LuaJIT bytecode to be executed.
Nginx variables can be used in the <path-to-lua-script-file>
string to provide flexibility. This however carries some risks and is not ordinarily recommended.
When a relative path like foo/bar.lua
is given, they will be turned into the absolute path relative to the server prefix
path determined by the -p PATH
command-line option while starting the Nginx server.
When the Lua code cache is turned on (by default), the user code is loaded once at the first request and cached and the Nginx config must be reloaded each time the Lua source file is modified. The Lua code cache can be temporarily disabled during development by switching lua_code_cache off
in nginx.conf
to avoid reloading Nginx.
The rewrite_by_lua_file
code will always run at the end of the rewrite
request-processing phase unless rewrite_by_lua_no_postpone is turned on.
Nginx variables are supported in the file path for dynamic dispatch just as in content_by_lua_file.