第一章 安装OpenResty(Nginx+Lua)开发环境

首先我们选择使用OpenResty，其是由Nginx核心加很多第三方模块组成，其最大的亮点是默认集成了Lua开发环境，使得Nginx可以作为一个Web Server使用。借助于Nginx的事件驱动模型和非阻塞IO，可以实现高性能的Web应用程序。而且OpenResty提供了大量组件如Mysql、Redis、Memcached等等，使在Nginx上开发Web应用更方便更简单。目前在京东如实时价格、秒杀、动态服务、单品页、列表页等都在使用Nginx+Lua架构，其他公司如淘宝、去哪儿网等。

安装环境

安装步骤可以参考http://openresty.org/#Installation。

 

1、创建目录/usr/servers，以后我们把所有软件安装在此目录

mkdir -p /usr/servers
cd /usr/servers/

 

2、安装依赖（我的环境是ubuntu，可以使用如下命令安装，其他的可以参考openresty安装步骤）

apt-get install libreadline-dev libncurses5-dev libpcre3-dev libssl-dev perl

 

3、下载ngx_openresty-1.7.7.2.tar.gz并解压

wget http://openresty.org/download/ngx_openresty-1.7.7.2.tar.gz
tar -xzvf ngx_openresty-1.7.7.2.tar.gz

 

ngx_openresty-1.7.7.2/bundle目录里存放着nginx核心和很多第三方模块，比如有我们需要的Lua和LuaJIT。

 

3、安装LuaJIT

cd bundle/LuaJIT-2.1-20150120/
make clean && make && make install
ln -sf luajit-2.1.0-alpha /usr/local/bin/luajit

 

4、下载ngx_cache_purge模块，该模块用于清理nginx缓存

cd /usr/servers/ngx_openresty-1.7.7.2/bundle
wget https://github.com/FRiCKLE/ngx_cache_purge/archive/2.3.tar.gz
tar -xvf 2.3.tar.gz

 

5、下载nginx_upstream_check_module模块，该模块用于ustream健康检查

cd /usr/servers/ngx_openresty-1.7.7.2/bundle
wget https://github.com/yaoweibin/nginx_upstream_check_module/archive/v0.3.0.tar.gz
tar -xvf v0.3.0.tar.gz 

  

6、安装ngx_openresty

cd /usr/servers/ngx_openresty-1.7.7.2
./configure --prefix=/usr/servers --with-http_realip_module  --with-pcre  --with-luajit --add-module=./bundle/ngx_cache_purge-2.3/ --add-module=./bundle/nginx_upstream_check_module-0.3.0/ -j2
make && make install

 

--with***                安装一些内置/集成的模块

--with-http_realip_module  取用户真实ip模块

-with-pcre               Perl兼容的达式模块

--with-luajit              集成luajit模块

 

--add-module            添加自定义的第三方模块，如此次的ngx_che_purge

 

8、到/usr/servers目录下 

cd /usr/servers/
ll 

 

会发现多出来了如下目录，说明安装成功

/usr/servers/luajit ：luajit环境，luajit类似于java的jit，即即时编译，lua是一种解释语言，通过luajit可以即时编译lua代码到机器代码，得到很好的性能；

/usr/servers/lualib：要使用的lua库，里边提供了一些默认的lua库，如redis，json库等，也可以把一些自己开发的或第三方的放在这；

/usr/servers/nginx ：安装的nginx；

 

通过/usr/servers/nginx/sbin/nginx  -V 查看nginx版本和安装的模块

 

7、启动nginx

/usr/servers/nginx/sbin/nginx

 

接下来该配置nginx+lua开发环境了

 

配置环境

配置及Nginx HttpLuaModule文档在可以查看http://wiki.nginx.org/HttpLuaModule。

 

 

1、编辑nginx.conf配置文件 

vim /usr/servers/nginx/conf/nginx.conf

  

2、在http部分添加如下配置 

#lua模块路径，多个之间”;”分隔，其中”;;”表示默认搜索路径，默认到/usr/servers/nginx下找
lua_package_path "/usr/servers/lualib/?.lua;;";  #lua 模块
lua_package_cpath "/usr/servers/lualib/?.so;;";  #c模块 

  

3、为了方便开发我们在/usr/servers/nginx/conf目录下创建一个lua.conf 

#lua.conf
server {
    listen       80;
    server_name  _;
}

 

