Nginx Lua编程

经过合理配置，Nginx毫无疑问是高性能Web服务器很好的选择。

除此之外，Nginx还具备可编程能力，理论上可以使用Nginx的扩展组件ngx_lua开发各种复杂的动态应用。不过，由于Lua是一种脚本动态语言，因此不太适合做复杂业务逻辑的程序开发。但是，在高并发场景下，Nginx Lua编程是解决性能问题的利器。

Nginx Lua编程的主要应用场景

Nginx Lua编程主要的应用场景如下：

（1）API网关：实现数据校验前置、请求过滤、API请求聚合、AB测试、灰度发布、降级、监控等功能，著名的开源网关Kong就是基于Nginx Lua开发的。

（2）高速缓存：可以对响应内容进行缓存，减少到后端的请求，从而提升性能。比如，Nginx Lua可以和Java容器（如Tomcat）、Redis整合，由Java容器进行业务处理和数据缓存，而Nginx负责读缓存并进行响应，从而解决Java容器的性能瓶颈。

（3）简单的动态Web应用：可以完成一些业务逻辑处理较少但是耗费CPU的简单应用，比如模板页面的渲染。一般的Nginx Lua页面渲染处理流程为：从Redis获取业务处理结果数据，从本地加载XML/HTML页面模板，然后进行页面渲染。

（4）网关限流：缓存、降级、限流是解决高并发的三大利器，Nginx内置了令牌限流的算法，但是对于分布式的限流场景，可以通过Nginx Lua编程定制自己的限流机制。

Nginx Lua编程简介

本节将简单介绍Nginx Lua编程的基础知识、Nginx Lua项目结构和启动方法。

 ngx_lua简介

Lua是一种轻量级、可嵌入式的脚本语言，可以非常容易地嵌入其他语言中使用。因为Lua的小巧轻量级，可以在Nginx中嵌入LuaVM（Lua虚拟机），请求时创建一个VM，请求结束时回收VM。

ngx_lua是Nginx的一个扩展模块，将Lua VM嵌入Nginx中，从而可以在Nginx内部运行Lua脚本，使得Nginx变成一个Web容器；这样开发人员就可以使用Lua语言开发高性能Web应用。ngx_lua提供了与Nginx交互的很多API，对于开发人员来说只需要学习这些API就可以进行功能开发，而对于开发Web应用来说，如果开发人员接触过Servlet，可以发现ngx_lua开发和Servlet类似，无外乎就是知道API的接收请求、参数解析、功能处理、返回响应这些内容。

使用ngx_lua开发Web应用时，有很多源码的Lua基础性模块可供使用，比如OpenResty就提供了一些常用的ngx_lua开发模块：

（1）lua-resty-memcached：通过Lua操作Memcached缓存。

（2）lua-resty-mysql：通过Lua操作MySQL数据库。

（3）lua-resty-redis：通过Lua操作Redis缓存。

（4）lua-resty-dns：通过Lua操作DNS域名服务器。

（5）lua-resty-limit-traffic：通过Lua进行限流。

（6）lua-resty-template：通过Lua进行模板的渲染。除了上述MySQL数据库操作、Redis操作、限流、模板渲染等常用功能组件外，还有很多第三方的ngx_lua组件（如lua-resty-jwt、lua-resty-kafka等），对于大部分应用场景来说，现在ngx_lua生态环境中的组件已经足够多了。如果仍然不满足自己的需求，那么可以开发自己的Lua模块。

Nginx Lua项目的创建

在开始Nginx Lua项目开发之前，首先需要搭建Lua的开发环境，具体的开发工具选择和环境搭建的教程可参考疯狂创客圈社群的视频“Nginx Lua开发环境搭建，带视频”。

在IDEA创建Lua脚本的工程。在工程类型选择时选择Lua项目类型，如图8-1所示。剩余的操作只要选择默认值，直到创建完成即可。

图8-1 在IDEA创建Lua脚本的工程

Lua项目的工程结构

创建Lua工程之后，这里规划一下工程目录，Lua项目的结构如图8-2所示。

图8-2 Lua项目的工程结构

图8-2所示的工程结构都处于工程的src目录下，包含两大部分内容：第一部分为Nginx的配置；第二部分为Lua脚本的目录结构。

第一部分Nginx的配置可以进一步细分，包含两块内容：

（1）Nginx的调试配置文件nginx-debug.conf。

（2）Nginx的调试日志目录。

