Apollo网关层基于自定义指令实现字段聚合的方案咨询

一、解决自定义指令在超级图架构中丢失的问题 #

方案1：使用@tag指令配合网关配置 #

JS网关默认不会保留非标准指令，需手动配置保留规则，确保@tag能传递到超级图：

• 子图侧：显式声明@tag指令，标记目标字段，并通过composeDirective确保指令被允许组合到超级图：

import { composeDirective, buildSubgraphSchema } from '@apollo/subgraph';
import { GraphQLDirective, DirectiveLocation, GraphQLString } from 'graphql';

// 定义@tag指令
const tagDirective = new GraphQLDirective({
  name: 'tag',
  locations: [DirectiveLocation.FIELD_DEFINITION],
  args: {
    name: { type: GraphQLString }
  }
});

// 标记该指令可被组合到超级图
composeDirective('tag');

const typeDefs = `
  directive @tag(name: String!) on FIELD_DEFINITION

  type Product @key(fields: "id") {
    id: ID!
    price: Float! @tag(name: "aggregateme")
  }
`;

const resolvers = { /* 子图解析逻辑 */ };

export const schema = buildSubgraphSchema([{ typeDefs, resolvers }], {
  directives: [tagDirective]
});

• 网关侧：启用内省以便查看超级图中的指令，同时确保数据源配置不丢失指令信息：

import { ApolloGateway, RemoteGraphQLDataSource } from '@apollo/gateway';

const gateway = new ApolloGateway({
  serviceList: [/* 子图服务地址列表 */],
  buildService({ url }) {
    return new RemoteGraphQLDataSource({ url });
  },
  // 启用内省，方便验证指令是否存在于超级图
  introspection: true,
});

方案2：自定义@aggregateme指令的跨图传递 #

若坚持使用自定义指令，需在网关侧手动注入指令定义到超级图SDL：

import { ApolloGateway } from '@apollo/gateway';

const gateway = new ApolloGateway({
  serviceList: [/* 子图服务地址列表 */],
  async supergraphSdl({ sdl }) {
    // 在超级图SDL开头追加@aggregateme指令定义
    const directiveDef = `directive @aggregateme on FIELD_DEFINITION`;
    return `${directiveDef}\n${sdl}`;
  },
});

同时所有子图必须在自身schema中声明该指令，并标记目标字段。

二、解决网关执行钩子不生效的问题 #

Apollo Gateway v2.x的执行生命周期钩子需通过Apollo Server插件实现，而非直接配置网关：

import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';
import { ApolloGateway } from '@apollo/gateway';

// 自定义插件收集标记字段数据
const aggregationPlugin = {
  async requestDidStart() {
    const aggregatedFields = [];

    return {
      async executionDidStart() {
        return {
          async willResolveField({ info }) {
            // 检查字段是否带有目标指令
            const hasAggregatemeTag = info.fieldNodes.some(node => 
              node.directives?.some(dir => 
                dir.name.value === 'tag' && 
                dir.arguments?.some(arg => arg.name.value === 'name' && arg.value.value === 'aggregateme')
              )
            );
            const hasAggregatemeDirective = info.fieldNodes.some(node => 
              node.directives?.some(dir => dir.name.value === 'aggregateme')
            );

            if (hasAggregatemeTag || hasAggregatemeDirective) {
              // 组装字段完整路径
              const pathSegments = info.path.typename ? [info.path.typename] : [];
              pathSegments.push(info.path.key);
              const fieldPath = pathSegments.join('.');

              // 替换原解析函数，记录字段值
              const originalResolve = info.resolveFn;
              info.resolveFn = async (...args) => {
                const value = await originalResolve(...args);
                aggregatedFields.push({ path: fieldPath, value });
                return value;
              };
            }
          },
        };
      },
      async willSendResponse({ response }) {
        // 处理收集到的聚合数据（如存储、统计）
        console.log('聚合字段数据:', aggregatedFields);
        // 可将结果附加到响应头或响应体
        response.http.headers.set('X-Aggregated-Data', JSON.stringify(aggregatedFields));
      },
    };
  },
};

const gateway = new ApolloGateway({ /* 网关配置 */ });

const server = new ApolloServer({
  gateway,
  plugins: [aggregationPlugin], // 注册插件
});

const { url } = await startStandaloneServer(server, { listen: { port: 4000 } });

三、完整流程总结 #

1. 子图配置：在各子图声明目标指令，标记需聚合的字段，通过composeDirective允许指令进入超级图。
2. 网关配置：确保超级图保留指令定义，启用内省验证指令存在。
3. 插件实现：通过Apollo Server插件拦截执行生命周期，收集标记字段的路径与值，在响应发送阶段处理聚合数据。

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