4、在nginx.conf中的http部分添加include lua.conf包含此文件片段 

include lua.conf;

  

5、测试是否正常 

/usr/servers/nginx/sbin/nginx  -t 

 

如果显示如下内容说明配置成功

nginx: the configuration file /usr/servers/nginx/conf/nginx.conf syntax is ok

nginx: configuration file /usr/servers/nginx/conf/nginx.conf test is successful

 

HelloWorld

1、在lua.conf中server部分添加如下配置 

location /lua {
    default_type 'text/html';
        content_by_lua 'ngx.say("hello world")';
}

         

2、测试配置是否正确 

/usr/servers/nginx/sbin/nginx  -t

   

3、重启nginx 

/usr/servers/nginx/sbin/nginx  -s reload

 

 4、访问如http://192.168.1.6/lua（自己的机器根据实际情况换ip），可以看到如下内容 

hello world

 

5、lua代码文件

我们把lua代码放在nginx配置中会随着lua的代码的增加导致配置文件太长不好维护，因此我们应该把lua代码移到外部文件中存储。 

vim /usr/servers/nginx/conf/lua/test.lua

#添加如下内容
ngx.say("hello world"); 

 

然后lua.conf修改为   

    location /lua {
        default_type 'text/html';
        content_by_lua_file conf/lua/test.lua; #相对于nginx安装目录
    } 

此处conf/lua/test.lua也可以使用绝对路径/usr/servers/nginx/conf/lua/test.lua。

 

6、lua_code_cache 

默认情况下lua_code_cache  是开启的，即缓存lua代码，即每次lua代码变更必须reload nginx才生效，如果在开发阶段可以通过lua_code_cache  off;关闭缓存，这样调试时每次修改lua代码不需要reload nginx；但是正式环境一定记得开启缓存。 

    location /lua {
        default_type 'text/html';
        lua_code_cache off;
        content_by_lua_file conf/lua/test.lua;
}

 

开启后reload nginx会看到如下报警

nginx: [alert] lua_code_cache is off; this will hurt performance in /usr/servers/nginx/conf/lua.conf:8

 

7、错误日志

 

如果运行过程中出现错误，请不要忘记查看错误日志。 

tail -f /usr/servers/nginx/logs/error.log

 

到此我们的基本环境搭建完毕。

 

nginx+lua项目构建

以后我们的nginx lua开发文件会越来越多，我们应该把其项目化，已方便开发。项目目录结构如下所示：

example

    example.conf     ---该项目的nginx 配置文件

    lua              ---我们自己的lua代码

      test.lua

    lualib            ---lua依赖库/第三方依赖

      *.lua

      *.so

 

其中我们把lualib也放到项目中的好处就是以后部署的时候可以一起部署，防止有的服务器忘记复制依赖而造成缺少依赖的情况。

 

我们将项目放到到/usr/example目录下。

 

/usr/servers/nginx/conf/nginx.conf配置文件如下(此处我们最小化了配置文件)

#user  nobody;
worker_processes  2;
error_log  logs/error.log;
events {
    worker_connections  1024;
}
http {
    include       mime.types;
    default_type  text/html;

    #lua模块路径，其中”;;”表示默认搜索路径，默认到/usr/servers/nginx下找
    lua_package_path "/usr/example/lualib/?.lua;;";  #lua 模块
    lua_package_cpath "/usr/example/lualib/?.so;;";  #c模块
    include /usr/example/example.conf;
}

通过绝对路径包含我们的lua依赖库和nginx项目配置文件。

 

/usr/example/example.conf配置文件如下 

server {
    listen       80;
    server_name  _;

    location /lua {
        default_type 'text/html';
        lua_code_cache off;
        content_by_lua_file /usr/example/lua/test.lua;
    }
}

lua文件我们使用绝对路径/usr/example/lua/test.lua。 

 

到此我们就可以把example扔svn上了。

 

评论

13 楼 anyzm311 2018-01-18  

发现一个问题，请教下：
我在access_by_lua_file和init_by_lua_file两个节点分别进行require加载自己写的一个东西，在init_by_lua_file中require后面使用没有任何问题，但在access_by_lua_file中require时，发现只有第一次调用有效，后面调用时为nil.该类的代码如下：

local TrafficControlManager = {}

TrafficControlManager.f = nil;

function TrafficControlManager:new(o) 
    o = o or {} 
    setmetatable(o,self) 
    self.__index = self
    return o 
