Lua-Resty-Mlcache 使用教程

项目介绍

Lua-Resty-Mlcache 是一个为 OpenResty 设计的分层缓存库。它结合了 lua_shared_dict API 和 lua-resty-lrucache 的强大功能，提供了一个极其高效和灵活的缓存解决方案。该库支持缓存和负缓存（negative caching），内置互斥锁（mutex）防止缓存击穿，以及跨工作进程的通信机制，以便在缓存失效时更新 L1 缓存。

项目快速启动

安装

首先，确保你已经安装了 LuaRocks。然后使用以下命令安装 Lua-Resty-Mlcache：

luarocks install lua-resty-mlcache

配置和使用

在你的 Nginx 配置文件中，添加以下配置：

http {
    lua_shared_dict cache_dict 1m;
    lua_code_cache on;

    init_by_lua_block {
        local mlcache = require "resty.mlcache"
        local cache, err = mlcache.new("my_cache", "cache_dict", {
            lru_size = 500,  -- L1 缓存大小
            ttl = 3600,      -- 缓存有效期 1 小时
            neg_ttl = 30     -- 负缓存有效期 30 秒
        })
        if not cache then
            error("failed to create mlcache: " .. err)
        end
        _G.cache = cache  -- 将缓存实例全局化，方便使用
    }

    server {
        listen 8080;

        location / {
            content_by_lua_block {
                local function callback(username)
                    return db:get_user(username)  -- 从数据库获取用户信息
                end

                local value, err = cache:get("user_key", { callback = callback })
                if err then
                    ngx.say("Error: ", err)
                else
                    ngx.say("Value: ", value)
                end
            }
        }
    }
}

应用案例和最佳实践

应用案例

Lua-Resty-Mlcache 适用于需要高性能缓存解决方案的场景，例如：

• API 网关缓存：在 API 网关中缓存频繁访问的数据，减少后端服务的负载。
• 动态配置缓存：缓存动态配置数据，减少对配置管理服务的频繁访问。

最佳实践

• 合理设置 TTL：根据数据更新的频率合理设置缓存的有效期（TTL），避免缓存数据过时。
• 使用负缓存：对于不存在的数据，使用负缓存可以减少对后端服务的无效请求。
• 监控和调优：定期监控缓存的命中率和性能，根据实际情况调整缓存配置。

典型生态项目

Lua-Resty-Mlcache 可以与以下项目结合使用，以构建更强大的系统：

• OpenResty：作为核心服务器，提供高性能的 Web 服务和 API 网关。
• Lua-Resty-Redis：与 Redis 结合，实现分布式缓存和数据共享。
• Lua-Resty-MySQL：与 MySQL 结合，实现高效的数据访问和缓存。

通过这些项目的结合使用，可以构建出高性能、可扩展的 Web 应用和 API 服务。