OpenResty 是基于 Nginx + Lua高性能 Web 平台,能够方便搭建处理超高并发的动态 Web 应用、Web 服务和动态网关。例如有名的 Kong 网关和国产新秀 ApiSIX 网关都是基于 OpenResty 来进行打造的。

OpenResty 通过实现 ngx_lua 和 stream_lua 等 Nginx 模块,把 Lua/LuaJIT 完美地整合进了 Nginx,从而能够在 Nginx 内部里嵌入 Lua 脚本,用 Lua 语言来实现复杂的 HTTP/TCP/UDP 业务逻辑,同时依然保持着高度的并发服务能力。

Nginx处理阶段

一个正常的 Web 服务的生命周期可以分成三个阶段:

  1. initing:服务启动,读取配置文件,初始化内部数据结构
  2. running:服务运行,接受客户端的请求,返回响应结果
  3. exiting:服务停止,做一些必要的清理工作,如关闭监听端口

 

OpenResty 主要关注的是 initing 和 running 这两个阶段,并做了更细致的划分

OpenResty 的 initing 阶段

  • configuration:读取配置文件,解析配置指令,设置运行参数
  • master-initing:配置文件解析完毕,master进程初始化公用的数据
  • worker-initing:worker工作处理进程初始化自己专用的数据

 

OpenResty 的 running 阶段

在 running 阶段,收到客户端的请求后,OpenResty 对每个请求都会使用流水线处理:

  1. ssl:SSL/TLS 安全通信和验证
  2. preread:在正式处理之前预读数据,接收 HTTP 请求头
  3. rewrite:检查、改写 URI ,实现跳转重定向
  4. access:访问权限控制
  5. content:产生响应内容
  6. filter:对 content 阶段产生的内容进行过滤加工处理
  7. log:请求处理完毕,记录日志,或者其他的收尾工作。

 

OpenResty 执行程序

OpenResty 根据处理阶段提供了一些指令,在开发时使用它们就可以在这些阶段里面插入 Lua 代码,执行业务逻辑:

  • init_by_lua_file:master-initing 阶段,初始化全局配置或模块
  • init_worker_by_lua_file:worker-initing 阶段,初始化进程专用功能
  • ssl_certificate_by_lua_file:ssl 阶段,在握手时设置安全证书
  • set_by_lua_file:rewrite 阶段,改写 Nginx 变量
  • rewrite_by_lua_file:rewrite 阶段,改写 URI ,实现跳转或重定向
  • access_by_lua_file:access 阶段,访问控制或限速
  • content_by_lua_file:content 阶段,产生响应内容
  • balancer_by_lua_file:content 阶段,反向代理时选择后端服务器
  • header_filter_by_lua_file:filter 阶段,加工处理响应头
  • body_filter_by_lua_file:filter 阶段,加工处理响应体
  • log_by_lua_file:log 阶段,记录日志或其他的收尾工作

这些指令通常有三种形式:

  • xxx_by_lua:执行字符串形式的 Lua 代码:
  • xxx_by_lua_block:功能相同,但指令后是{ ...}的 Lua 代码块
  • xxx_by_lua_file:功能相同,但执行磁盘上的 Lua 源码文件。

推荐使用 xxx_by_lua_file,它彻底分离了配置文件与业务代码,让两者可以独立部署,而且文件形式也让我们更容易以模块的方式管理组织 Lua 程序。

 

OpenResty 指令所在的阶段和执行的先后顺序图

 

 

 

 

参考推荐:

OpenResty = Nginx + Lua 介绍和安装教程

OpenResty 使用 balancer_by_lua_block 做负载均衡