end 
 
function TrafficControlManager:GetInstance() 
    if self.instance == nil then 
        self.instance = self:new()
    end 
    return self.instance 
end 

--全局限流,参数为限流值
function TrafficControlManager:gloalTraffic(gloalMax)
    return false
end



请帮忙说下，这是什么问题，我自己理解是lua在init_by_lua_file中require时，会是整个nginx生命周期，在access_by_lua_file中require时，生命周期限本次访问，第二次访问时，因为require已经执行过了，所以没有再加载，而己加载的又失效了，不知道是不是这样，望解答，谢谢。

12 楼 Tro_picana 2017-08-01  

开涛老师：
基于ngx_cache_purge 针对目录删除缓存目前有现成的模块可以用吗？

11 楼 solid210 2017-06-02  

578936807 写道

开涛，我把lua.conf里的配置改成目录访问形式后，如下：
  content_by_lua_file /conf/lua/test.lua
浏览器访问就一直报404，但是用content_by_lua 'ngx.say("hello")'访问就正常。哪里的问题？求解答。

404错误是因为你的路径有问题, 如果使用绝对路径, 注意检查路径是否正确, 并且下面有没有你所指定的lua文件.

10 楼 578936807 2017-04-27  

开涛，我把lua.conf里的配置改成目录访问形式后，如下：
  content_by_lua_file /conf/lua/test.lua
浏览器访问就一直报404，但是用content_by_lua 'ngx.say("hello")'访问就正常。哪里的问题？求解答。

9 楼 Godparent 2016-08-25  

8 楼 andy_gaoxu 2015-12-25  

开涛，你好：问你一个问题，你们的redis集群现在是2.x的版本吧，你们有准备升级成3.0的打算吗？

7 楼 nonobaba 2015-05-22  

jinnianshilongnian 写道

nonobaba 写道

local a = {};
a[0]=11111;
a[1]=10;
a[2]=11;
a[5]=1231;
a["nimei"]=12312;

for key=1, #(a)
    do print(key);
end

这个按说应该打印
1
2
的，不过却打印出了
1
2
3
4
5
这个是lua的bug吗？

不是的， a["nimei"] 这种的需要 in pairs()

今天找到原因了，因为我使用的sdk是luaj和实际的lua有出入，我把sdk改为5.3版的lua就行了。

6 楼 jinnianshilongnian 2015-05-22  

nonobaba 写道

local a = {};
a[0]=11111;
a[1]=10;
a[2]=11;
a[5]=1231;
a["nimei"]=12312;

for key=1, #(a)
    do print(key);
end

这个按说应该打印
1
2
的，不过却打印出了
1
2
3
4
5
这个是lua的bug吗？

不是的， a["nimei"] 这种的需要 in pairs()

5 楼 nonobaba 2015-05-21  

local a = {};
a[0]=11111;
a[1]=10;
a[2]=11;
a[5]=1231;
a["nimei"]=12312;

for key=1, #(a)
    do print(key);
end

这个按说应该打印
1
2
的，不过却打印出了
1
2
3
4
5
这个是lua的bug吗？

4 楼 nonobaba 2015-05-21  

jinnianshilongnian 写道

nonobaba 写道

lua开发调试如何调试，我看了官方网站的openresty的debugging部分没看明白，感觉没看开发工具的调试结合起来， 如果有类似eclipse调试tomcat上的应用的工具就好了，请问开涛大神平时是怎么开发调试的？

我们就是手写代码 哈哈

大神都是这样的吗？

3 楼 jinnianshilongnian 2015-05-21  

nonobaba 写道

lua开发调试如何调试，我看了官方网站的openresty的debugging部分没看明白，感觉没看开发工具的调试结合起来， 如果有类似eclipse调试tomcat上的应用的工具就好了，请问开涛大神平时是怎么开发调试的？

我们就是手写代码 哈哈

2 楼 nonobaba 2015-05-21  

lua开发调试如何调试，我看了官方网站的openresty的debugging部分没看明白，感觉没看开发工具的调试结合起来， 如果有类似eclipse调试tomcat上的应用的工具就好了，请问开涛大神平时是怎么开发调试的？

1 楼 somefuture 2015-03-20  

能不能说一下为什么要选择这种架构，和其他同类框架比起来，lua能快多少，其他优势是什么等等。