第四章 Openresty使用笔记

叁歲伎倆 2021-11-05 06:20 681阅读 0赞

OpenResty是一个全功能的Web应用服务器，它打包了标准的Nginx核心，常用的第三方模块以及大多数依赖项。可以把它看成是Nginx附加众多的第三方插件的合集，其主体是嵌入lua脚本的支持，让你能够使用lua灵活地处理运算逻辑。

## **一、Openresty的安装配置** ##

### **1、简易的yum安装方式** ###

此方式简单，缺点是无法干预启停插件

> yum install yum-utils
> 
> yum-config-manager --add-repo https://openresty.org/package/centos/openresty.repo
> 
> yum install openresty

### **2、源码安装方式** ###

> wget [https://openresty.org/download/openresty-1.15.8.1.tar.gz][https_openresty.org_download_openresty-1.15.8.1.tar.gz] 
> 
> tar -zxvf [openresty-1.15.8.1.tar.gz][https_openresty.org_download_openresty-1.15.8.1.tar.gz] 
> 
> \#\#选择需要的插件启用, --with-Components 激活组件，--without 则是禁止组件 
> 
> ./configure  --without-http\_redis2\_module  --with-http\_iconv\_module

**编译：**

> make  && make install

**配置环境变量：**

> vi /etc/profile \#\#加入path路径
> 
> export PATH=$PATH:/usr/local/openresty/nginx/sbin/
> 
> source /etc/profile \#\#生效配置

**安装****完成后查看安装结果：**

nginx  -V   \#\#如下显示，则表示安装成功

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70][]

### **3、Lua介入Nginx带来的基础api** ###

主要帮助对http请求取参、取header头、输出等

<table style="margin-left:20.6pt;width:379.5pt;"> 
 <tbody> 
 <tr> 
 <td style="width:130pt;"> ngx.arg </td> 
 <td style="width:249.5pt;"> 指令参数，如跟在content_by_lua_file后面的参数 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.var </td> 
 <td style="width:249.5pt;"> request变量，ngx.var.VARIABLE引用某个变量 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.ctx </td> 
 <td style="width:249.5pt;"> 请求的lua上下文 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.header </td> 
 <td style="width:249.5pt;"> 响应头，ngx.header.HEADER引用某个头 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.status </td> 
 <td style="width:249.5pt;"> 响应码 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.log </td> 
 <td style="width:249.5pt;"> 输出到error.log </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.send_headers </td> 
 <td style="width:249.5pt;"> 发送响应头 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.headers_sent </td> 
 <td style="width:249.5pt;"> 响应头是否已发送 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.resp.get_headers </td> 
 <td style="width:249.5pt;"> 获取响应头 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.is_subrequest </td> 
 <td style="width:249.5pt;"> 当前请求是否是子请求 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.location.capture </td> 
 <td style="width:249.5pt;"> 发布一个子请求 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.location.capture_multi </td> 
 <td style="width:249.5pt;"> 发布多个子请求 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.print </td> 
 <td style="width:249.5pt;"> 输出响应 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.say </td> 
 <td style="width:249.5pt;"> 输出响应，自动添加‘\n‘ </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.flush </td> 
 <td style="width:249.5pt;"> 刷新响应 </td> 
 </tr> 
 <tr> 
 <td style="width:130pt;"> ngx.exit </td> 
 <td style="width:249.5pt;"> 结束请求 </td> 
 </tr> 
 </tbody> 
</table>

### **4、Lua嵌入Nginx的时机阶段** ###

Nginx执行lua脚本片断时，需要明确指明执行的nginx阶段时机。主要有以下几种时机：

set\_by\_lua\* : 设置nginx变量，实现复杂的赋值逻辑

rewrite\_by\_lua\* : 实现转发、重定向等功能

access\_by\_lua\* : IP 准入、接口访问权限等情况集中处理

content\_by\_lua\* : 接收请求处理并输出响应

header\_filter\_by\_lua\* : 设置header和cookie

body\_filter\_by\_lua\* : 对响应数据进行过滤，如截断/替换等

## **二、Lua基础功能使用介绍** ##

### **1、hello world** ###

在content阶段，执行lua脚本，输出hello，Hankin

location /hello {
        ##ngx.say--输出内容print
        content_by_lua 'ngx.say("Hello, Hankin!")';
    }

访问路劲：[http://lua.chj.com/hello][http_lua.chj.com_hello]

### **2、执行lua脚本文件** ###

location /args {
        ##ngx.var--取请求参数，arg_a指参数a
        content_by_lua_block {
            ngx.say(ngx.var.arg_a)
            ngx.say(ngx.var.arg_b)
         }
    }

访问路劲：[http://lua.chj.com/args?a=aaa&b=bbb][http_lua.chj.com_args_a_aaa_b_bbb]

输出结果：aaa bbb

### **3、lua取get参数** ###

页面请求路径：[http://lua.chj.com/args?a=20&b=50][http_lua.chj.com_args_a_20_b_50]

则ngx.var.arg\_a即取得a参数值，如下：

### **4、lua取全量参数** ###

请求：[http://lua.chj.com/args\_read?a=20&b=50][http_lua.chj.com_args_read_a_20_b_50]

[root@localhost lua]# cat lua_args.lua
    
    --key-value形式取得所有的url上的参数--get型参数
    local arg = ngx.req.get_uri_args()
    for k,v in pairs(arg) do
       ngx.say("[GET ] ", k, " :", v)   ## 读取get请求
    end
    
    --key-value形式取得所有post的参数
    ngx.req.read_body()-- 解析 body 参数之前一定要先读取 body
    local arg = ngx.req.get_post_args()
    for k,v in pairs(arg) do
       ngx.say("[POST] ", k, " :", v)  ## 读取post请求
    end

输出结果：\[GET \] a :20    \[GET \] b :50

### **5、lua取request中header信息** ###

[root@localhost lua]# cat lua_req.lua
    --读请求头信息
    local headers = ngx.req.get_headers()
    ngx.say("Host : ", headers.Host)
    ngx.say("Host : ", headers["Host"])
    ngx.say("--------------")
    for k,v in pairs(headers) do
        if type(v) == "table" then
            --table.concat是table操作，意指将v内所有值合并
            ngx.say(k, " : ", table.concat(v, ","))
        else
            ngx.say(k, " : ", v)
        end
    End

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 1][]

### **6、给lua脚本传参** ###

使用端传参：[http://lua.chj.com/setfile?a=100&b=200][http_lua.chj.com_setfile_a_100_b_200]

location /setfile {
        ##给lua脚本传递参数
        set_by_lua_file $val "/etc/nginx/lua/set.lua" $arg_a $arg_b;        
        echo $val;
    }

脚本中借助ngx.arg取参：

[root@localhost lua]# cat set.lua
    local a=tonumber(ngx.arg[1])
    local b=tonumber(ngx.arg[2])
    return a + b

### **7、权限校验** ###

一般校验动作，指定在access阶段执行脚本

location /access { 
         ## 权限控制
         access_by_lua_file "/etc/nginx/lua/access.lua";
         echo "welcome $arg_name !";
    }

脚本处理：

[root@localhost lua]# cat access.lua
    
    if ngx.var.arg_passwd == "123456"
    then
        return   
    else   
        ngx.exit(ngx.HTTP_FORBIDDEN)    
    end

取http其请求中的passwd参数，注意不是脚本传参，校验不通过则返回403状态

### **8、内容过滤** ###

Nginx有时候，需要对下游服务生成的内容进行处理过滤，如下：

location /filter {
    echo 'hello Peter';
    echo 'you are welcome!';
         ##内容过滤
         body_filter_by_lua_file "/etc/nginx/lua/filter.lua";
    }

脚本中的处理：

[root@localhost lua]# cat filter.lua
    
    --ngx.arg[1]是输出块内容
    local chunk = ngx.arg[1]   
    if string.match(chunk, "hello") then
         ngx.arg[2] = true  -- 设置为true，表示输出结束 eof
         return
    end
    -- just throw away any remaining chunk data
    ngx.arg[1] = nil

## **三、Lua引入第三方模块的使用** ##

OpenResty提供了非常多的第三方插件，支持操作redis/mysql等服务，lua使用它们的模式一般按以下流程。

*  require  “resty/xxx” ：导入模块功能，类似java中的import导入类
 *  local  obj = xxx:new() ：模块创建对象obj
 *  local ok, err  = obj :connect ：对象连接到目标库
 *  obj :method ：这里可以为所欲为，尽情操纵目标库了

### **1、Lua-resty-redis连接redis用法** ###

Lua-resty-redis插件，对Nginx操作redis的支持十分强大，成熟的用法演示如下：

基础的引入、连接动作

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 2][]

redis操作动作：

![20190808163852920.png][]

具体全量的程序，见源码配置：

[root@localhost lua]# cat redis.lua
    
    local redis = require "resty.redis"
    --打开redis连接
    local function open_redis()
        local red = redis:new()
        red:set_timeout(1000) -- 超时时间1 second
        local res = red:connect('192.168.0.128',6379)
        if not res then
            return nil
        end
            res = red:auth(123456)  --密码校验
            if not res then
                return nil
            end
        red.close = close
        return red
    end
    
    --关闭连接
    local function close(self)
        local sock = self.sock
        if not sock then
            return nil, "not initialized"
        end
        if self.subscribed then
            return nil, "subscribed state"
        end
        return sock:setkeepalive(10000, 50)
    end
    
    local key =  'name'
    local val =  "100"
    local arg = ngx.req.get_uri_args() --取req里所有的参数
    for k,v in pairs(arg) do
       key = k
       val = v
       break;
    end
    
    local red = open_redis()
    --local value = red:get(key)  --取值
    --red:set(key,val)     --设新值
    --close(red)
    red:init_pipeline()
    value = red:get(key)
    red:set(key, val)
    red:commit_pipeline()
    
    --返回值到页面
    ngx.say(key,':',value)

### **2、Lua-resty-mysql连接mysql数据库** ###

引入模块、创建连接：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 3][]

mysql查询操作：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 4][]

**配置代码：**\[root@localhost lua\]\# cat mysql.lua

local mysql = require "resty.mysql"
    local cjson = require "cjson"
    -- 配置
    local config = {
        host = "192.168.0.128",
        port = 3303,
        database = "enjoy",
        user = "root",
        password = "root"
    }
    
    -- 打开连接
    local function open_mysql()
        local db, err = mysql:new()
        if not db then
            return nil
        end
        db:set_timeout(1000) -- 1 sec
        local ok, err, errno, sqlstate = db:connect(config)
        if not ok then
            return nil
        end
        db.close = close
        return db
    end
    
    -- 关闭连接
    local function close(self)
        local sock = self.sock
        if not sock then
            return nil, "not initialized"
        end
        if self.subscribed then
            return nil, "subscribed state"
        end
        return sock:setkeepalive(10000, 50)
    end
    
    local db = open_mysql()
    local sql = "select * from t_account "
    
    --设置中文编码
    ngx.header['Content-Type']="text/html;charset=UTF-8"
    local res, err, errno, sqlstate = db:query(sql)
    close(db)
    if not res then
        ngx.say(err)
        return {}
    end
    
    --json方式输出
    ngx.say(cjson.encode(res))

[https_openresty.org_download_openresty-1.15.8.1.tar.gz]: https://openresty.org/download/openresty-1.15.8.1.tar.gz
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70]: /images/20211104/cfa8e89a5f334d81a03d92dc2312deff.png
[http_lua.chj.com_hello]: http://lua.chj.com/hello
[http_lua.chj.com_args_a_aaa_b_bbb]: http://lua.chj.com/args?a=aaa&b=bbb
[http_lua.chj.com_args_a_20_b_50]: http://lua.enjoy.com/args?a=20&b=50
[http_lua.chj.com_args_read_a_20_b_50]: http://lua.enjoy.com/args_read?a=20&b=50
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 1]: /images/20211104/b251b90409a449ae975a16ee93ab2d1a.png
[http_lua.chj.com_setfile_a_100_b_200]: http://lua.chj.com/setfile?a=100&b=200
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 2]: /images/20211104/30ca67fed727447d8cbecaf7c1982130.png
[20190808163852920.png]: /images/20211104/f3431ba0c93344bcb09be0e1d53f4eff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 3]: /images/20211104/1475bb94449048acb8db6ec6d25ca900.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NjYxNDU4_size_16_color_FFFFFF_t_70 4]: /images/20211104/713acb8f8278481d8bb32a6b09deb19a.png