Apache APISIX中在body_filter阶段处理Redis连接的解决方案

背景介绍

在API网关开发中，我们经常需要处理后端服务的响应内容，并进行一些定制化操作。Apache APISIX作为一款高性能的API网关，提供了强大的插件机制来实现这些需求。本文将探讨在APISIX中处理SOAP响应并存储到Redis的技术实现方案。

问题分析

开发者在处理SOAP服务响应时遇到了一个典型的技术挑战：需要在body_filter阶段获取响应内容，并将特定数据存储到Redis中。然而，根据OpenResty的执行阶段限制，直接在body_filter_by_lua阶段建立Redis连接是不可行的。

主要技术难点包括：

1. 无法直接在后端服务中添加或修改功能
2. 需要解析SOAP响应中的特定字段(如SessionID)
3. 需要在网关层面实现响应内容的处理和存储

初始方案评估

开发者最初尝试了两种插件配合的方案：

1. 响应转换插件：在body_filter阶段捕获响应体，提取SessionID并存入上下文
2. Redis存储插件：在access阶段尝试从上下文获取SessionID并存入Redis

这个方案存在几个关键问题：

• 执行顺序问题：access阶段早于body_filter阶段执行
• 上下文共享问题：不确定上下文变量是否能跨插件共享
• Redis连接限制：无法在body_filter阶段直接操作Redis

优化解决方案

经过技术验证，最终采用了更合理的实现方式：

1. 保持响应解析在body_filter阶段：这是获取完整响应体的最佳位置
2. 将Redis操作移至log阶段：通过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. 阶段选择：

   • body_filter阶段：最适合获取和修改响应内容
   • log阶段：适合执行不影响主请求流程的后续操作

2. 异步处理：

   • 使用ngx.timer.at实现Redis操作的异步执行
   • 避免阻塞主请求处理流程
   • 提高系统整体吞吐量

3. 连接管理：

   • 为Redis连接设置合理的超时时间
   • 支持SSL/TLS安全连接
   • 每次操作创建新连接(简单场景)，生产环境可考虑连接池

最佳实践建议

1. 错误处理：应增加更完善的错误处理和重试机制
2. 连接复用：高频场景建议使用连接池优化性能
3. 超时配置：根据网络环境调整Redis连接超时时间
4. 资源清理：确保Redis连接正确关闭
5. 日志记录：添加适当的日志记录以便问题排查

总结

在Apache APISIX中处理类似需求时，理解OpenResty各执行阶段的特性至关重要。通过合理划分处理逻辑到不同阶段，并利用异步机制，可以优雅地解决在受限阶段访问外部服务的挑战。本文提供的方案不仅适用于SOAP响应处理，也可应用于其他需要在网关层实现响应内容处理和存储的场景。