首页 / LUA / ngx_lua模块API说明

ngx_lua模块API说明

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了ngx_lua模块API说明，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含7879字，纯文字阅读大概需要12分钟。

内容图文

ngx_lua模块API说明#Ngx指令
lua_code_cache on | off;
作用:打开或关闭 Lua 代码缓存，影响以下指令： set_by_lua_file , content_by_lua_file, rewrite_by_lua_file, access_by_lua_file 及强制加载或者reload Lua 模块等.缓存开启时修改LUA代码需要重启nginx,不开启时则不用。开发阶段一般关闭缓存。
作用域：main, server, location, location if
lua_regex_cache_max_entries 1024;
作用：未知（貌似是限定缓存正则表达式处理结果的最大数量）
lua_package_path .../path... ;
作用：设置用lua代码写的扩展库路径。
例：lua_package_path '/foo/bar/?.lua;/blah/?.lua;;';
lua_package_cpath '/bar/baz/?.so;/blah/blah/?.so;;';
作用：设置C扩展的lua库路径。
set_by_lua $var '' [$arg1 $arg2];
set_by_lua_file $var [$arg1 $arg2 ...];
作用：设置一个Nginx变量，变量值从lua脚本里运算由return返回，可以实现复杂的赋值逻辑；此处是阻塞的，Lua代码要做到非常快.
另外可以将已有的ngx变量当作参数传进Lua脚本里去，由ngx.arg[1],ngx.arg[2]等方式访问。
作用域：main, server, location, server if, location if
处理阶段：rewrite
content_by_lua '';
content_by_lua_file luafile;
作用域：location, location if
说明：内容处理器，接收请求处理并输出响应，content_by_lua直接在nginx配置文件里编写较短Lua代码后者使用lua文件。
rewrite_by_lua ''
rewrite_by_lua_file lua_file;
作用域：http, server, location, location if
执行内部URL重写或者外部重定向，典型的如伪静态化的URL重写。其默认执行在rewrite处理阶段的最后.
注意，在使用rewrite_by_lua时，开启rewrite_log on;后也看不到相应的rewrite log。
access_by_lua 'lua code';
access_by_lua_file lua_file.lua;
作用：用于访问控制，比如我们只允许内网ip访问，可以使用如下形式。
access_by_lua '
if ngx.req.get_uri_args()["token"] ~= "123" then
return ngx.exit(403)
end ';
作用域：http, server, location, location if
header_filter_by_lua 'lua code';
header_filter_by_lua_file path_file.lua;
作用：设置header 和 cookie；
lua_need_request_body on|off;
作用：是否读请求体，跟ngx.req.read_body()函数作用类似,但官方不推荐使用此方法。
lua_shared_dict shared_data 10m;
作用：设置一个共享全局变量表，在所有worker进程间共享。在lua脚本中可以如下访问它：
例：local shared_data = ngx.shared.shared_data
10m 不知是什么意思。
init_by_lua 'lua code';
init_by_lua_file lua_file.lua;
作用域：http
说明：ginx Master进程加载配置时执行；通常用于初始化全局配置/预加载Lua模块
init_worker_by_lua 'lua code';
init_worker_by_lua_file luafile.lua;
作用域：http

说明：每个Nginx Worker进程启动时调用的计时器，如果Master进程不允许则只会在init_by_lua之后调用；通常用于定时拉取配置/数据，或者后端服务的健康检查。

######################

方法和常量
######################

ngx.arg[index]  			#ngx指令参数，当这个变量在set_by_lua或者set_by_lua_file内使用的时候是只读的，指的是在配置指令输入的参数.
ngx.var.varname  			#读写NGINX变量的值,最好在lua脚本里缓存变量值，避免在当前请求的生命周期内内存的泄漏
ngx.config.ngx_lua_version 	#当前ngx_lua模块版本号
ngx.config.nginx_version 	#nginx版本
ngx.worker.exiting 			#当前worker进程是否正在关闭
ngx.worker.pid				#当前worker进程的PID
ngx.config.nginx_configure	#编译时的./configure命令选项
ngx.config.prefix 			#编译时的prefix选项

