Nginx利用http块init_by_lua在启动时初始化配置

夜晨同学_9181

夜晨同学_9181

2026-04-10

975人浏览

原创

init_by_lua_block用于master进程启动前的全局初始化,可加载配置、预热缓存、创建共享字典,但不能修改nginx配置结构或动态添加server/location块。

nginx利用http块init_by_lua在启动时初始化配置

Nginx 的 init_by_lua 指令(现推荐使用 init_by_lua_block)确实可用于在 master 进程启动、worker 进程 fork 之前执行 Lua 代码,常被用来做全局初始化,比如加载配置、预热缓存、建立共享字典或连接池等。但它**不能直接用于“初始化 Nginx 自身的 http 块配置”**(如动态添加 server、location 或修改内置指令行为),因为此时 Nginx 配置已解析完毕,语法树已固化。

init_by_lua 的真实作用范围

它运行在 Nginx 配置加载之后、事件循环开始之前,属于 Lua 环境的“早期初始化阶段”。可安全执行的操作包括:

  • 初始化 ngx.shared.DICT 共享内存字典(如 ngx.shared.config:flush_all() 或预设初始值)
  • 加载外部配置文件(JSON/YAML/TOML)并存入共享字典或全局 Lua table,供后续请求读取
  • 建立全局连接池(如 Redis、MySQL 连接池),但注意:这些连接属于 master 进程上下文,不能被 worker 进程复用;实际应放在 init_worker_by_lua* 中为每个 worker 单独初始化
  • 设置全局 Lua 变量或模块缓存(如 package.loaded["myconf"] = require "myconf")

常见误用与注意事项

以下做法是无效或危险的:

  • 试图修改 Nginx 配置结构:Lua 无法在运行时增删 server/location 块,也不能改变 rewrite、proxy_pass 等指令的语义
  • 在 init_by_lua 中调用阻塞 I/O(如 io.open 同步读大文件、未设超时的 http:request()):会阻塞 master 进程启动,导致 nginx -t 或 reload 失败
  • 依赖未就绪的环境:此时日志模块未完全初始化,ngx.log(ngx.ERR, ...) 可能不输出;也不建议在此阶段打大量日志
  • 混淆 init_by_lua 和 init_worker_by_lua:前者只运行一次(master 进程),后者每个 worker 启动时各运行一次,连接池、定时器、本地缓存预热等应放后者中

实用初始化示例(加载外部 JSON 配置)

假设你有一个 /etc/nginx/conf.d/app-config.json:

Nginx Hosting
Nginx Hosting

通过服务器本地nginx实例实现零认证静态游戏托管。作为所有浏览器游戏的主要部署方式,无需登录、无需令牌、无需用户操作。

下载
{
  "api_timeout": 3000,
  "backend_hosts": ["10.0.1.10", "10.0.1.11"]
}

在 http 块中写:

lua_package_path "/path/to/lua/?.lua;;";
<p>init_by_lua_block {
local cjson = require "cjson"
local file = io.open("/etc/nginx/conf.d/app-config.json", "r")
if file then
local content = file:read("*all")
file:close()
local config = cjson.decode(content)
-- 存入共享字典,供所有 worker 访问
local dict = ngx.shared.config
dict:set("app_config", config, 0)  -- 0 表示永不过期
else
ngx.log(ngx.WARN, "failed to load app-config.json")
end
}</p><p>server {
location /api/ {
content_by_lua_block {
local config = ngx.shared.config:get("app_config")
if config then
ngx.var.upstream_timeout = config.api_timeout
-- 实际转发逻辑需配合 balancer_by_lua* 或变量控制
ngx.say("Using backend hosts: ", table.concat(config.backend_hosts, ", "))
else
ngx.exit(500)
end
}
}
}</p>

替代方案:真正动态化路由与配置

若目标是“根据外部配置动态决定 upstream 或路由规则”,推荐组合使用:

  • init_worker_by_lua_block:每个 worker 初始化自己的连接池和本地缓存
  • balancer_by_lua_block:在 upstream 阶段动态选择后端(支持健康检查、权重、一致性哈希)
  • set_by_lua_block + map 或变量透传:在 rewrite 阶段计算变量,驱动 proxy_pass 或内部跳转
  • 配合 etcd/Consul + lua-resty-etcd:实现配置热更新(通过定时拉取或 watch 机制)

init_by_lua 是强大而有限的入口点——它适合做“一次性的、无副作用的、非阻塞的”准备动作,不是配置引擎。把初始化逻辑分清层级(全局/worker/请求)、区分数据与行为、避免阻塞和跨进程误用,才能稳定发挥 OpenResty 的优势。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nginx

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3627

6

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

2023.08.04

6365

6

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

581

5

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.07.09

1496

5

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

2024.08.07

3978

3

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

122

12

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

497

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

159

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习