Mastering Lua and OpenResty: From Basics to Real-World Deployment

When learning a new technology, common questions arise: What is Lua? Why use it? How to get started? This article answers those questions by highlighting Lua’s three main advantages—simple syntax, small size (≈300 KB compiled library for version 5.3), and high efficiency thanks to its C implementation and FFI support.

Application Scenarios

Security systems: dynamic loading for web‑server‑level intrusion detection and WAF rule updates.

Web APIs: lightweight CGI scripts for high‑performance core business interfaces.

Game development: server‑side logic that can be updated without full client patches.

Basic Syntax

Lua follows a procedural style but also supports object‑oriented patterns. A simple lua REPL prints "Hello World" and uses -- for single‑line comments and --[[ … --]] for block comments.

Data Types

Lua defines eight primitive types (nil, boolean, number, string, function, userdata, thread, table). An illustrative table image is omitted for brevity.

Operators

Arithmetic: + - * / % ^ - Relational: == ~= > < >= <= Logical: and or not Other: .. (string concatenation), # (length)

Variables

Variables are global by default; prefixing with local creates a local scope. Multiple assignment is supported:

a = 5 -- global variable local b = 5 -- local variable a, b = b, a -- swap values a, b, c = a+1, b+1, b+2 -- multiple assignment a, b, c = 0 -- assign same value

Control Structures

Lua provides if … then … else … end, while, for, and repeat … until loops. Syntax diagrams are omitted.

Functions

Define functions with the function keyword. Functions can return multiple values and accept variable arguments via ...:

function max(num1, num2) if num1 > num2 then return num1 else return num2 end end function add(...) local a, b, c = ... -- process arguments end

Tables and Arrays

Tables are the fundamental data structure, serving as arrays, dictionaries, and objects. Example of creating and iterating an array:

array = {"Lua", "PHP"} for i, v in ipairs(array) do print(i, v) end

Output:

1 Lua
2 PHP

Object‑Oriented Style

Classes can be simulated with tables and functions:

Rectangle = {area = 0, length = 0, breadth = 0} function Rectangle:new(o, length, breadth) o = o or {} setmetatable(o, self) self.__index = self self.length = length or 0 self.breadth = breadth or 0 self.area = length * breadth return o end

OpenResty Integration

OpenResty bundles Nginx, LuaJIT, and useful libraries, providing a powerful web‑application platform.

Key APIs

Request APIs: ngx.var, ngx.req.get_headers, ngx.req.get_uri_args, ngx.req.get_post_args, ngx.req.get_body_data Response APIs: ngx.header, ngx.print, ngx.say, ngx.exit,

ngx.redirect

Environment Deployment

Installation methods include Homebrew on macOS, YUM on CentOS, or building from source. Example for macOS:

brew tap openresty/brew brew install openresty

For source builds, download from http://openresty.org/cn/download.html, then:

tar -xzvf openresty-VERSION.tar.gz cd openresty-VERSION yum install pcre-devel openssl-devel gcc curl ./configure --prefix=/usr/local/webserver/openresty --with-luajit make && make install

Service Control

Start, reload, and quit the server using the -c flag to specify a custom nginx.conf:

/usr/local/webserver/openresty/nginx/sbin/nginx # start /usr/local/webserver/openresty/nginx/sbin/nginx -s reload # reload /usr/local/webserver/openresty/nginx/sbin/nginx -s quit # stop

Important Nginx‑Lua Directives

lua_package_path

: set custom Lua module search path. init_by_lua_file: load Lua code at the http level. content_by_lua_file / content_by_lua_block: embed Lua in location contexts. lua_code_cache: enable or disable Lua code caching (default on).

Classroom Exercise

Implement a Lua function that randomly redirects requests to www.baidu.com or www.qq.com with equal probability, preserving the original query parameters.

function redirect() local targets = {"https://www.baidu.com", "https://www.qq.com"} local choice = targets[math.random(2)] ngx.redirect(choice .. "?" .. ngx.var.args) end

This hands‑on task reinforces the concepts of random number generation, string concatenation, and the ngx.redirect API.