core constans:				#ngx_lua 核心常量
	ngx.OK (0)
	ngx.ERROR (-1)
	ngx.AGAIN (-2)
	ngx.DONE (-4)
	ngx.DECLINED (-5)
	ngx.nil
http method constans:		#经常在ngx.location.catpure和ngx.location.capture_multi方法中被调用.
	ngx.HTTP_GET
	ngx.HTTP_HEAD
	ngx.HTTP_PUT
	ngx.HTTP_POST
	ngx.HTTP_DELETE
	ngx.HTTP_OPTIONS  
	ngx.HTTP_MKCOL    
	ngx.HTTP_COPY      
	ngx.HTTP_MOVE     
	ngx.HTTP_PROPFIND 
	ngx.HTTP_PROPPATCH 
	ngx.HTTP_LOCK 
	ngx.HTTP_UNLOCK    
	ngx.HTTP_PATCH   
	ngx.HTTP_TRACE  
http status constans: 		#http请求状态常量 
	ngx.HTTP_OK (200)
	ngx.HTTP_CREATED (201)
	ngx.HTTP_SPECIAL_RESPONSE (300)
	ngx.HTTP_MOVED_PERMANENTLY (301)
	ngx.HTTP_MOVED_TEMPORARILY (302)
	ngx.HTTP_SEE_OTHER (303)
	ngx.HTTP_NOT_MODIFIED (304)
	ngx.HTTP_BAD_REQUEST (400)
	ngx.HTTP_UNAUTHORIZED (401)
	ngx.HTTP_FORBIDDEN (403)
	ngx.HTTP_NOT_FOUND (404)
	ngx.HTTP_NOT_ALLOWED (405)
	ngx.HTTP_GONE (410)
	ngx.HTTP_INTERNAL_SERVER_ERROR (500)
	ngx.HTTP_METHOD_NOT_IMPLEMENTED (501)
	ngx.HTTP_SERVICE_UNAVAILABLE (503)
	ngx.HTTP_GATEWAY_TIMEOUT (504) 

Nginx log level constants：		#错误日志级别常量 ,这些参数经常在ngx.log方法中被使用.
	ngx.STDERR
	ngx.EMERG
	ngx.ALERT
	ngx.CRIT
	ngx.ERR
	ngx.WARN
	ngx.NOTICE
	ngx.INFO
	ngx.DEBUG

##################
#API中的方法：
##################
print()							#与 ngx.print()方法有区别，print() 相当于ngx.log()
ngx.ctx 						#这是一个lua的table，用于保存ngx上下文的变量，在整个请求的生命周期内都有效,详细参考官方
ngx.location.capture() 			#发出一个子请求，详细用法参考官方文档。
ngx.location.capture_multi() 	#发出多个子请求，详细用法参考官方文档。
ngx.status 						#读或者写当前请求的相应状态. 必须在

