description.md

概述

该模块通过标准 Lua5.1 解释器或 LuaJIT 2.0/2.1，把 Lua 嵌入到 NGINX 里面， 并利用 NGINX 子请求，把强大的 Lua 线程（Lua协程）混合到 NGINX 的事件模型中。

与 Apache's mod_lua、Lighttpd's mod_magnet 不同的是, 该模块中的 Lua 代码在网络上是 100% 非阻塞的。 包括该模块的 Nginx API for Lua， 上游请求服务如：MySQL、PostgreSQL、Memcached、Redis或upstream HTTP web 服务等，都是100%非阻塞的。

至少下面这些 Lua 库、NGINX 模块是可以与 ngx_lua 模块配合使用的：

• lua-resty-memcached
• lua-resty-mysql
• lua-resty-redis
• lua-resty-dns
• lua-resty-upload
• lua-resty-websocket
• lua-resty-lock
• lua-resty-string
• ngx_memc
• ngx_postgres
• ngx_redis2
• ngx_redis
• ngx_proxy
• ngx_fastcgi

几乎所有的 NGINX 模块都可以通过 ngx.location.capture 或 ngx.location.capture_multi 与 ngx_lua 模块完成调用，但推荐使用类似 lua-resty-* 库，而不是子请求访问 NGINX 上游模块，因为前者更加灵活并且内存效率更高。

在单个 NGINX worker 中，标准 Lua 或 LuaJIT 的实例在所有请求中是共享使用的，但每个请求上下文是通过轻量的 Lua 协程做到隔离的。

在 NGINX worker 进程中加载 Lua 模块，坚持小内存的使用，甚至在重负载下依然如此。

返回目录

English Source:

Description

This module embeds Lua, via the standard Lua 5.1 interpreter or LuaJIT 2.0/2.1, into Nginx and by leveraging Nginx's subrequests, allows the integration of the powerful Lua threads (Lua coroutines) into the Nginx event model.

Unlike Apache's mod_lua and Lighttpd's mod_magnet, Lua code executed using this module can be 100% non-blocking on network traffic as long as the Nginx API for Lua provided by this module is used to handle requests to upstream services such as MySQL, PostgreSQL, Memcached, Redis, or upstream HTTP web services.

At least the following Lua libraries and Nginx modules can be used with this ngx_lua module:

• lua-resty-memcached
• lua-resty-mysql
• lua-resty-redis
• lua-resty-dns
• lua-resty-upload
• lua-resty-websocket
• lua-resty-lock
• lua-resty-string
• ngx_memc
• ngx_postgres
• ngx_redis2
• ngx_redis
• ngx_proxy
• ngx_fastcgi

Almost all the Nginx modules can be used with this ngx_lua module by means of ngx.location.capture or ngx.location.capture_multi but it is recommended to use those lua-resty-* libraries instead of creating subrequests to access the Nginx upstream modules because the former is usually much more flexible and memory-efficient.

The Lua interpreter or LuaJIT instance is shared across all the requests in a single nginx worker process but request contexts are segregated using lightweight Lua coroutines.

Loaded Lua modules persist in the nginx worker process level resulting in a small memory footprint in Lua even when under heavy loads.

Back to TOC