在NGINX中使用Lua进行开发时,可以通过不同的配置块来指定Lua脚本的执行位置。这些配置块被称为"phase hooks",即阶段挂钩。每个阶段挂钩都有其特定的作用时间和目的。以下是NGINX Lua模块中常见的配置指令及其用途:
常见的Phase Hooks
1.access_by_lua 或 access_by_lua_file
- 作用阶段:访问控制阶段(Access Phase)
- 用途:用于在请求到达服务器之前执行Lua脚本,主要用于访问控制、身份验证等。
- 示例
Lua
access_by_lua_file /path/to/do_access.lua;
2.rewrite_by_lua 或 rewrite_by_lua_file
- 作用阶段:重写阶段(Rewrite Phase)
- 用途:用于在重写规则应用之前执行Lua脚本,可以用来修改请求URI或其他请求头。
- 示例
Lua
rewrite_by_lua_file /path/to/do_rewrite.lua;
3.content_by_lua 或 content_by_lua_file
-
作用阶段:内容处理阶段(Content Phase)
-
用途:用于在请求处理完成后执行Lua脚本,可以用来生成或修改响应内容。
-
示例
Luacontent_by_lua_file /path/to/do_content.lua;
4.header_filter_by_lua 或 header_filter_by_lua_file
-
作用阶段:头部过滤阶段(Header Filter Phase)
-
用途:用于在响应头部构造完成后,但发送给客户端之前执行Lua脚本,可以用来修改响应头。
-
示例
Luaheader_filter_by_lua_file /path/to/do_header.lua;
5.body_filter_by_lua 或 body_filter_by_lua_file
-
作用阶段:主体过滤阶段(Body Filter Phase)
-
用途:用于在响应体生成后逐块执行Lua脚本,可以用来修改响应体。
-
示例
Luabody_filter_by_lua_file /path/to/do_body.lua;
6.log_by_lua 或 log_by_lua_file
-
作用阶段:日志记录阶段(Log Phase)
-
用途:用于在请求完全处理完毕后执行Lua脚本,通常用来进行日志记录或统计分析。
-
示例
Lualog_by_lua_file /path/to/do_log.lua;
其他相关的Lua配置指令
1.lua_need_request_body
-
用途:告诉NGINX需要等待请求体全部接收后再执行Lua脚本。
-
示例
Lualua_need_request_body on;
2.lua_store_access_log
-
用途:启用或禁用Lua脚本对访问日志的访问。
-
示例
Lualua_store_access_log off;
3.lua_shared_dict
-
用途:定义共享内存区,供Lua脚本之间共享数据。
-
示例
Lualua_shared_dict my_data 1m;
4.lua_set_header
-
用途:设置响应头。
-
示例
Lualua_set_header "X-Custom-Header" "value";
5.lua_set_var
-
用途:设置变量。
-
示例
Lualua_set_var $my_var "value";