当 Nginx 标准模块和配置不能灵活地适应系统要求时,就可以考虑使用 Lua 扩展和定制 Nginx 服务。OpenResty 集成了大量精良的 Lua 库、第三方模块,可以方便地搭建能够处理超高并发、扩展性极高的 Web 服务,所以这里选择 OpenResty 提供的 lua-nginx-module 方案。
安装Lua环境
lua-nginx-module 依赖于 LuaJIT 和 ngx_devel_kit。LuaJIT 需要安装,ngx_devel_kit 只需下载源码包,在 Nginx 编译时指定 ngx_devel_kit 目录。
系统依赖库
首先确保系统已安装如下依赖库。
yum install readline-devel pcre-devel openssl-devel gcc |
安装LuaJIT
首先,安装 LuaJIT 环境,如下所示:
wget http://luajit.org/download/LuaJIT-2.0.5.tar.gz |
设置 LuaJIT 有关的环境变量。
export LUAJIT_LIB=/usr/local/lib |
下载相关模块
下载 ngx_devel_kit 源码包,如下:
wget https://github.com/simpl/ngx_devel_kit/archive/v0.3.0.tar.gz |
接下来,下载 Lua 模块 lua-nginx-module 源码包,为 Nginx 编译作准备。
wget https://github.com/openresty/lua-nginx-module/archive/v0.10.10.tar.gz |
加载Lua模块
Nginx 1.9 版本后可以动态加载模块,但这里由于版本太低只能重新编译安装 Nginx。下载 Nginx 源码包并解压:
wget http://nginx.org/download/nginx-1.13.5.tar.gz |
编译并重新安装 Nginx:
cd nginx-1.13.5 |
配置Nginx环境
现在只需配置 Nginx,即可嵌入 Lua 脚本。首先,在 http 部分配置 Lua 模块和第三方库路径:
# 第三方库(cjson)地址luajit-2.0/lib |
接着,配置一个 Lua 脚本服务:
# hello world测试 |
测试安装和配置是否正常:
service nginx test |
Lua调用Nginx
lua-nginx-module 模块中已经为 Lua 提供了丰富的 Nginx 调用 API,每个 API 都有各自的作用环境,详细描述见 Nginx API for Lua。这里只列举基本 API 的使用 。
先配一个 Lua 脚本服务,配置文件如下:
location ~ /lua_api { |
请求部分
可以通过ngx.var.var_name
形式获取或设置 Nginx 变量值,例如 request_uri、host、request 等。
-- ngx.say打印内容 |
该方法会以表的形式返回当前请求的头信息。查看请求的头信息:
ngx.say('Host : ', ngx.req.get_headers().host, '<br>') |
当然,通过 ngx.req.set_header() 也可以设置头信息。
ngx.req.set_header("Content-Type", "text/html") |
该方法以表形式返回当前请求的所有 GET 参数。查看请求 query 为?name=fhb
的 GET 参数:
ngx.say('name : ', ngx.req.get_uri_args().name, '<br>') |
同样,可以通过 ngx.req.set_uri_args() 设置请求的所有 GET 参数。
ngx.req.set_uri_args({name='fhb'}) --{name='fhb'}可以为query形式name=fhb |
该方法以表形式返回当前请求的所有 POST 参数,POST 数据必须是 application/x-www-form-urlencoded 类型。查看请求curl --data 'name=fhb' localhost/lua_api
的 POST 参数:
--必须先读取body体 |
通过 ngx.req.get_body_data() 方法可以获取未解析的请求 body 体内容字符串。
获取请求的大写字母形式的请求方式,通过 ngx.req.set_method() 可以设置请求方式。例如:
ngx.say(ngx.req.get_method()) |
响应部分
通过ngx.header.header_name
的形式获取或设置响应头信息。如下:
ngx.say(ngx.header.content_type) |
ngx.print() 方法会填充指定内容到响应 body 中。如下所示:
ngx.print(ngx.header.content_type) |
如上述使用,ngx.say() 方法同 ngx.print() 方法,只是会在后追加一个换行符。
以某个状态码返回响应内容,状态码常量对应关系见 HTTP status constants 部分,也支持数字形式的状态码。
ngx.exit(403) |
重定向当前请求到新的 url,响应状态码可选列表为 301、302(默认)、303、307。
ngx.redirect('http://www.fanhaobai.com') |
其他
该方法提供了正则表达式匹配方法。请求?name=fhb&age=24
匹配 GET 参数中的数字:
local m, err = ngx.re.match(ngx.req.set_uri_args, "[0-9]+") |
通过该方法可以将内容写入 Nginx 日志文件,日志文件级别需同 log 级别一致。
- ngx.md5() | ngx.encode_base64() | ngx.decode_base64()
它们都是字符串编码方式。ngx.md5() 可以对字符串进行 md5 加密处理,而 ngx.encode_base64() 是对字符串 base64 编码, ngx.decode_base64() 为 base64 解码。
Nginx中嵌入Lua
上面讲述了怎么在 Lua 中调用 Nginx 的 API 来扩展或定制 Nginx 的功能,那么编写好的 Lua 脚本怎么在 Nginx 中得到执行呢?其实,Nginx 是通过模块指令形式在其 11 个处理阶段做插入式处理,指令覆盖 http、server、server if、location、location if 这几个范围。
模块指令列表
这里只列举基本的 Lua 模块指令,更多信息参考 Directives 部分。
指令 | 所在阶段 | 使用范围 | 说明 |
---|---|---|---|
init_by_lua init_by_lua_file |
加载配置文件 | http | 可以用于初始化全局配置 |
set_by_lua set_by_lua_file |
rewrite | server location location if |
复杂逻辑的变量赋值,注意是阻塞的 |
rewrite_by_lua rewrite_by_lua_file |
rewrite | http server location location if |
实现复杂逻辑的转发或重定向 |
content_by_lua content_by_lua_file |
content | location location if |
处理请求并输出响应 |
header_filter_by_lua header_filter_by_lua_file |
响应头信息过滤 | http server location location if |
设置响应头信息 |
body_filter_by_lua body_filter_by_lua_file |
输出过滤 | http server location location if |
对输出进行过滤或修改 |
使用指令
注意到,每个指令都会有*_lua
和*_lua_file
两个指令,*_lua
指令后为 Lua 代码块,而*_lua_file
指令后为 Lua 脚本文件路径。下面将只对*_lua
指令进行说明。
- init_by_lua
该指令会在 Nginx 的 Master 进程加载配置时执行,所以可以完成 Lua 模块初始化工作,Worker 进程同样会继承这些。
nginx.conf
配置文件中的 http 部分添加如下代码:
-- 所有worker共享的全局变量 |
init.lua
初始化脚本为:
local cjson = require 'cjson' |
- set_by_lua
我们直接使用 set 指令很难实现很复杂的变量赋值逻辑,而 set_by_lua 模块指令就可以解决这个问题。
nginx.conf
配置文件 location 部分内容为:
location /lua { |
set.lua
脚本内容为:
local uri_args = ngx.req.get_uri_args() |
上述赋值逻辑,请求 query 为?a=10&b=2
时响应内容为 12。
- rewrite_by_lua
可以实现内部 URL 重写或者外部重定向。nginx.conf
配置如下:
location /lua { |
rewrite.lua
脚本内容:
if ngx.req.get_uri_args()["type"] == "app" then |
- access_by_lua
用于访问权限控制。例如,只允许带有身份标识用户访问,nginx.conf
配置为:
location /lua { |
access.lua
脚本内容为:
if ngx.req.get_uri_args()["token"] == "fanhb" then |
- content_by_lua
该指令在 Lua 调用 Nginx 部分已经使用过了,用于输出响应内容。
案例
访问权限控制
使用 Lua 模块对本站的 ES 服务做受信操作控制,即非受信 IP 只能查询操作。nginx.conf
配置如下:
location / { |
访问频率控制
在 Nginx 配置文件的 location 部分配置 Lua 脚本基本参数,并配置 Lua 模块指令:
default_type "text/html"; |
Lua 脚本实现频率控制逻辑,使用 Redis 对单位时间内的访问次数做缓存,key 为访问 uri 拼接 token 后的 md5 值。具体内容如下:
local redis = require "resty.redis" |
相关文章 »
- 进入Lua的世界 (2017-09-03)
- Lua在Redis的应用 (2017-09-04)