OpenResty 是一个基于 Nginx 核心，集成了高性能 LuaJIT 运行时环境、Lua 库以及第三方 Nginx 模块的 Web 平台。把 Nginx 从一个传统的 Web 服务器和反向代理，升级为一个功能完备、高度可编程的 Web 应用服务器和 API 网关。

OpenResty 的目标是让 Web 服务直接运行在 Nginx 内部，充分利用其非阻塞 I/O 模型，不仅对 HTTP 客户端请求，甚至对远程后端服务都能进行高效的异步处理，构建出极致性能的分布式系统。

wget https://openresty.org/download/openresty-1.21.4.1.tar.gz

sudo apt-get install libpcre3-dev libssl-dev perl make build-essential curl

（4）配置：默认, --prefix=/usr/local/openresty 程序会被安装到/usr/local/openresty目录。

cd ~
export PATH=/usr/local/openresty/bin:$PATH

~$ openresty -v
nginx version: openresty/1.21.4.1

# 指定配置启动 openresty
# 需要指定工作目录，示例中的 . 表示当前目录为工作目录。
openresty -p . -c conf/nginx.conf
# 优雅退出
openresty -p . -s quit
# 重启 openresty
openresty -p . -s reload

三、开发实践：content_by_lua 阶段

（1）新建一个项目文件夹，项目文件夹新建三个子文件夹，分别是app、conf、logs，分别用来存放编写的应用程序、配置文件、日志文件。

mkdir my_openresty
cd my_openresty
mkdir app
mkdir conf
mkdir logs

worker_processes 2;
events {
    worker_connections 10240;
}
#######################
# 以下为配置块
#######################