输出相应头之前被调用. ngx.header.HEADER #访问或设置http header头信息，详细参考官方文档。 ngx.req.set_uri() #设置当前请求的URI,详细参考官方文档 ngx.set_uri_args(args) #根据args参数重新定义当前请求的URI参数. ngx.req.get_uri_args() #返回一个LUA TABLE，包含当前请求的全部的URL参数 ngx.req.get_post_args() #返回一个LUA TABLE，包括所有当前请求的POST参数 ngx.req.get_headers() #返回一个包含当前请求头信息的lua table. ngx.req.set_header() #设置当前请求头header某字段值.当前请求的子请求不会受到影响. ngx.req.read_body() #在不阻塞ngnix其他事件的情况下同步读取客户端的body信息.[详细] ngx.req.discard_body() #明确丢弃客户端请求的body ngx.req.get_body_data() #以字符串的形式获得客户端的请求body内容 ngx.req.get_body_file() #当发送文件请求的时候，获得文件的名字 ngx.req.set_body_data() #设置客户端请求的BODY ngx.req.set_body_file() #通过filename来指定当前请求的file data。 ngx.req.clear_header() #清求某个请求头 ngx.exec(uri,args) #执行内部跳转，根据uri和请求参数 ngx.redirect(uri, status) #执行301或者302的重定向。 ngx.send_headers() #发送指定的响应头 ngx.headers_sent #判断头部是否发送给客户端ngx.headers_sent=true ngx.print(str) #发送给客户端的响应页面 ngx.say() #作用类似ngx.print，不过say方法输出后会换行 ngx.log(log.level,...) #写入nginx日志 ngx.flush() #将缓冲区内容输出到页面（刷新响应） ngx.exit(http-status) #结束请求并输出状态码 ngx.eof() #明确指定关闭结束输出流 ngx.escape_uri() #URI编码(本函数对逗号,不编码，而php的urlencode会编码) ngx.unescape_uri() #uri解码 ngx.encode_args(table) #将tabel解析成url参数 ngx.decode_args(uri) #将参数字符串编码为一个table ngx.encode_base64(str) #BASE64编码 ngx.decode_base64(str) #BASE64解码 ngx.crc32_short(str) #字符串的crs32_short哈希 ngx.crc32_long(str) #字符串的crs32_long哈希 ngx.hmac_sha1(str) #字符串的hmac_sha1哈希 ngx.md5(str) #返回16进制MD5 ngx.md5_bin(str) #返回2进制MD5 ngx.today() #返回当前日期yyyy-mm-dd ngx.time() #返回当前时间戳 ngx.now() #返回当前时间 ngx.update_time() #刷新后返回 ngx.localtime() #返回 yyyy-mm-dd hh:ii:ss ngx.utctime() #返回yyyy-mm-dd hh:ii:ss格式的utc时间 ngx.cookie_time(sec) #返回用于COOKIE使用的时间 ngx.http_time(sec) #返回可用于http header使用的时间 ngx.parse_http_time(str) #解析HTTP头的时间 ngx.is_subrequest #是否子请求（值为 true or false） ngx.re.match(subject,regex,options,ctx) #ngx正则表达式匹配，详细参考官网 ngx.re.gmatch(subject,regex,opt) #全局正则匹配 ngx.re.sub(sub,reg,opt) #匹配和替换（未知） ngx.re.gsub() #未知 ngx.shared.DICT #ngx.shared.DICT是一个table 里面存储了所有的全局内存共享变量 ngx.shared.DICT.get ngx.shared.DICT.get_stale ngx.shared.DICT.set ngx.shared.DICT.safe_set ngx.shared.DICT.add ngx.shared.DICT.safe_add ngx.shared.DICT.replace ngx.shared.DICT.delete ngx.shared.DICT.incr ngx.shared.DICT.flush_all ngx.shared.DICT.flush_expired ngx.shared.DICT.get_keys ndk.set_var.DIRECTIVE #不懂

#参考文档：

http://wiki.nginx.org/HttpLuaModuleZh#Core_constants ngx_lua官方文档
http://blog.csdn.net/imlsz/article/details/42915473 对官方API的主要内容翻译
http://jinnianshilongnian.iteye.com/blog/2186448 对ngx_lua使用文档有详细的例子
http://www.cnblogs.com/wangxusummer/p/4309007.html 对ngx_lua的模块方法的简单介绍

以上就介绍了ngx_lua 模块API说明，包括了方面的内容，希望对PHP教程有兴趣的朋友有所帮助。

内容总结

以上是互联网集市为您收集整理的ngx_lua模块API说明全部内容，希望文章能够帮你解决ngx_lua模块API说明所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/155649.html

来源：【匿名】

【上一篇】nginx+ngx_lua安装测试【下一篇】Nginx编译安装Lua模块

更多 ►

【ngx_lua模块API说明】教程文章相关的互联网学习教程文章

第四章 Lua模块开发

在实际开发中，不可能把所有代码写到一个大而全的lua文件中，需要进行分模块开发；而且模块化是高性能Lua应用的关键。使用require第一次导入模块后，所有Nginx 进程全局共享模块的数据和代码，每个Worker进程需要时会得到此模块的一个副本（Copy-On-Write），即模块可以认为是每Worker进程共享而不是每Nginx Server共享；另外注意之前我们使用init_by_lua中初始化的全局变量是每请求复制一个；如果想在多个Worker进程间共享数据可以...

Nginx一致性哈希模块的Lua实现【代码】【图】

