API参考：订阅回调插件

此文档涵盖了在Apollo Federation中使用订阅回调插件的用法与GraphOS Router。有关该协议本身的更多信息，请参阅订阅回调协议。

使用插件

本文档介绍了ApolloServerPluginSubscriptionCallback插件的选项，您可以从中@apollo/server/plugin/subscriptionCallback导入。

此插件使您的 GraphQL服务器能够通过订阅操作以使用订阅回调协议. GraphOS Router使用此协议执行订阅操作并从由路由器指定的URL接收更新。

此功能只能通过在您的ApolloServer构造函数中提供ApolloServerPluginSubscriptionCallback实例来启用：

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSubscriptionCallback } from '@apollo/server/plugin/subscriptionCallback';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSubscriptionCallback()],
8
});

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSubscriptionCallback } from '@apollo/server/plugin/subscriptionCallback';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSubscriptionCallback()],
8
});

注意事项

订阅插件实现本质上绕过了Apollo Server的请求生命周期。这意味着在处理回调订阅请求或发送订阅事件时，某些插件钩子（特别是executionDidStart和willResolveField）不会调用。目前没有对回调订阅的指标或跟踪支持。

选项

1
{
2
  retries: 5,
3
  minTimeout: 100,
4
  maxTimeout: 1000,
5
}

1
new ApolloServer({
2
  plugins: [
3
    ApolloServerPluginSubscriptionCallback({
4
      retry: {
5
        retries: 3,
6
        minTimeout: 1000,
7
        maxTimeout: 5000,
8
        randomize: true,
9
      },
10
    }),
11
  ],
12
  // ...
13
})