Kong网关之Lua-Nginx-Module指令介绍
1.Kong的运行机制
首先,lua-nginx-module
是在nginx启用的lua脚本功能。Kong
并没有使用带有lua-nginx-module模块的nginx进行编译运行,而是依赖OpenResty
,其中OpenResty
已经包含了lua-nginx-module
,并对nginx的功能进行许多的拓展。
因此,Kong
其实是一个lua程序,意在加载和执行lua模块(即所谓的插件
),并为其提供完成的开发环境,包括SDK,数据库抽象以及迁移等。插件也可以使用PDK
连接Kong核心或者其他组件进行交互。
在插件开发过程可以在Kong生命周期的各个切入点实现自定义逻辑。那么可以从Kong网关的配置文件(nginx-kong.conf
)可以发现一些端倪,Kong
的每个切入点其实都是对应某个lua-nginx-module
指令。
2.lua-nginx-module指令执行顺序
lua-nginx-module
各指令执行顺序如上图所示。
init_by_lua:初始化 nginx 和预加载 lua(nginx 启动和 reload 时执行);
init_worker_by_lua:每个工作进程(worker_processes)被创建时执行,用于启动一些定时任务, 比如心跳检查,后端服务的健康检查,定时拉取服务器配置等;
ssl_certificate_by_lua:对 https 请求的处理,即将启动下游 SSL(https)连接的 SSL 握手时执行,用例:按照每个请求设置 SSL 证书链和相应的私钥,按照 SSL 协议有选择的拒绝请求等;
set_by_lua:设置 nginx 变量;
rewrite_by_lua:重写请求(从原生 nginx 的 rewrite 阶段进入),执行内部 URL 重写或者外部重定向,典型的如伪静态化的 URL 重写;
access_by_lua:处理请求(和 rewrite_by_lua 可以实现相同的功能,从原生 nginx 的 access阶段进入);
content_by_lua:执行业务逻辑并产生响应,类似于 jsp 中的 servlet;
balancer_by_lua:负载均衡;
header_filter_by_lua:处理响应头;
body_filter_by_lua:处理响应体;
log_by_lua:记录访问日志;
最后,对以上顺序的理解有助于我们开发过程对请求和响应参数进行操作。