NestJS Apollo Federation网关responseCachePlugin不生效问题咨询

问题根因 #

你当前使用的Apollo Server 2.x版本的responseCachePlugin原生未适配联邦网关的执行链路，默认不会触发网关级缓存命中，核心原因有两点：

• 缓存判定逻辑基于普通GraphQL服务执行流程设计，没有兼容联邦网关的查询计划执行链路，网关会直接将请求下发到子图，不会先做缓存校验。
• 默认配置下网关不会聚合下游子图返回的cache-control头，也没有自定义的缓存键生成规则，插件无法识别可缓存的响应和对应的唯一缓存标识。

适配v2.x版本的解决方案 #

你不需要升级依赖版本，按以下步骤调整配置即可：

步骤1：自定义responseCachePlugin的缓存规则 #

实例化插件时传入自定义的缓存键生成和会话隔离逻辑，确保不同查询、变量、用户权限对应的缓存键唯一：

plugins: [
  responseCachePlugin({
    // 自定义缓存键的核心关联数据，包含查询、变量、操作名等唯一标识
    extraCacheKeyData: (requestContext) => {
      return JSON.stringify({
        query: requestContext.request.query,
        variables: requestContext.request.variables,
        operationName: requestContext.request.operationName
      })
    },
    // 按业务需要配置缓存隔离规则：公共查询返回固定值，需用户隔离的查询返回用户唯一标识
    sessionId: (requestContext) => {
      return requestContext.context.userId || 'public'
    }
  })
],

步骤2：开启网关的子图缓存头聚合能力 #

调整网关配置，开启cacheControl开关，让网关自动聚合所有子图返回的缓存TTL，取最小TTL作为整体响应的缓存有效期：

gateway: {
  ...getSupergraphSchema('schema.gql', configService.env),
  // 开启子图缓存头聚合配置
  cacheControl: {
    enabled: true,
    defaultMaxAge: 5,
    calculateHttpHeaders: true
  }
}

可选兜底方案 #

如果上述配置仍不生效，可以自定义网关缓存插件：在网关willSendRequest钩子中优先查询缓存，命中则直接返回响应，未命中再下发到子图，拿到子图响应后写入缓存即可。

联邦架构缓存运行机制说明 #

• 子图级缓存：仅缓存单个子图的字段解析结果，只能降低单个子图的解析压力，联邦查询仍需要网关向所有关联子图发起请求。
• 网关级缓存：缓存完整的联邦查询响应结果，命中后完全不需要向下游子图发起请求。实现时需要保证缓存键覆盖所有影响响应结果的维度（查询语句、变量、用户权限等），同时聚合所有子图的TTL取最小值作为缓存有效期，避免数据不一致。
• Apollo Server 2.x版本的联邦网关对缓存的原生支持度极低，大部分逻辑需要自定义实现；3.x及以上版本原生支持网关级响应缓存，后续如果可以升级版本可以直接使用原生能力，减少自定义开发量。

内容的提问来源于stack exchange，提问作者Christophe Blin