Apache APISIX中利用Lua插件实现Redis存储响应体的实践

背景介绍

在API网关开发中，我们经常需要处理后端服务的响应数据，并将其存储到缓存系统中。Apache APISIX作为一款高性能的API网关，提供了强大的Lua插件机制，允许开发者灵活地处理请求和响应。本文将介绍如何在APISIX中实现一个将SOAP响应中的特定数据存储到Redis的解决方案。

技术挑战

在处理SOAP服务响应时，我们遇到了几个关键挑战：

1. 需要在body_filter阶段获取完整的响应体内容
2. 由于Nginx的限制，无法在body_filter阶段直接进行Redis操作
3. 需要跨插件共享解析后的数据
4. 对后端服务无修改权限，所有操作必须在网关层面完成

解决方案设计

第一阶段：响应体解析

我们首先创建一个专门用于解析响应体的插件，该插件工作在body_filter阶段：

local function extract_session_id(xml_string)
    local pattern = "<GetSessionIdResponse[^>]*>(.-)</GetSessionIdResponse>"
    local session_id = string.match(xml_string, pattern)
    
    if session_id then
        ngx.log(ngx.INFO, "Session ID: ", session_id)
        return session_id
    else
        ngx.log(ngx.ERR, "Failed to extract Session ID from XML response")
        return nil
    end
end

function _M.body_filter(conf, ctx)
    local body = core.response.hold_body_chunk(ctx)
    if not body then
        return core.log.warn("failed to hold response body chunk")
    end
    
    local sessionid = extract_session_id(body)
    ctx.sessionid = sessionid
end

这个插件通过正则表达式从SOAP响应中提取SessionID，并将其存储在请求上下文中。

第二阶段：Redis存储

由于无法在body_filter阶段直接操作Redis，我们采用以下策略：

1. 将Redis操作移至log阶段
2. 使用ngx.timer.at创建异步任务，避免阻塞主请求流程

function _M.log(conf, ctx)
    local function redis_client()
        local red = redis_new()
        local timeout = 1000  -- 1秒超时
        
        red:set_timeouts(timeout, timeout, timeout)
        
        local sock_opts = {
            ssl = conf.ssl,
            ssl_verify = conf.ssl_verify
        }

        local ok, err = red:connect("host.docker.internal", 6379, sock_opts)
        if not ok then
            return false, err
        end
        return red, nil
    end                
    
    local function save_redis()
        local redis_cli = redis_client()
        redis_cli:set(clientId, bodySession)
        redis_cli:expire(clientId, 50)
    end
    
    ngx.timer.at(0, save_redis)
end

关键技术点

1. 请求上下文共享

APISIX的ctx对象可以在同一请求的不同阶段和不同插件间共享数据。我们利用这一特性，在body_filter阶段将解析出的SessionID存储在ctx中，然后在log阶段取出使用。

2. 异步Redis操作

使用ngx.timer.at可以将Redis操作异步化，避免阻塞请求处理流程。这种方式虽然不能保证100%的存储成功率（如网关崩溃时可能丢失数据），但对于大多数场景已经足够。

3. 响应体处理

在body_filter阶段，我们需要使用core.response.hold_body_chunk来获取完整的响应体内容。需要注意的是，这个阶段可能被多次调用，因此需要正确处理分块响应。

性能考量

1. 连接池管理：Redis连接应该使用连接池，避免频繁创建和销毁连接
2. 超时设置：合理设置Redis操作超时，防止长时间阻塞
3. 错误处理：完善的错误处理和日志记录机制
4. 资源限制：控制并发定时器数量，防止资源耗尽

扩展思考

这种模式不仅适用于Redis存储，还可以扩展到其他场景：

1. 将响应数据写入Kafka等消息队列
2. 实现响应数据的实时分析
3. 构建API调用日志系统
4. 实现响应缓存机制

总结

通过APISIX的插件机制，我们成功实现了在不修改后端服务的情况下，对SOAP响应进行解析并存储到Redis的功能。这种方案展示了APISIX在处理复杂API网关需求时的灵活性和强大能力。关键在于合理利用请求上下文共享数据和异步操作机制，既保证了功能实现，又确保了系统性能。