如何使用Lua读取文件设置Nginx(OpenResty)变量

该需求完全可以实现，相比envsubst注入环境变量的方案，Lua读取本地文件赋值Nginx变量的方式不需要修改容器启动入口点，确实能简化Kubernetes部署配置，是可落地的实现方案。

• set_by_lua*指令的执行上下文为受限执行环境，原生Lua提供的io阻塞操作类API被官方默认禁用，直接调用io.open会直接抛出运行时错误，这是触发500的核心原因。
• 原代码未添加文件打开失败的容错逻辑，即便API可正常调用，遇到文件不存在、进程无读权限、文件为空的场景也会直接触发异常。
• 原代码中file变量未加local声明，会污染全局变量空间，存在潜在稳定性风险。

根据文件内容是否会动态更新，选择对应实现即可：

方案1：内容固定时性能最优（推荐K8s ConfigMap/Secret挂载场景使用） #

如果文件内容在Pod启动后不会频繁变动，直接在Nginx Worker进程启动阶段读取一次文件，缓存到内存中，后续请求直接从内存取值，完全没有额外IO开销：

http {
    # 提前声明目标Nginx变量
    set $a_key "";

    # Worker启动时仅执行一次读文件逻辑
    init_worker_by_lua_block {
        local file_path = "/tmp/string.txt"
        local f, err = io.open(file_path, "r")
        if not f then
            ngx.log(ngx.ERR, "failed to open config file ", file_path, ": ", err)
            package.loaded.app_config = {a_key = ""}
            return
        end
        -- 读第一行内容，如需读取全文件可将参数改为"*a"
        local content = f:read("*l")
        f:close()
        -- 内容缓存到模块级变量，所有请求共享
        package.loaded.app_config = {
            a_key = content or ""
        }
    }

    server {
        listen 80;
        location / {
            # 直接从缓存取值赋值给Nginx变量
            set_by_lua_block $a_key {
                return package.loaded.app_config.a_key
            }

            # 后续可正常使用$a_key，例如传给上游服务
            # proxy_set_header X-App-Key $a_key;
        }
    }
}

方案2：动态读取最新文件内容 #

如果文件内容会动态更新，需要每次请求获取最新值，不要在set_by_lua阶段做IO操作，移到access_by_lua阶段执行，建议增加短时间缓存减少磁盘IO压力：

http {
    set $a_key "";
    # 可选：配置1m大小的共享内存缓存，设置10s过期避免每次请求读磁盘
    lua_shared_dict config_cache 1m;

    server {
        listen 80;
        location / {
            access_by_lua_block {
                local cache = ngx.shared.config_cache
                local cache_key = "a_key"
                -- 先查缓存
                local val = cache:get(cache_key)
                if val then
                    ngx.var.a_key = val
                    return
                end

                -- 缓存未命中再读文件
                local f, err = io.open("/tmp/string.txt", "r")
                if not f then
                    ngx.log(ngx.ERR, "read config file failed: ", err)
                    ngx.exit(500)
                    return
                end
                val = f:read("*l") or ""
                f:close()

                -- 写入缓存，过期时间可按需调整
                cache:set(cache_key, val, 10)
                ngx.var.a_key = val
            }

            # 后续正常使用$a_key即可
        }
    }
}

• 生产环境禁止每次请求直接读磁盘无缓存，高并发下磁盘IO会成为明显的性能瓶颈。
• 要确认Nginx Worker进程对目标文件有读权限，Kubernetes场景下注意ConfigMap/Secret挂载的文件权限配置，避免非root用户运行的Nginx进程无权限读文件。
• 所有文件操作必须加异常容错逻辑，避免单个配置文件异常导致整个请求500。

内容的提问来源于stack exchange，提问作者JustCatchingRye