执行阶段概念

OpenResty 处理一个请求，它的处理流程请参考下图（从 Request start 开始）：

openresty_phases

我们在这里做个测试，示例代码如下：

  1. location /mixed {
  2.     set_by_lua_block $a {
  3.         ngx.log(ngx.ERR, "set_by_lua*")
  4.     }
  5.     rewrite_by_lua_block {
  6.         ngx.log(ngx.ERR, "rewrite_by_lua*")
  7.     }
  8.     access_by_lua_block {
  9.         ngx.log(ngx.ERR, "access_by_lua*")
  10.     }
  11.     content_by_lua_block {
  12.         ngx.log(ngx.ERR, "content_by_lua*")
  13.     }
  14.     header_filter_by_lua_block {
  15.         ngx.log(ngx.ERR, "header_filter_by_lua*")
  16.     }
  17.     body_filter_by_lua_block {
  18.         ngx.log(ngx.ERR, "body_filter_by_lua*")
  19.     }
  20.     log_by_lua_block {
  21.         ngx.log(ngx.ERR, "log_by_lua*")
  22.     }
  23. }

执行结果日志(截取了一下)：

  1. set_by_lua*
  2. rewrite_by_lua*
  3. access_by_lua*
  4. content_by_lua*
  5. header_filter_by_lua*
  6. body_filter_by_lua*
  7. log_by_lua*

这几个阶段的存在，应该是 OpenResty 不同于其他多数 Web 平台编程的最明显特征了。由于 Nginx 把一个请求分成了很多阶段，这样第三方模块就可以根据自己行为，挂载到不同阶段进行处理达到目的。OpenResty 也应用了同样的特性。所不同的是，OpenResty 挂载的是我们编写的 Lua 代码。

这样我们就可以根据我们的需要，在不同的阶段直接完成大部分典型处理了。

  • set_by_lua*: 流程分支处理判断变量初始化
  • rewrite_by_lua*: 转发、重定向、缓存等功能(例如特定请求代理到外网)
  • access_by_lua*: IP 准入、接口权限等情况集中处理(例如配合 iptables 完成简单防火墙)
  • content_by_lua*: 内容生成
  • header_filter_by_lua*: 响应头部过滤处理(例如添加头部信息)
  • body_filter_by_lua*: 响应体过滤处理(例如完成应答内容统一成大写)
  • log_by_lua*: 会话完成后本地异步完成日志记录(日志可以记录在本地，还可以同步到其他机器)

实际上我们只使用其中一个阶段 content_by_lua*，也可以完成所有的处理。但这样做，会让我们的代码比较臃肿，越到后期越发难以维护。把我们的逻辑放在不同阶段，分工明确，代码独立，后期发力可以有很多有意思的玩法。

举一个例子，如果在最开始的开发中，请求体和响应体都是通过 HTTP 明文传输，后面需要使用 AES 加密，利用不同的执行阶段，我们可以非常简单的实现：

  1. # 明文协议版本
  2. location /mixed {
  3.     content_by_lua_file ...;       # 请求处理
  4. }
  6. # 加密协议版本
  7. location /mixed {
  8.     access_by_lua_file ...;        # 请求加密解码
  9.     content_by_lua_file ...;       # 请求处理，不需要关心通信协议
  10.     body_filter_by_lua_file ...;   # 应答加密编码
  11. }

内容处理部分都是在 content_by_lua* 阶段完成，第一版本 API 接口开发都是基于明文。为了传输体积、安全等要求，我们设计了支持压缩、加密的密文协议(上下行)，痛点就来了，我们要更改所有 API 的入口、出口么？

最后我们是在 access_by_lua* 完成密文协议解码，body_filter_by_lua* 完成应答加密编码。如此一来世界都宁静了，我们没有更改已实现功能的一行代码，只是利用 OpenResty 的阶段处理特性，非常优雅的解决了这个问题。

不同的阶段，有不同的处理行为，这是 OpenResty 的一大特色。学会它，适应它，会给你打开新的一扇门。这些东西不是 OpenResty 自身所创，而是 Nginx module 对外开放的处理阶段。理解了它，也能更好的理解 Nginx 的设计思维。