lua_use_default_type
lua_code_cache
lua_regex_cache_max_entries
header_filter_by_lua
ngx.headers_sent
### Nginx ngx_lua 模块原理与内置函数详解
#### 概述
Nginx 是一款高性能的 HTTP 和反向代理 Web 服务器，而 ngx_lua 模块则是 Nginx 的一个强大扩展，它允许在 Nginx 中直接嵌入 Lua 脚本进行动态内容处理和请求/响应的修改。这种集成不仅提高了 Nginx 的灵活性，还极大地增强了其实时处理能力。
#### ngx_lua 模块原理
1. **工作进程与 LuaVM：**
- 每个 Nginx worker 进程都会创建一个 Lua 虚拟机 (LuaVM)，该 VM 在整个 worker 的生命周期内都是共享的。
- 这种设计可以减少每次请求时创建和销毁虚拟机的开销，提高性能。
2. **Nginx I/O 原语封装：**
- ngx_lua 模块将 Nginx 的 I/O 操作进行了封装，使得 Lua 代码可以直接调用这些封装后的函数来访问底层的 I/O 操作。
- 这种封装简化了 Lua 开发者的工作，让他们能够更容易地实现复杂的 I/O 逻辑。
3. **协程处理：**
- 每个外部请求都被分配给一个 Lua 协程进行处理，这有助于确保每个请求的数据独立且不会相互干扰。
- 当 Lua 代码调用 I/O 操作或其他异步接口时，当前的协程会被挂起，从而避免阻塞整个 worker 进程。
- 当 I/O 操作完成时，相关协程的上下文数据被还原，协程得以继续执行。
#### 内置指令与 API
以下是一些关键的 ngx_lua 内置指令及其说明：
- **lua_use_default_type：**
- 控制是否使用 `default_type` 指令定义的 Content-Type 默认值。这对于定制化响应类型非常有用。
- **lua_code_cache：**
- 控制 `_by_lua_file` 文件中的 Lua 代码是否缓存。缓存可以显著提高性能，但可能会导致开发阶段代码更新后的延迟生效问题。
- **lua_regex_cache_max_entries：**
- 设置正则表达式缓存的最大条目数。合理的配置可以平衡内存占用与正则匹配性能。
- **lua_package_path / lua_package_cpath：**
- 分别指定 Lua 外部库的路径（`.lua` 文件）和 C 编写的 Lua 外部库路径（`.so` 文件）。这允许开发者轻松地加载自定义的 Lua 库或第三方库。
- **init_by_lua / init_by_lua_file / init_worker_by_lua / init_worker_by_lua_file：**
- 这些指令允许在 Nginx 启动时执行 Lua 代码。`init_by_lua` 和 `init_worker_by_lua` 分别在 master 进程和 worker 进程启动时执行，而 `_by_lua_file` 版本则通过指定文件来加载 Lua 代码。
- 这些指令特别适合用于初始化环境、设置全局变量或注册定时器等。
- **set_by_lua / set_by_lua_file：**
- 用于设置变量，通常在配置上下文中使用，例如设置 cookie 或环境变量。
- **content_by_lua / content_by_lua_file：**
- 定义如何处理响应主体。`content_by_lua` 和 `content_by_lua_file` 分别允许通过内联 Lua 代码或外部文件来定义响应主体的生成逻辑。
- **rewrite_by_lua / rewrite_by_lua_file / access_by_lua / access_by_lua_file / header_filter_by_lua / header_filter_by_lua_file / body_filter_by_lua / body_filter_by_lua_file：**
- 这些指令用于处理请求重写、访问控制、响应头过滤以及响应体过滤等。
- 例如，`header_filter_by_lua` 允许开发者在发送响应头之前对其进行修改，这对于添加或删除特定的响应头非常有用。
- **log_by_lua / log_by_lua_file：**
- 定义如何记录日志。这些指令可以方便地定制日志记录逻辑，如根据不同的条件记录不同的信息。
- **lua_need_request_body / lua_shared_dict / lua_socket_*：**
- `lua_need_request_body` 控制是否需要读取请求体，这对于处理 POST 请求尤为重要。
- `lua_shared_dict` 创建全局共享表，多个 worker 进程间可以共享数据。
- `lua_socket_*` 一系列与网络套接字相关的配置，如超时时间和缓冲区大小等，这些指令有助于优化网络通信性能。
- **API 介绍：**
- **ngx.arg**：表示指令参数，例如跟在 `content_by_lua_file` 后面的参数。
- **ngx.var**：变量，可以通过 `ngx.var.VARIABLE` 引用来访问某个变量。
- **ngx.ctx**：请求的 Lua 上下文，用于存储请求相关的数据。
- **ngx.header**：响应头，可以通过 `ngx.header.HEADER` 来引用和修改响应头。
- **ngx.status**：响应码。
- **API 函数**：`ngx.log` 用于输出到 error.log；`print` 等价于 `ngx.log(ngx.NOTICE,)`；`ngx.send_headers` 用于发送响应头；`ngx.headers_sent` 判断响应头是否已发送；`ngx.resp.get_headers` 获取响应头；`ngx.timer.at` 注册定时器事件。
通过深入了解这些内置指令和 API 的功能，开发者可以更高效地利用 ngx_lua 模块来构建高度定制化的应用和服务。
