ngx_lua 모듈 API 설명

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 및 Lua 모듈 강제 로드 또는 다시 로드 등. 캐시가 활성화되면 LUA 코드를 수정하려면 nginx를 다시 시작해야 하지만 활성화되지 않은 경우에는 그렇지 않습니다. 캐싱은 일반적으로 개발 단계에서 꺼집니다.
범위: 메인, 서버, 위치, 위치 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 스크립트에서 계산되어 반환되며 이는 복잡한 할당 논리를 구현할 수 있으며 Lua 코드는 매우 빨라야 합니다.
또한 기존 ngx 변수를 Lua 스크립트에 매개변수로 전달하고 ngx.arg[1], ngx.arg[2] 등을 통해 액세스할 수 있습니다.
범위: 메인, 서버, 위치, 서버 if, 위치 if
처리 단계: 다시 쓰기
content_by_lua '';
content_by_lua_file luafile;
범위: 위치, 위치 if
설명: 콘텐츠 프로세서, 요청 처리를 수신하고 응답 출력, content_by_lua는 nginx 구성 파일에 직접 작성됨 Shorter Lua 후자는 lua 파일을 사용합니다.
rewrite_by_lua ''
rewrite_by_lua_file lua_file;
범위: http, server, location, location if
내부 URL 재작성 수행 쓰기 또는 외부 리디렉션(일반적으로 의사 정적 URL 재작성)입니다. 기본 실행은 다시 쓰기 처리 단계가 끝날 때입니다.
rewrite_by_lua를 사용하는 경우 rewrite_log on;을 켠 후에는 해당 다시 쓰기 로그를 볼 수 없습니다.
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, 서버, 위치, 위치 if
header_filter_by_lua 'lua 코드' ;
header_filter_by_lua_file path_file.lua;
기능: 헤더 및 쿠키 설정;
lua_need_request_body on|off;
기능: 요청 본문을 읽을지 여부 , ngx.req.read_body() 함수와 비슷한 효과가 있지만 이 방법은 공식적으로 권장되지 않습니다.
lua_shared_dict shared_data 10m;
기능: 모든 작업자 프로세스에서 공유할 공유 전역 변수 테이블을 설정합니다. 다음과 같이 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 작업자 프로세스가 시작될 때 호출되는 타이머입니다. 마스터 프로세스가 허용되지 않으면 일반적으로 구성/데이터를 정기적으로 가져오거나 백엔드 서비스의 상태 확인을 위해 사용됩니다.

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

메소드 및 상수
#### ## ##############

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 튜토리얼에 관심이 있는 친구들에게 도움이 되기를 바랍니다.