Nginx一致性哈希模块的Lua重新实现技术背景：最近在工作中使用了nginx+redis 的架构，redis在后台做分布式存储，每个redis都存放不同的数据，这些数据都是某门户网站通过Hadoop分析出来的用户行为日志，key是uid，value是user profile，每小时更新量在500-800万条记录，而这些记录一旦生成，我需要在5分钟左右的时间完成所有导入过程。首先，我在nginx中使用了第三方模块HttpUpstreamConsistent来做负载均衡策略，针对不同用户（...

用C C++ 编写lua模块的一般模式【代码】

作为一种嵌入式语言，lua提供了一套完备的 C API来帮助 lua 与宿主程序进行交互。因此使用 C 或者 C++ 来为lua编写模块是很容易的。看一下lua （5.1）中对 string 模块的封装源码 lstrlib.c在 lstrlib.c 最后有这样的代码/** 将函数名与实际调用函数记录在一个 struct 中，并组成一个数组 --- 有点 lua 代码的赶脚 ---**/staticconst luaL_Reg strlib[] = {{"byte", str_byte},{"char", str_char},{"dump", str_dump},{"fi...

nginx_lua stream 模块编译

Nginx+lua编译安装一、安装准备源码选定目录 /root/sources 1.安装openssl、pcre、zlib库openssl下载地址：https://www.openssl.org/source/pcre下载：ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/zlib下载：http://zlib.net/ 2.安装必要的程序包 #yum -y install openssl-devel pcre-devel zlib-devel 3.安装openssl： #cd /root/sources #tar xf openssl-1.0.2j.tar.gz -C /usr/loc...

Lua cjson模块编译笔记及错误解决方法

使用文档：http://www.kyne.com.au/~mark/software/lua-cjson-manual.html 下载地址：http://www.kyne.com.au/%7Emark/software/download/lua-cjson-2.1.0.tar.gz编译时可能会报错，要修改Makefile文件：我下载的是lua jit版本，改了以下#部分内容复制代码代码如下: #LUA_INCLUDE_DIR = $(PREFIX)/include LUA_INCLUDE_DIR = $(PREFIX)/include/luajit-2.0/ #LUA_CMODULE_DIR = $(PREFIX)/lib/lua/$(LUA_VERSION) LUA_CMOD...

Nginx编译安装Lua模块

这篇文章主要介绍了关于Nginx编译安装Lua模块，有着一定的参考价值，现在分享给大家，有需要的朋友可以参考一下Nginx编译安装Lua模块一、安装Lua环境及相关库1、 LuaJITwget http://luajit.org/download/LuaJIT-2.0.2.tar.gz tar -zxvf LuaJIT-2.0.2.tar.gz cd LuaJIT-2.0.2 make install PREFIX=/usr/local/LuaJITexport LUAJIT_LIB=/usr/local/LuaJIT/lib export LUAJIT_INC=/usr/local/LuaJIT/include/luajit-2.02、 ngx_devel...

nginxlua模块常用的指令

lua_code_cache语法：lua_code_cache on | off默认： on适用上下文：http、server、location、location if这个指令是指定是否开启lua的代码编译缓存，开发时可以设置为off，以便lua文件实时生效，如果是生产线上，为了性能，建议开启。lua_package_path语法：lua_package_path默认：由lua的环境变量决定适用上下文：http设置lua代码的寻找目录。例如：lua_package_path "/opt/nginx/conf/www/?.lua;;";具体的路径设置要参考lua的模...

ngx_lua模块API说明

nginx-Brew安装lua模块brewnginxphpmacbrewnginx安装brewnginxphpmysq

环境:Mac、Brew安装brew安装很方便，安装完成后可以直接运行nginx的。安装nginxbrew install nginx-full - -with-lua-module后面的module选项可以通过如下命令查看:brew options nginx-full--with-accept-language-moduleCompile with support for Accept Language module --with-accesskey-moduleCompile with support for HTTP Access Key module --with-additionCompile with support for HTTP Addition module --with-lua-modu...

javascript-如何将所需的模块对象传递给操纵up page.evaluate【代码】

>木偶版：1.0.0>平台/操作系统版本：Windows 10> Node.js版本：8.9.3 这是我的代码：const puppeteer = require('puppeteer'); const varname = require('varname');...const page = await browser.newPage(); await page.goto(url); let generalInfo = await page.evaluate(() => {let elements = Array.from(document.querySelectorAll('#order-details > table > tbody > tr'));let res = {};elements.map((tr) => {let split =...

10. Unity3d Lua框架 - xLua - GameMain 定义为全局模块，整个lua程序的入口类在Unity中启动【代码】【图】

-- 全局模块 require "Global.Global"-- 定义为全局模块，整个lua程序的入口类 GameMain = {};-- 全局初始化 local function Initilize()local loadingAssetbundlePath = "UI/Prefabs/View/UILoading.prefab"ResourcesManager:GetInstance():CoLoadAssetBundleAsync(loadingAssetbundlePath) end-- 进入游戏 local function EnterGame()-- TODO：服务器信息应该从服务器上拉取，这里读取测试数据local ServerData = require "DataC...

Tengine添加nginx_lua_module模块

1、初始化系统环境 net.ipv4.ip_forward = 1net.ipv4.conf.default.rp_filter = 1net.ipv4.conf.default.accept_source_route = 0kernel.sysrq = 0kernel.core_uses_pid = 1net.ipv4.tcp_syncookies = 1kernel.msgmnb = 65536kernel.msgmax = 65536kernel.shmmax = 68719476736kernel.shmall = 4294967296net.ipv4.tcp_max_tw_buckets = 6000net.ipv4.tcp_sack = 1net.ipv4.tcp_window_scaling = 1net.ipv4.tcp_rmem = 4096 ...

docker – 如何在Alpine linux上为nginx添加Lua模块？【代码】

我希望在启用了Lua模块的情况下为nginx提供精简的Docker镜像.如何基于Alpine linux创建这个？解决方法:这是一个Dockerfile：FROM alpine:3.6RUN apk add --no-cache nginx-mod-http-lua# Delete default config RUN rm -r /etc/nginx/conf.d && rm /etc/nginx/nginx.conf# Create folder for PID file RUN mkdir -p /run/nginx# Add our nginx conf COPY ./nginx.conf /etc/nginx/nginx.confCMD ["nginx"]安装nginx-mod-http-lua软...

Lua在Linux上找不到LuaRocks安装的模块【代码】

我在Linux Mint上安装了luarocks包,然后安装了几个岩石如sudo luarocks安装望远镜,但是当通过lua script.lua运行脚本时,要求找不到该模块. Meta：做这个Q& A风格,因为虽然存在回答这个问题的问题,但似乎没有一个通常标题或容易找到,我希望我可以帮助这个人.解决方法:在这个特定的情况下,问题只是在我的发行版中,安装的默认Lua版本是在编写5.2时,而LuaRocks包是为5.1构建的,这意味着Lua 5.2由于使用不同而无法找到岩石模块的路径. 该...

nginx 增加 lua模块【代码】

Nginx中的stub_status模块主要用于查看Nginx的一些状态信息. 本模块默认是不会编译进Nginx的,如果你要使用该模块,则要在编译安装Nginx时指定: ./configure –with-http_stub_status_module 这个模块如果需要也可以加入 ######################### 下面是 lua模块 unknown directive "access_by_lua" unknown directive "set_unescape_uri" 之所以报错是缺少nginx的三方插件，下面介绍安装nginx的第三方插件，插件很多直介绍...

LUA - 相关标签

lua脚本 lua教程

LUA - 最热教程

盘点一下lua脚本和python的区别(基础)nginx+ngx_lua安装测试 Python和Lua的默认作用域以及闭包 Nginx LUA,如何输出文件？OpenResty：使用已经给定的/etc/nginx/...redis命令行执行lua脚本 Visual Studio 2019 编译调试lua源代码！！！注意区分 lua table 变量的【原...nginx 增加 lua模块在Nginx上使用Lua重定向到相同的URL(op...

首页 / LUA / ngx_lua模块API说明

ngx_lua模块API说明

内容导读

内容图文

内容总结

内容备注

内容手机端

【ngx_lua模块API说明】教程文章相关的互联网学习教程文章

LUA - 相关标签

LUA - 最新教程

LUA - 最热教程