浅谈 OpenResty Nginx+LUA

墨蓝 2022-05-14 14:53 301阅读 0赞

from：[https://blog.csdn.net/yhclt/article/details/79309237][https_blog.csdn.net_yhclt_article_details_79309237]

**一．前言**

我们都知道Nginx有很多的特性和好处，但是在Nginx上开发成了一个难题，Nginx模块需要用C开发，而且必须符合一系列复杂的规则，最重要的用C开发模块必须要熟悉Nginx的源代码，使得开发者对其望而生畏。为了开发人员方便，所以接下来我们要介绍一种整合了Nginx和lua的框架，那就是OpenResty，它帮我们实现了可以用lua的规范开发，实现各种业务，并且帮我们弄清楚各个模块的编译顺序。关于OpenResty，我想大家应该不再陌生，随着系统架构的不断升级、优化，OpenResty在被广泛的应用。

**二．OpenResty运行原理**

Nginx 采用的是 master-worker 模型，一个 master 进程管理多个 worker 进程，基本的事件处理都是放在 woker 中，master 负责一些全局初始化，以及对 worker 的管理。在OpenResty中，每个 woker 使用一个 LuaVM，当请求被分配到 woker 时，将在这个 LuaVM 里创建一个 coroutine(协程)。协程之间数据隔离，每个协程具有独立的全局变量\_G。

ps. 协程和多线程下的线程类似：有自己的堆栈，自己的局部变量，有自己的指令指针，但是和其他协程程序共享全局变量等信息。线程和协程的主要不同在于：多处理器的情况下，概念上来说多线程是同时运行多个线程，而协程是通过代码来完成协程的切换，任何时刻只有一个协程程序在运行。并且这个在运行的协程只有明确被要求挂起时才会被挂起。

原理图如下：

![linkedkeeper0_6124bac6-d251-41c7-b84b-41ca5ede532f.jpg][]

**三．OpenResty的优势**

首先我们选择使用OpenResty，其是由Nginx核心加很多第三方模块组成，其最大的亮点是默认集成了Lua开发环境，使得Nginx可以作为一个Web Server使用。

借助于Nginx的事件驱动模型和非阻塞IO，可以实现高性能的Web应用程序。

而且OpenResty提供了大量组件如Mysql、Redis、Memcached等等，使在Nginx上开发Web应用更方便更简单。目前在京东如实时价格、秒杀、动态服务、单品页、列表页等都在使用Nginx+Lua架构，其他公司如淘宝、去哪儿网等。

**四．Nginx和lua的简介**

1. Nginx：

(1) Nginx的优点

*  轻量级同样起web 服务比apache占用更少内存及资源 
 *  抗并发nginx 处理请求异步非阻塞而apache 则阻塞型高并发下nginx 能保持低资源低消耗高性能 
 *  高度模块化设计编写模块相对简单 
 *  社区活跃各种高性能模块出品迅速啊

(2) Nginx为什么性能高，占用内存少

众所周知，nginx性能高，而nginx的高性能与其架构是分不开的。在这里，我们简单粗略的介绍一下nginx的架构。

*  首先，nginx采用的是多多进程模式，好处是什么呢？首先，对于每个worker进程来说，独立的进程，不需要加锁，所以省掉了锁带来的开销，同时在编程以及问题查找时，也会方便很多。其次，采用独立的进程，可以让互相之间不会影响，一个进程退出后，其它进程还在工作，服务不会中断，master进程则很快启动新的worker进程。当然，worker进程的异常退出，肯定是程序有bug了，异常退出，会导致当前worker上的所有请求失败，不过不会影响到所有请求，所以降低风险。
 *  Nginx是采用异步非阻塞的方式去处理请求的，什么是异步非阻塞呢？其实就是当一个线程调用出现等待的io之类的情况时，而不是阻塞在这里，而是去处理别的事情，等io准备好了，然后再去执行，具体的我就不在这里和大家描述了。

2. lua:

(1) Lua 是一个小巧的脚本语言。作者是巴西人。该语言的设计目的是为了嵌入应用程序中，从而为应用程序提供灵活的扩展和定制功能

(2) Lua的特点：

*  Lua脚本可以很容易的被C/C++代码调用，也可以反过来调用C/C++的函数，这使得Lua在应用程序中可以被广泛应用。不仅仅作为扩展脚本，也可以作为普通的配置文件，代替XML,Ini等文件格式，并且更容易理解和维护。
 *  Lua由标准C编写而成，代码简洁优美，几乎在所有操作系统和平台上都可以编译，运行。一个完整的Lua解释器不过200k，在目前所有脚本引擎中，Lua的速度是最快的。这一切都决定了Lua是作为嵌入式脚本的最佳选择。

**五．OpenResty的安装**

上面我门对OpenResty进行了简单的介绍，运行原理的说明，还有Nginx、Lua优点的介绍，是为了更好的让大家理解。让大家知道用这个的好处，接下来我简单的介绍一下OpenResty的安装和搭建一个简单的限流的例子，这是为了让大家明白，除了上面说的好处，它到底能够做什么。

OpenResty的安装：

(1) 需要事先安装一下所需的插件

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>yum&nbsp;</code><code>install</code>&nbsp;<code>readline-devel&nbsp;pcre-devel&nbsp;openssl-devel</code> </td> 
 </tr> 
 </tbody> 
</table>

(2) 下载ngx\_openresty-1.7.7.2.tar.gz并解压

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>wget&nbsp;http:</code><code>//openresty</code><code>.org</code><code>/download/ngx_openresty-1</code><code>.7.7.2.</code><code>tar</code><code>.gz</code> </td> 
 </tr> 
 </tbody> 
</table>

(3) 安装LuaJIT

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>cd</code>&nbsp;<code>bundle</code><code>/LuaJIT-2</code><code>.1-20150120/</code> <code>make</code>&nbsp;<code>clean&nbsp;&amp;&amp;&nbsp;</code><code>make</code>&nbsp;<code>&amp;&amp;&nbsp;</code><code>make</code>&nbsp;<code>install</code> <code>ln</code>&nbsp;<code>-sf&nbsp;luajit-2.1.0-alpha&nbsp;</code><code>/usr/local/bin/luajit</code> </td> 
 </tr> 
 </tbody> 
</table>

(4) 下载ngx\_cache\_purge模块，该模块用于清理nginx缓存

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>wget&nbsp;https:</code><code>//github</code><code>.com</code><code>/FRiCKLE/ngx_cache_purge/archive/2</code><code>.3.</code><code>tar</code><code>.gz</code> </td> 
 </tr> 
 </tbody> 
</table>

(5) 下载nginx\_upstream\_check\_module模块，该模块用于ustream健康检查

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>wget&nbsp;https:</code><code>//github</code><code>.com</code><code>/yaoweibin/nginx_upstream_check_module/archive/v0</code><code>.3.0.</code><code>tar</code><code>.gz</code> </td> 
 </tr> 
 </tbody> 
</table>

(6) 安装ngx\_openresty

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>cd</code>&nbsp;<code>/usr/servers/ngx_openresty-1</code><code>.7.7.2</code> <code>.</code><code>/configure</code>&nbsp; <code>--prefix=</code><code>/usr/servers</code>&nbsp; <code>--with-http_realip_module&nbsp;&nbsp;</code> <code>--with-pcre&nbsp;&nbsp;</code> <code>--with-luajit&nbsp;</code> <code>--add-module=.</code><code>/bundle/ngx_cache_purge-2</code><code>.3/&nbsp;</code> <code>--add-module=.</code><code>/bundle/nginx_upstream_check_module-0</code><code>.3.0/&nbsp;-j2</code> <code>make</code>&nbsp;<code>&amp;&amp;&nbsp;</code><code>make</code>&nbsp;<code>install</code> </td> 
 </tr> 
 </tbody> 
</table>

(7) 到/usr/servers目录下，会发现多出来了如下目录，说明安装成功

(8) 启动nginx：/usr/servers/nginx/sbin/nginx（其实我们可以配置好系统的环境变量，配置好后就可以直接数据nginx命令了）

**六．防刷（黑白名单）简单例子的搭建**

1. 首先我们先可以在/usr/servers/nginx/conf/ 目录下创建我们自己的一个简单的lua文件，就叫做example.lua好了。

![linkedkeeper0_b75fb85f-b2f3-4131-be35-53210c11dad7.jpg][]

输入如下命令，我们就可以创建一个example.conf文件，或者我们可以cp nginx.conf  example.conf 或者mkdir example.conf

2. 接下来我们需要编辑nginx.conf这个启动配置的文件了

![linkedkeeper0_e13d68cb-ffa7-4493-a3f0-86f24aa7b941.jpg][]

ok,我们进入到编辑界面，接下来我们需要将我们的example.conf文件给引入进来，在nginx.conf的http体里添加一下命令：include example.conf

nginx.conf 的具体内容如下：

![linkedkeeper0_4378ad85-ad30-4af5-b09b-84ca86bb5e37.jpg][]

其中大家可以看到用红线框框的是自己项目文件的引入和lua模块的引入。

3. 接下来我们可以在example.conf文件中写我们的逻辑实现了

![linkedkeeper0_02ce4155-2f12-4e91-8062-61722feab090.jpg][]

4. 我们可以看到，在example.conf中的server里面配置多个location，而location中嵌入了content\_by\_lua\_file  /usr/example/lua/redis\_black\_limit.lua，从这可以看出在content阶段嵌入了lua脚本，进行了内容的响应，在这里，我们进去看看相应的代码是如何来处理的：

![linkedkeeper0_10da7915-0aab-42fc-b877-44d5ae545f5e.jpg][]

这是一个防刷的demo,从中我们可以看出，我是更具ip，从redis里面取值，然后通过请求ip的匹配，来做到防刷的功能，除此之外，这里有一个语句，我们的注意到，那就是require，这就相当于我们的类加载器，class.forname,从而做到加载进来lua的模块。

5. 除此之外，还简单的做了一个设置黑名单和取消黑名单的功能，用来充当我们以后的管理中心，具体逻辑写在set\_black.lua和cancel.lua中，然后在lua.conf中配置好url，具体如下图所示:

在lua.conf中server体里加入一下代码：

![linkedkeeper0_cba2cb55-4c24-479f-841a-76e6f5f1ec23.jpg][]

接下来我们需要写set\_black.lua和cancel.lua文件，文件内容如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>v</code>&nbsp;&nbsp;<code>set_black.lua:</code> <code>local</code>&nbsp;<code>redis&nbsp;=require&nbsp;</code><code>"resty.redis"</code> <code>local</code>&nbsp;<code>cache&nbsp;=redis.new()</code> <code>cache:set_timeout(6000)</code> <code>local</code>&nbsp;<code>ok,err=cache.connect(cache,</code><code>'192.168.150.61'</code><code>,6379)</code> <code>if</code>&nbsp;<code>not&nbsp;ok&nbsp;</code><code>then</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ngx.say(</code><code>"failed&nbsp;to&nbsp;connect:"</code><code>,err)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>end</code> <code>local</code>&nbsp;<code>ip&nbsp;=&nbsp;ngx.var.remote_addr</code> <code>cache:</code><code>set</code><code>(</code><code>"user:"</code><code>..ip..</code><code>":block"</code><code>,1)</code> <code>ngx.say(</code><code>"user:"</code><code>..ip..</code><code>":block"</code><code>..</code><code>"设置黑名单成功"</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>v</code>&nbsp;&nbsp;<code>cancel_black.lua:</code> <code>local</code>&nbsp;<code>redis&nbsp;=require&nbsp;</code><code>"resty.redis"</code> <code>local</code>&nbsp;<code>cache&nbsp;=redis.new()</code> <code>cache:set_timeout(6000)</code> <code>local</code>&nbsp;<code>ok,err=cache.connect(cache,</code><code>'192.168.150.61'</code><code>,6379)</code> <code>if</code>&nbsp;<code>not&nbsp;ok&nbsp;</code><code>then</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ngx.say(</code><code>"failed&nbsp;to&nbsp;connect:"</code><code>,err)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>end</code> <code>local</code>&nbsp;<code>ip&nbsp;=&nbsp;ngx.var.remote_addr</code> <code>cache:expire(</code><code>"user:"</code><code>..ip..</code><code>":block"</code><code>,0)</code> <code>ngx.say(</code><code>"user:"</code><code>..ip..</code><code>":block"</code><code>..</code><code>"移除黑名单"</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

**7. 效果**

做好了以上配置，我们可以开始先设置好黑名单，然后访问请求，返回的结果是被黑名单了，然后再取消黑名单，再访问请求，显示访问成功，具体结果如下图。

![linkedkeeper0_47ce000d-0e47-4257-87c6-3e29088af6de.jpg][]

**七．总结**

上文简单的介绍一些OpenResty，以及搭建了一个简单的应用，目的是想让大家对这个框架有一个大体的了解。随着架构的升级，我们会慢慢的把一些不太复杂的业务可以移到nginx层，从而提高我们的吞吐量，解决一些性能上的瓶颈。例如在nginx这一层做简单的限流、黑白名单，缓存之类的业务复杂性不是太强的工作，从而增加我们的吞吐率，也可以再nginx这一层过滤掉一些垃圾流量，从而让tomcat层只需要更加专注于业务。（以上是我简单粗略的一些理解，如果有什么问题，欢迎大家一起讨论）

[https_blog.csdn.net_yhclt_article_details_79309237]: https://blog.csdn.net/yhclt/article/details/79309237
[linkedkeeper0_6124bac6-d251-41c7-b84b-41ca5ede532f.jpg]: /images/20220504/7201843d60674f0e837ad1acb692985d.png
[linkedkeeper0_b75fb85f-b2f3-4131-be35-53210c11dad7.jpg]: /images/20220504/575190521d06491baa04090ea3324da4.png
[linkedkeeper0_e13d68cb-ffa7-4493-a3f0-86f24aa7b941.jpg]: /images/20220504/2794cd581ef34f14891c2800fb0140ae.png
[linkedkeeper0_4378ad85-ad30-4af5-b09b-84ca86bb5e37.jpg]: /images/20220504/bf6d82a0aeeb4d65ba0338cc6f0f2181.png
[linkedkeeper0_02ce4155-2f12-4e91-8062-61722feab090.jpg]: /images/20220504/19152a82cb6a47198ad9923a7c87fac2.png
[linkedkeeper0_10da7915-0aab-42fc-b877-44d5ae545f5e.jpg]: /images/20220504/268e504d5c0b492fa64b1ff043e0ed2c.png
[linkedkeeper0_cba2cb55-4c24-479f-841a-76e6f5f1ec23.jpg]: /images/20220504/7352cbe3f9be4560a842fe6de57d036f.png
[linkedkeeper0_47ce000d-0e47-4257-87c6-3e29088af6de.jpg]: /images/20220504/1ff8d1524b4445a280acbac51aad4781.png