第二部分是Lua脚本的目录结构。Lua脚本统一放在了src/luaScript（名称自己定）目录下，luaScript目录结构可以进一步细分，包含3块内容：

（1）src/luaScript/initial目录，用于存放Lua程序初始化时需要加载的其他Lua脚本，比如mobdebug.lua调试脚本。

（2）src/luaScript/module目录，用于存放业务模块的Lua脚本，比如helloworld.lua。

（3）src/luaScript/redis目录，用于存放操作Redis的一些公共方法的代码，比如分布式锁Lock.lua。这里仅仅以Redis为例说明：如果是一些耦合度较高的Lua模块，那么可以在src/luaScript目录下单独建一个子目录。

重要提示：Nginx调试时的配置文件nginx-debug.conf需要在src目录下，与Lua脚本的目录平级。为什么呢？在nginx-debug.conf中会应用到Lua脚本，使用的是相对路径，如果目录的相对位置不对，就会找不到Lua脚本。

下面是nginx-debug.conf的部分配置：

location /test {
 default_type 'text/html';
 charset utf-8;
 content_by_lua_file luaScript/test.lua;
 }
 location /helloworld {
 default_type 'text/html';
 charset utf-8;
 content_by_lua_file luaScript/module/demo/helloworld.lua;
}

在启动Nginx开始项目调试时，会将src目录作为启动的根目录。在这种场景下，如果nginx-debug.conf配置文件和luaScript不在同一个目录下，那么上面所配置的luaScript/test.lua和
luaScript/module/demo/helloworld.lua两个脚本都会找不到。

 Lua项目的启动

开始调试Lua项目的脚本之前，需要通过启动Nginx来执行Lua项目。但是，这里不使用默认的Nginx参数启动，而是使用-p参数和-c参数。启动和重启Lua项目，Nginx命令如下：

//启动Lua项目的命令
C:\dev\refer\LuaDemoProject\src> nginx -p ./ -c nginx-debug.conf
//在开发过程中，可能还会用到重启Lua项目的命令
C:\dev\refer\LuaDemoProject\src> nginx -p ./ -c nginx-debug.conf -s reload
//停止Lua项目的命令
C:\dev\refer\LuaDemoProject\src> nginx -p ./ -c nginx-debug.conf -s stop

可以通过第7章介绍的openresty-start.bat（在Linux下使用openresty-start.sh）脚本来启动Nginx，不过在启动之前需要调整一下其中的变量，具体脚本如下：

@echo off

rem启动标志flag=0，表示之前已经启动flag=1，现在立即启动set flag=0

rem设置openresty/Nginx的安装目录

set installPath=E:/tool/openresty-1.13.6.2-win32

rem设置Nginx项目的工作目录

set projectPath=C:/dev/refer/LuaDemoProject/src

rem设置项目的配置文件

set PROJECT_CONF=nginx-debug-demo.conf
echo installPath: %installPath%
echo project prefix path: %projectPath%
echo config file: %projectPath%/conf/%PROJECT_CONF%
echo openresty starting...

rem查找openresty/Nginx进程信息，然后设置flag标志位

tasklist|find /i "nginx.exe" > nul
if %errorlevel%==0 (
echo "OpenResty/Nginx already running ! "
rem exit /b
) else set flag=1
rem如果需要，就启动openresty/Nginx
cd /d %installPath%
if %flag%==1 (
start nginx.exe -p "%projectPath%" -c "%projectPath%/conf/%PROJECT_CONF%"
ping localhost -n 2 > nul
)

输出的进程信息rem输出openresty/Nginx的进程信息

tasklist /fi "imagename eq nginx.exe"
tasklist|find /i "nginx.exe" > nul
if %errorlevel%==0 (
echo "openresty/Nginx starting succeeded!"
)

需要修改的变量为projectPath和PROJECT_CONF，分别为项目的根目录和配置文件的名称。

在Nginx Lua项目开发过程中会涉及Lua脚本的调试，具体的调试工具和调试方法可参考疯狂创客圈社群的博文“Nginx Lua开发的调试工具和调试方法”。

本文给大家讲解的内容是Nginx/OpenResty详解，Nginx Lua编程，Nginx Lua编程简介

1. 下篇文章给大家讲解的是 Nginx/OpenResty详解，Nginx Lua编程，Lua开发基础；

2. 觉得文章不错的朋友可以转发此文关注小编；

3. 感谢大家的支持！