Apache APISIX 中利用 serverless 插件修改响应体并添加新字段

在 API 网关的实际应用中，我们经常需要对上游服务的响应进行修改和增强。Apache APISIX 提供了多种方式来实现这一需求，其中 serverless 插件是一个非常灵活的选择。本文将详细介绍如何使用 serverless-post-function 插件来修改响应体内容并添加新的字段。

响应体修改的需求场景

在实际业务中，我们可能需要：

1. 保留原始响应的大部分内容，只修改特定字段
2. 基于请求头信息($http_*)向响应中添加新的字段
3. 对响应体进行复杂的转换处理

这些需求都可以通过 APISIX 的 serverless 插件来实现，特别是在 body_filter 阶段进行操作。

serverless-post-function 插件详解

serverless-post-function 插件允许我们在请求处理的不同阶段注入 Lua 代码。对于响应体修改的场景，我们需要在 body_filter 阶段进行操作。

基本配置示例

{
  "plugins": {
    "serverless-post-function": {
      "phase": "body_filter",
      "functions": [
        "return function (conf, ctx)
          local core = require(\"apisix.core\")
          local body = core.response.hold_body_chunk(ctx)
          -- 在这里处理响应体
          ngx.arg[1] = \"修改后的响应体内容\"
          ngx.arg[2] = true
        end"
      ]
    }
  }
}

关键点解析

1. phase 参数：必须设置为 "body_filter" 才能在响应体过滤阶段执行
2. hold_body_chunk：获取当前的响应体内容
3. ngx.arg[1]：设置修改后的响应体
4. ngx.arg[2]：设置为 true 表示这是最后一个数据块

实际应用示例

假设我们需要：

1. 保留原始 JSON 响应
2. 修改其中的某个字段
3. 添加基于请求头的新字段

return function (conf, ctx)
    local core = require("apisix.core")
    local body = core.response.hold_body_chunk(ctx)
    
    -- 解析JSON响应体
    local json_body, err = core.json.decode(body)
    if not json_body then
        core.log.error("failed to decode json: ", err)
        return
    end
    
    -- 修改现有字段
    if json_body["existing_field"] then
        json_body["existing_field"] = "new_value"
    end
    
    -- 添加基于请求头的新字段
    json_body["client_ip"] = ctx.var.remote_addr
    json_body["user_agent"] = ctx.var.http_user_agent
    
    -- 重新编码为JSON并设置响应
    ngx.arg[1] = core.json.encode(json_body)
    ngx.arg[2] = true
end

注意事项

1. 性能考虑：JSON 编解码会带来一定的性能开销，在高并发场景下需要评估影响
2. 错误处理：必须妥善处理 JSON 解析失败的情况
3. 大响应体：对于大响应体，需要考虑内存使用情况
4. 编码问题：确保响应体的编码正确处理

替代方案

除了 serverless 插件外，APISIX 还提供了：

1. response-rewrite 插件：适合简单的响应修改
2. 自定义插件开发：对于复杂需求可以开发专用插件

但 serverless 插件提供了最大的灵活性，特别适合快速原型开发和特殊场景处理。

总结

通过 APISIX 的 serverless-post-function 插件，我们可以在 body_filter 阶段灵活地修改响应体内容。这种方法虽然需要编写一些 Lua 代码，但提供了最大的控制能力，能够满足各种复杂的响应修改需求。在实际应用中，建议先评估性能影响，并在必要时考虑开发专用插件来优化性能。