# http 协议
http {
    #虚拟主机
    server {
        listen 8989;
        # 处理http请求
        # 捕获和处理
        location / {
            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
    }
}

#
# tcp 使用stream
#
# stream{
#    
#}

fly       15341  0.0  0.0  33264  1272 ?        Ss   17:23   0:00 nginx: master process openresty -p . -c conf/nginx.conf
fly       15342  0.0  0.3  37516  7276 ?        S    17:23   0:00 nginx: worker process
fly       15343  0.0  0.3  37516  7276 ?        S    17:23   0:00 nginx: worker process
fly       15345  0.0  0.0  15984   968 pts/2    S+   17:23   0:00 grep --color=auto nginx

（5）在浏览器输入服务器IP和端口，可以看到如下的结果：

四、开发实践：rewrite_by_lua 阶段

 阶段是 Nginx 请求处理的早期阶段，主要是 URL 重写或执行内部/外部重定向。在 

 阶段之前执行，所以非常适合进行请求的预处理。

worker_processes 2;
events {
    worker_connections 10240;
}
#######################
# 以下为nginx配置块
#######################

# http 协议
http {
    #虚拟主机
    server {
        listen 8989;
        # 处理http请求
        # 捕获和处理
        location / {
            # 初始化数据，可以在此阶段加载耗时模块、设置全局变量
            # init_by_lua_block {
            #     gloabl_a=100
            # }

            # 用于执行内部url重写或外部重定向
            rewrite_by_lua_block {
                local args = ngx.req.get_uri_args()
                if args["jump"] == "1" then
                    return ngx.redirect("http://baidu.com")
                elseif args["jump"] == "2" then
                    return ngx.redirect("/jump_here")
                end
            }

            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
        #  rewrite_by_lua不止能跳转到外部，也可以内部跳转
        location /jump_here {
            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello, jump_here","\t",ngx.var.remote_addr)
            }
        }
    }
}

#
# tcp 使用stream
#
# stream{
#    
#}

没有启动openresty，则输入如下命令启动：

如果是之前已经启动了，只需要reload即可：

五、开发实践：body_filter_by_lua 阶段

 阶段在 Nginx 将响应体发送给客户端之前执行，可以对响应体的内容进行修改。进行内容替换、压缩、加密等操作。

worker_processes 2;
events {
    worker_connections 10240;
}
#######################
# 以下为nginx配置块
#######################

# http 协议
http {
    #虚拟主机
    server {
        listen 8989;
        # 处理http请求
        # 捕获和处理
        location / {
            # 用于执行内部url重写或外部重定向
            rewrite_by_lua_block {
                local args = ngx.req.get_uri_args()
                if args["jump"] == "1" then
                    return ngx.redirect("http://baidu.com")
                elseif args["jump"] == "2" then
                    return ngx.redirect("/jump_here")
                end
            }

            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
        #  rewrite_by_lua不止能跳转到外部，也可以内部跳转
        location /jump_here {
            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello, jump_here","\t",ngx.var.remote_addr)
            }
            # 用于修改应答body的内容
            body_filter_by_lua_block {
                local chunk=ngx.arg[1]
                ngx.arg[1]=chunk:gsub("hello","FLY.")
            }
        }
    }
}

#
# tcp 使用stream
#
# stream{
#    
#}

 阶段实现，该阶段在请求被处理之前执行，非常适合进行访问控制、认证等逻辑。

新建nginx_new.conf文件，输入以下内容：

worker_processes 2;
events {
    worker_connections 10240;
}
#######################
# 以下为nginx配置块
#######################

# http 协议
http {
    #虚拟主机
    server {
        listen 8989;
        location / {
            access_by_lua_block {
                local block_list={
                    ["192.168.0.105"]=true
                }
                if block_list[ngx.var.remote_addr] then
                    return ngx.exit(403)
                end
            }
            
             # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
    }
}

注意，示例中的IP是写死在代码中的，在实际使用中不会这样来，一般存储在其他地方，比如redis。

worker_processes 2;
events {
    worker_connections 10240;
}
#######################
# 以下为nginx配置块
#######################

# http 协议
http {
    #虚拟主机
    server {
        listen 8989;
        location / {
            # 用于访问控制
            access_by_lua_block {
                local block_list={
                    ["192.168.0.105"]=true
                }
                if block_list[ngx.var.remote_addr] then
                    return ngx.exit(403)
                end
            }
            
             # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
        location /black_v1 {
            # 用于访问控制，通过文件
            access_by_lua_file ./app/black_v1.lua;
            
            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
    }
}

local redis = require "resty.redis"
local red=redis:new()

local ok,err=red:connect("127.0.0.1",6379)

if not ok then
    return ngx.exit(301)
end

local ip=ngx.var.remote_addr

local exists,err=red:sismember("black_list",ip)

if exists ==1 then
    return ngx.exit(403)
end

注意，要记得先运行redis，同时添加IP地址到KEY中。

127.0.0.1:6379> SADD black_list 192.168.0.105
(integer) 1
127.0.0.1:6379> keys *
1) "black_list"
127.0.0.1:6379> SMEMBERS black_list
1) "192.168.0.105"
127.0.0.1:6379> 

如果不知道有哪些接口可以使用，可以通过如下命令查询：

虽然把IP存储在了redis中，没有写死在代码里，但是每一次请求都要访问redis，这会导致整个系统的吞吐量降低；可以将这些数据写到共享内存中。

redis+共享内存方式。而且为了保证数据有效性，需要定期将redis中的数据拉取到共享内存中；那么就需要在init_worker_by_lua阶段添加定时器。

worker_processes 2;
events {
    worker_connections 10240;
}
#######################
# 以下为nginx配置块
#######################

# http 协议
http {
    # 创建共享内存
    lua_shared_dict bklist 1m;
    # 初始化数据，定时器
    init_worker_by_lua_file ./app/init_worker.lua;
    
    #虚拟主机
    server {
        listen 8989;
        location / {
            # 用于访问控制
            access_by_lua_block {
                local block_list={
                    ["192.168.0.105"]=true
                }
                if block_list[ngx.var.remote_addr] then
                    return ngx.exit(403)
                end
            }
            
             # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
        location /black_v1 {
            # 用于访问控制，通过文件
            access_by_lua_file ./app/black_v1.lua;

            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
        location /black_v2 {
            
            # 用于访问控制，通过文件
            access_by_lua_file ./app/black_v2.lua;

            # 内容处理,在配置中写代码
            content_by_lua_block {
                ngx.say("hello","\t",ngx.var.remote_addr)
            }
        }
    }
}

local bklist=ngx.shared.bklist

local ip=ngx.var.remote_addr

if bklist:get(ip) then
    return ngx.exit(403)
end

-- 只需要一个进程拉取数据即可。
if ngx.worker.id() ~=0 then
    return
end

-- 获取共享内存
local bklist =ngx.shared.bklist

local redis=require "resty.redis"


local function update_blacklist()
    local red=redis:new()
    local ok,err=red:connect("127.0.0.1",6379)

    if not ok then
        return
    end
    local black_list,err=red:smembers("black_list")
    bklist:flush_all()
    for _, v in pairs(black_list) do
        bklist:set(v,true);
    end
    ngx.timer.at(5,update_blacklist)
end

ngx.timer.at(5,update_blacklist)

OpenResty 继承了 Nginx 强大的反向代理能力。除了传统的 HTTP 反向代理，Nginx 的 

 模块还支持 TCP/UDP 层的反向代理。也可以使用 Lua 脚本实现更复杂的自定义代理逻辑。


worker_processes 4;

events {
    worker_connections 10240;
}

stream {
    upstream ups {
        server 127.0.0.1:8888;
    }
    server {
        listen 9999;
        proxy_pass ups;
        proxy_protocol on;
    }

    server {
        listen 9000;
        content_by_lua_file ./app/proxy.lua;
    }
}



local sock, err = ngx.req.socket()

if err then
    ngx.log(ngx.INFO, err)
end

local upsock, ok

upsock = ngx.socket.tcp()

ok, err = upsock:connect("127.0.0.1", 8989)
if not ok then
    ngx.log(ngx.INFO, "connect error:"..err)
end

upsock:send(ngx.var.remote_addr .. '\n')

local function handle_upstream()
    local data
    for i=1, 1000 do
        local reader = upsock:receiveuntil("\n", {inclusive = true})
        data, err, _ = reader()
        if err then
            sock:close()
            upsock:close()
            return
        end
        sock:send(data)
    end
end

ngx.thread.spawn(handle_upstream)

local data

while true do
    local reader = sock:receiveuntil("\n", {inclusive = true})
    data, err, _ = reader()
    if err then
        sock:close()
        upsock:close()
        return
    end
    upsock:send(data)
end


Openresty驱动下的高性能Web网关实战

OpenResty 是一个强大且灵活的平台，把高性能的 Nginx 服务器与 LuaJIT 即时编译器深度融合，旨在构建能够处理超高并发、具备极高扩展性的 Web 应用、API 服务和动态网关。

网络与通信

后端

开发工具

OpenResty是基于Nginx的高性能Web平台，集成了LuaJIT运行时环境，支持超高并发连接处理。本文详细介绍OpenResty安装配置、开发实践（如黑名单功能、反向代理等），以及如何利用其非阻塞I/O模型构建高性能Web应用和API网关。

日志文件

负载均衡

数据结构

虚拟主机

PostgreSQL

服务器

MySQL

4核4G3M云服务器 新用户低至38元/年！

lighthouse

11.11畅享AI算力 云启新增长

cngw

CDN 境内流量包 1元起 ，更有新老同享套餐包0.09元/GB起，立即选购


云数据库采购特惠，高性能、高可靠、高安全，超值优惠等你享！


文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

Openresty驱动下的高性能Web网关实战

Openresty驱动下的高性能Web网关实战

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