Openresty常用指令和参数

摘要:
根据需要使用ngx.var.server _ Addruri--服务器地址。该值可以在系统调用完成后确定。如果要绕过系统调用,必须在listen中指定地址并使用bind参数。Ngx。var.uri——请求中的当前uri,它可以与浏览器传递的$请求不同。uri的值,可以通过内部重定向或使用索引指令修改。ngx.var.server _ Name--服务器名称ngx.var.server _ Port--服务器请求的端口号。ngx.var.remote_Addr--获取远程IP地址ngx.var_remote_Port--获取远程端口号ngx。header——输出响应头;Ngx。print——输出响应内容体;Ngx。说-通过ngx。打印,但最后将输出换行符;ngx表示。exit—指定要退出的状态代码。
--[[
参考文档: https://www.nginx.com/resources/wiki/modules/lua/#nginx-api-for-lua
Nginx Lua模块指令:
    Nginx共11个处理阶段,而相应的处理阶段是可以做插入式处理,即可插拔式架构;
    另外指令可以在http、server、server if、location、location if几个范围进行配置:

指令: init_by_lua/init_by_lua_file

    处理阶段:
        loading-config
    使用范围:
        http
    解释:
        nginx Master进程加载配置时执行;
        通常用于初始化全局配置/预加载Lua模块


指令: init_worker_by_lua/init_worker_by_lua_file

    处理阶段:
        starting-worker
    使用范围:
        http
    解释:
        每个NginxWorker进程启动时调用的计时器,
        如果Master进程不允许则只会在init_by_lua之后调用;
        通常用于定时拉取配置/数据,或者后端服务的健康检查


指令: set_by_lua/set_by_lua_file

    处理阶段:
        rewrite
    使用范围:
        server,server if,location,location if
    解释:
        设置nginx变量,可以实现复杂的赋值逻辑;此处是阻塞的,Lua代码要做到非常快;


指令: rewrite_by_lua/rewrite_by_lua_file

    处理阶段:
        rewrite tail
    使用范围:
        http,server,location,location if
    解释:
        rewrite阶段处理,可以实现复杂的转发/重定向逻辑;


指令: access_by_lua/access_by_lua_file

    处理阶段:
        access tail
    使用范围:
        http,server,location,location if
    解释:
        请求访问阶段处理,用于访问控制


指令: content_by_lua/content_by_lua_file

    处理阶段:
        content
    使用范围:
        location,location if
    解释:
        内容处理器,接收请求处理并输出响应

指令: header_filter_by_lua/header_filter_by_lua_file

    处理阶段:
        output-header-filter
    使用范围:
        http,server,location,location if
    解释:
        设置header和cookie

指令:body_filter_by_lua/body_filter_by_lua_file

    处理阶段:
        output-body-filter
    使用范围:
        http,server,location,location if
    解释:
        对响应数据进行过滤,比如截断、替换。


指令:log_by_lua/log_by_lua_file

    处理阶段:
        log
    使用范围:
        http,server,location,location if
    解释:
        log阶段处理,比如记录访问量/统计平均响应时间
]]

ngx.var
-- nginx变量,如果要赋值如ngx.var.b = 2,此变量必须提前声明;
-- 另外对于nginx location中使用正则捕获的捕获组可以使用ngx.var[捕获组数字]获取;

ngx.var.request_uri
-- 这个变量等于包含一些客户端请求参数的原始URI,它无法修改,请查看$uri更改或重写URI。


ngx.var.scheme -- ngx.var.server_addr
-- HTTP方法(如http,https)。按需使用

ngx.var.server_addruri
-- 服务器地址,在完成一次系统调用后可以确定这个值,如果要绕开系统调用,则必须在listen中指定地址并且使用bind参数。

ngx.var.uri
-- 请求中的当前URI(不带请求参数,参数位于$args),可以不同于浏览器传递的$request_uri的值,它可以通过内部重定向,或者使用index指令进行修改。

ngx.var.server_name
-- 服务器名称

ngx.var.server_port
-- 请求到达服务器的端口号。

ngx.var.remote_addr
-- 获取远程的IP地址

ngx.var.remote_port
-- 获取远程的端口号

ngx.header
-- 输出响应头;

ngx.print
-- 输出响应内容体;

ngx.say
-- 通ngx.print,但是会最后输出一个换行符;

ngx.exit
-- 指定状态码退出。


ngx.redirect
-- 重定向;

ngx.status = 301
-- 设置响应的状态码;

ngx.resp.get_headers()
-- 获取设置的响应状态码;

ngx.send_headers()
-- 发送响应状态码, ,当调用ngx.say/ngx.print时自动发送响应状态码;

ngx.headers_sent = true
-- 判断是否发送了响应状态码。

ngx.req.get_headers
-- 获取请求头,默认只获取前100,如果想要获取所以可以调用ngx.req.get_headers(0);
-- 获取带中划线的请求头时请使用如headers.user_agent这种方式;
-- 如果一个请求头有多个值,则返回的是table;

ngx.req.get_uri_args
-- 获取url请求参数,其用法和get_headers类似;

ngx.req.get_post_args
-- 获取post请求内容体,其用法和get_headers类似,但是必须提前调用ngx.req.read_body()来读取body体
--(也可以选择在nginx配置文件使用lua_need_request_body on;开启读取body体,但是官方不推荐);

ngx.req.raw_header
-- 未解析的请求头字符串;

ngx.req.get_body_data
-- 为解析的请求body体内容字符串。

ngx.req.set_uri(uri, false)
-- 可以内部重写uri(可以带参数),等价于 rewrite ^ /lua_rewrite_3;
-- 通过配合if/else可以实现 rewrite ^ /lua_rewrite_3 break;
-- 这种功能;此处两者都是location内部url重写,不会重新发起新的

