第十六节、常用指令

Ngx_Lua提供了大量的Lua API指令来实现各种功能，本节会介绍一些常用的指令。

16.1　请求重定向

在Nginx中通过rewrite对请求进行重定向，而在Ngx_Lua里可以使用ngx.redirect、ngx.req.set_uri来完成重定向，并且Ngx_Lua还提供了一个具有强大的扩展能力的ngx.exec指令。

ngx.redirect

语法：ngx.redirect(uri, status?)

配置环境：rewrite_by_lua*，access_by_lua*，content_by_lua*

含义：发出一个 HTTP状态码为301或302的重定向请求到指定的URI。

参数status的可选值有301、302、303、307和308，默认值是302。下面是ngx.redirect重定向和rewrite重定向的对比：

location / { # 等同于 rewrite ^/ http://testnginx.com/test? redirect; rewrite_by_lua_block { return ngx.redirect("/test") } }

上述配置使用了默认的302状态。如果在跳转过程中需要保留请求的参数，可作如下配置：

location / { # 等同于 rewrite ^/ http://testnginx.com/test permanent; rewrite_by_lua_block { local ngx = require "ngx"; return ngx.redirect("/test?" .. ngx.var.args ,301) } }

也可以自定义参数，如下所示： return ngx.redirect("/test?test=1&a=2" ,301) 支持跳转到其他域名，如http://abc.testnginx.com： return ngx.redirect("http://abc.testnginx.com",301)

注意：跳转时都加return指令，其作用是为了强调跳转操作，官方推荐使用这种方式。

ngx.req.set_uri

语法：ngx.req.set_uri (uri, jump?)

配置环境：set_by_lua*，rewrite_by_lua*，access_by_lua*，content_by_lua*，header_filter_ by_lua*，body_filter_by_lua*

含义：用参数uri来重写当前的URL，和Nginx的rewrite内部重定向功能相似。例如，rewrite的指令rewrite ^ /test last; 与ngx.req.set_uri("/test", true)功能相似，而rewrite ^ /test break; 与ngx.req.set_uri("/foo", false)功能相似。如果需要在跳转过程中修改参数，可以使用ngx.req.set_uri_args来完成新的参数配置，操作如下： ngx.req.set_uri_args("a=1&b=2&c=3") ngx.req.set_uri("/test", true) ngx.exec

语法：ngx.exec(uri, args?)

配置环境：rewrite_by_lua，access_by_lua*，content_by_lua*

含义：使用uri、args参数来完成内部重定向，类似于echo-nginx-module 的echo_exec指令。

示例：

server {

`listen       80;`

`server_name  testnginx.com;`

`default_type 'text/plain';`

`location / {`

    `content_by_lua_block {`

        `return ngx.exec('/test');`

    `}`

`}`

`location /test {`

    `content_by_lua_block {`

        `ngx.say(ngx.var.args);`

    `}

}`

}

下面是ngx_exec指令常用的几种参数设置的示例。保留之前的参数，如“ngx.exec('/test',ngx.var.args);”。保留之前的参数，并新增参数，如“ngx.exec('/test' ,ngx.var.args .. 'd=4');”。去掉之前的参数，并新增参数，如“ngx.exec('/test' , 'd=4');”。注意：ngx_exec是一个内部重定向指令，不涉及外部的HTTP请求。在使用中推荐采用return ngx.exec(…)的方式。

16.2　日志记录

在使用Lua进行开发的过程中，需要使用日志来输出异常和调试信息，在Lua API中可以使用ngx.log来记录日志。

ngx.log

语法：ngx.log(log_level, ...)

配置环境：init_by_lua*，init_worker_by_lua*，set_by_lua*，rewrite_by_lua*，access_by_ lua*，content_by_lua*，header_filter_by_lua*，body_filter_by_lua*，log_by_lua*，ngx.timer.，balancer_by_lua，ssl_certificate_by_lua*，ssl_session_fetch_by_lua*，ssl_session_store_by_lua*

含义：根据log_level的等级，将内容记录到error.log的日志文件中。 log_level的级别及其说明见表7-6（和Nginx的error.log日志级别是一致的）。表7-6　log_level的级别及其说明

续表

示例：

server {

`listen       80;`

`server_name  testnginx.com;`

`default_type 'text/plain';`

`location / {`

    `content_by_lua_block {`

        `ngx.say("test ")`

        `ngx.say("nginx ")`

        `ngx.log(ngx.ALERT, 'Log Test Nginx')`

        `ngx.log(ngx.STDERR, 'Log Test Nginx')`

        `ngx.log(ngx.EMERG, 'Log Test Nginx')`

        `ngx.log(ngx.ALERT, 'Log Test Nginx')`

        `ngx.log(ngx.CRIT, 'Log Test Nginx')`

        `ngx.log(ngx.ERR, 'Log Test Nginx')`

        `ngx.log(ngx.WARN, 'Log Test Nginx')`

        `ngx.log(ngx.NOTICE, 'Log Test Nginx')`

        `ngx.log(ngx.INFO, 'Log Test Nginx')`

        `ngx.log(ngx.DEBUG, 'Log Test Nginx')`

    `}`

`}`

}

执行结果如下：

curl -i 'http://testnginx.com/'

查看error.log 日志，默认在logs/error.log文件中，示例如下：

2018/06/11 11:18:26 [alert] 1180#1180: *34 [lua] content_by_lua (nginx.conf:66):4: Log Test Nginx, client: