高性能网关基石—

什么是 OpenResty

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

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

处理阶段

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

initing：服务启动，读取配置文件，初始化内部数据结构
running：服务运行，接受客户端的请求，返回响应结果
exiting：服务停止，做一些必要的清理工作

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

OpenResty 的 initing 阶段

configuration：读取配置文件，解析配置指令，设置运行参数
master-initing：配置文件解析完毕，master 进程初始化公用的数据
worker-initing：worker 进程初始化自己专用的数据

OpenResty 的 running 阶段

收到客户端的请求后，OpenResty 对每个请求都会使用下面这条流水线进行处理：

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

OpenResty 处理阶段

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，它彻底分离了配置文件与业务代码，让两者可以独立部署。

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

OpenResty 执行流程

Demo 编写

为了能够直观地看到上面的处理阶段，编写一个 OpenResty 的小 demo。先验证安装成功：

sudo openresty -v
# nginx version: openresty/1.21.4.1

创建目录结构：

mkdir testresty &&
cd testresty &&
mkdir logs conf service &&
cd logs && touch error.log && touch access.log

├── conf
├── logs
│   ├── access.log
│   └── error.log
└── service

在 service 文件夹下创建每个阶段的 Lua 脚本，每个脚本只打印一条日志：

rewrite.lua

ngx.log(ngx.ALERT,"this is rewrite")

access.lua

ngx.log(ngx.ALERT,"this is access")

content.lua

ngx.log(ngx.ALERT,"this is content")
ngx.say('hello world')

header_filter.lua

ngx.log(ngx.ALERT,"this is header_filter")

body_filter.lua

ngx.log(ngx.ALERT,"this is body_filter")

log.lua

ngx.log(ngx.ALERT,"this is log")

在 conf 文件夹下创建 nginx.conf：

user root;
worker_processes 1;
events {
    worker_connections 512;
}

http {
    server {
        listen 80;

        location / {
            rewrite_by_lua_file service/rewrite.lua;
            access_by_lua_file service/access.lua;
            content_by_lua_file service/content.lua;
            header_filter_by_lua_file service/header_filter.lua;
            body_filter_by_lua_file service/body_filter.lua;
            log_by_lua_file service/log.lua;
        }
    }
}

启动 OpenResty：

sudo openresty -p $HOME/testresty

用浏览器访问 http://localhost，可以看到 hello world。打开 logs/error.log，可以看到每个阶段的执行顺序：

2022/12/26 15:59:26 [alert] ... [lua] rewrite.lua:1: this is rewrite ...
2022/12/26 15:59:26 [alert] ... [lua] access.lua:1: this is access ...
2022/12/26 15:59:26 [alert] ... [lua] content.lua:1: this is content ...
2022/12/26 15:59:26 [alert] ... [lua] header_filter.lua:1: this is header_filter ...
2022/12/26 15:59:26 [alert] ... [lua] body_filter.lua:1: this is body_filter ...
2022/12/26 15:59:26 [alert] ... [lua] body_filter.lua:1: this is body_filter ...
2022/12/26 15:59:26 [alert] ... [lua] log.lua:1: this is log ...

通过日志可以观察到每个阶段的执行顺序。

高性能网关基石——OpenResty