Lua-Upstream-Cache-Nginx-Module 项目启动与配置教程

1. 项目的目录结构及介绍

Lua-Upstream-Cache-Nginx-Module 项目是一个用于扩展 lua-nginx 模块的功能，使其能够读取和设置 Nginx 内部缓存元数据的项目。项目的目录结构如下：

• /
  • src/：存放 Lua-Upstream-Cache-Nginx-Module 的源代码文件。
  • .github/：包含项目的 GitHub 工作流文件。
  • LICENSE：项目的许可证文件。
  • README.md：项目的说明文档。
  • .gitignore：指定 Git 忽略的文件和目录。

2. 项目的启动文件介绍

该模块不是一个独立的可执行项目，而是一个 Nginx 模块，因此没有传统的“启动文件”。要使用这个模块，需要按照以下步骤操作：

1. 将模块的源代码编译进 Nginx。
2. 确保在 Nginx 配置文件中正确配置了 Lua 和该模块。

编译 Nginx 时，需要添加模块的路径到 ./configure 命令中，例如：

./configure --with-http_lua_module --add-module=/path/to/lua-upstream-cache-nginx-module
make
make install

3. 项目的配置文件介绍

该模块的配置主要通过 Nginx 的配置文件进行，以下是一个基本的配置示例：

http {
    # 设置 Lua 包的路径
    lua_package_path '/path/to/your/lua/libs/?.lua;;';
    lua_package_cpath '/path/to/your/lua/extension/libs/?.so;;';

    server {
        listen       8000 default_server;
        server_name  localhost;

        location / {
            # 使用缓存
            proxy_cache pcache;
            proxy_pass http://127.0.0.1:8001/;

            # 缓存策略
            header_filter_by_lua '
                local http_cache = require("http_cache")
                local cache_status = (ngx.var.upstream_cache_status or "")
                if cache_status == "MISS" or cache_status == "EXPIRED" then
                    local cache_data = http_cache.get_metadata()
                    local new_expire = ngx.time() + 5
                    if cache_data and cache_data["valid_sec"] then
                        http_cache.set_metadata({
                            valid_sec = new_expire,
                            fcn = { valid_sec = new_expire, expire = new_expire }
                        })
                    end
                end
            ';
        }
    }
}

在上述配置中，lua_package_path 和 lua_package_cpath 用于设置 Lua 文件和 C 扩展库的搜索路径。proxy_cache 指定了缓存名称，proxy_pass 用于设置代理传递的地址。header_filter_by_lua 块中则是 Lua 代码，用于在响应头过滤阶段操作缓存元数据。

请确保在实际部署时根据具体情况调整路径和配置参数。