ngx.req.set_uri_args
-- 重写请求参数,可以是字符串(a=1&b=2)也可以是table;

ngx.escape_uri
ngx.unescape_uri
-- uri编码解码;

ngx.encode_args
ngx.decode_args
-- 参数编码解码;

ngx.encode_base64
ngx.decode_base64
-- BASE64编码解码;

ngx.re.match
-- nginx正则表达式匹配;

ngx.timer.at
-- 延时调用相应的回调方法;
-- ngx.timer.at(秒单位延时,回调函数,回调函数的参数列表);
-- 可以将延时设置为0即得到一个立即执行的任务,任务不会在当前请求中执行不会阻塞当前请求,而是在一个轻量级线程中执行。



-- 指令: init_by_lua
--[[
    nginx.conf配置文件中的http部分添加如下代码,

    #共享全局变量,在所有worker间共享
    lua_shared_dict shared_data 1m;
    init_by_lua_file /usr/example/lua/init.lua;
]]
--init.lua
--初始化耗时的模块
local redis = require 'resty.redis'
local cjson = require 'cjson'

--全局变量,不推荐
count = 1
--共享全局内存
local shared_data = ngx.shared.shared_data
shared_data:set("count", 1)

-- test.lua
count = count + 1
ngx.say("global variable : ", count)
local shared_data = ngx.shared.shared_data
ngx.say(", shared memory : ", shared_data:get("count"))
shared_data:incr("count", 1)
ngx.say("hello world")

-- 访问如http://192.168.1.2/lua 会发现全局变量一直不变,而共享内存一直递增
-- global variable : 2 , shared memory : 8 hello world
-- 另外注意一定在生产环境开启lua_code_cache,否则每个请求都会创建Lua VM实例。



-- 指令: init_worker_by_lua
--[[
    用于启动一些定时任务,比如心跳检查,定时拉取服务器配置等等;
    此处的任务是跟Worker进程数量有关系的,比如有2个Worker进程那么就会启动两个完全一样的定时任务。

    nginx.conf配置文件中的http部分添加如下代码:
    init_worker_by_lua_file /usr/example/lua/init_worker.lua;

    另外根据实际情况设置如下指令
    lua_max_pending_timers 1024;  #最大等待任务数
    lua_max_running_timers 256;   #最大同时运行任务数
]]

-- init_worker.lua
local count = 0
local delayInSeconds = 3
local heartbeatCheck = nil

heartbeatCheck = function(args)
    count = count + 1
    ngx.log(ngx.ERR, "do check ", count)
    local ok, err = ngx.timer.at(delayInSeconds, heartbeatCheck)
    if not ok then
        ngx.log(ngx.ERR, "failed to startup heartbeart worker...", err)
    end
end

heartbeatCheck()



-- 指令: set_by_lua
--[[
    设置nginx变量,我们用的set指令即使配合if指令也很难实现负责的赋值逻辑;
    语法set_by_lua_file $var lua_file arg1 arg2...;
    在lua代码中可以实现所有复杂的逻辑,但是要执行速度很快,不要阻塞;

    example.conf配置文件:
    location /lua_set_1 {
        default_type "text/html";
        set_by_lua_file $num /usr/example/lua/test_set_1.lua;
        echo $num;
    }
]]
-- test_set_1.lua
local uri_args = ngx.req.get_uri_args()
local i = uri_args["i"] or 0
local j = uri_args["j"] or 0
return i + j
-- 访问如http://192.168.1.2/lua_set_1?i=1&j=10进行测试。 如果我们用纯set指令是无法实现的。

免责声明:文章转载自《Openresty常用指令和参数》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇nginx配置使用tkinter学习01下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

freebsd+nginx+php+mysql+zend系统优化防止ddos +傻瓜式ports安装

前言 1. 看了张宴的《linux版本的Nginx 0.5.33 + PHP 5.2.5》后,马上找了一台服务器测试了一下,然后加了一个线上的discuz的论坛跑了一下,性能非常的卓越,感叹搜遍整个互联网,就是 nginx+php唯一的一篇文档。对于他的文档,我认为:写的非常专业,对于php extensions库也分析的非常透彻。但是一篇专业的文档,也存...

android Uri获取真实路径转换成File的方法

Uri uri = data.getData(); 02   03 String[] proj = { MediaStore.Images.Media.DATA }; 04   05 Cursor actualimagecursor = managedQuery(uri,proj,null,null,null); 06   07...

Nginx的高级使用

1、概述 之前介绍过Nginx的简单使用,今天来聊聊Nginx的一些高级使用。 2、使用Nginx解决跨域问题 当公司存在多个域名时,两个不同的域名相互访问就会存在跨域问题。 或者在进行前端开发时,通常前端代码在本地启动,而后端代码会部署在一台专用的后端开发服务器上,此时前端去调用后端接口时,就会出现跨域问题。 解决跨域的方法有很多,今天来说一下如何使用N...

nginx安装配置lua支持

nginx安装很简单,配置lua相关的支持就需要额外的安装一些库和编译。 一、准备环境 yum -y install lua*wget https://luajit.org/download/LuaJIT-2.0.4.tar.gz wget https://github.com/simpl/ngx_devel_kit/archive/v0.2.19.tar...

Mac安装PHP运行环境

先安装brew ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" nginx的安装与配置 brew install nginx 修改配置文件 sudo vim /usr/local/etc/nginx/nginx.conf #修...

Docker for Windows 使用入门

欢迎来到Docker for Windows! Docker是用于创建Docker应用程序的完整开发平台,Docker for Windows是在Windows系统上开始使用Docker的最佳方式。 如果你没有安装Docker for Windows,请阅读这篇文章:Windows 10 安装 Docker for Windows 检查Docker Eng...