API 参考：Drain HTTP 服务器插件

使用此插件

ⓘ 注意

以下示例中，我们使用顶层 await 调用来异步启动我们的服务器。如果您想查看我们如何设置，请查阅入门指南以获取详细资料。

本文档记录了 ApolloServerPluginDrainHttpServer 插件的可选方案，您可以从 @apollo/server/plugin/drainHttpServer 中导入。

此插件旨在与 expressMiddleware 以及其他框架集成结合使用，这些框架建立在 Node http.Server 之上。我们强烈推荐使用此插件以确保您的服务器优雅地关闭。

您不需要与 startStandaloneServer 函数一起使用此插件；它自动处理服务器排空。

当您使用此插件时，Apollo Server 将在您调用 stop() 方法（当收到 SIGTERM 和 SIGINT 信号时，这也会为您调用，除非使用 stopOnTerminationSignals 构造函数选项禁用）时终止您的 HTTP 服务器。

具体来说，它会

停止监听新的连接
关闭空闲连接（即没有当前 HTTP 请求的连接）
一旦活动连接变为空闲，即关闭它们
等待所有连接关闭
经过一段宽限期后，如果仍有活动连接，将强制关闭它们

此插件由 @apollo/server 包导出。以下是如何与其 Express 一起使用的简单示例：

index.ts

1
import { ApolloServer } from '@apollo/server';
2
import { expressMiddleware } from '@apollo/server/express4';
3
import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
4
import express from 'express';
5
import http from 'http';
6
import cors from 'cors';
7
import { typeDefs, resolvers } from './schema';
8

9
interface MyContext {
10
  token?: String;
11
}
12

13
const app = express();
14
// Our httpServer handles incoming requests to our Express app.
15
// Below, we tell Apollo Server to "drain" this httpServer,
16
// enabling our servers to shut down gracefully.
17
const httpServer = http.createServer(app);
18

19
const server = new ApolloServer<MyContext>({
20
  typeDefs,
21
  resolvers,
22
  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
23
});
24
await server.start();
25

26
app.use(
27
  '/graphql',
28
  cors<cors.CorsRequest>(),
29
  express.json(),
30
  expressMiddleware(server, {
31
    context: async ({ req }) => ({ token: req.headers.token }),
32
  }),
33
);
34

35
await new Promise<void>((resolve) => httpServer.listen({ port: 4000 }, resolve));
36

37
console.log(`🚀 Server ready at https://127.0.0.1:4000/graphql`);

index.js

1
import { ApolloServer } from '@apollo/server';
2
import { expressMiddleware } from '@apollo/server/express4';
3
import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
4
import express from 'express';
5
import http from 'http';
6
import cors from 'cors';
7
import { typeDefs, resolvers } from './schema';
8

9
const app = express();
10
// Our httpServer handles incoming requests to our Express app.
11
// Below, we tell Apollo Server to "drain" this httpServer,
12
// enabling our servers to shut down gracefully.
13
const httpServer = http.createServer(app);
14

15
const server = new ApolloServer({
16
  typeDefs,
17
  resolvers,
18
  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
19
});
20
await server.start();
21

22
app.use(
23
  '/graphql',
24
  cors(),
25
  express.json(),
26
  expressMiddleware(server, {
27
    context: async ({ req }) => ({ token: req.headers.token }),
28
  }),
29
);
30

31
await new Promise((resolve) => httpServer.listen({ port: 4000 }, resolve));
32

33
console.log(`🚀 Server ready at https://127.0.0.1:4000/graphql`);

选项

名称 / 类型	描述
`httpServer` `http.Server`	要排空的服务器；必需。
`stopGracePeriodMillis` `数字`	在强制关闭非空闲连接之前需要等待多长时间。默认值为 `10_000` （十秒）。

API 参考：Drain HTTP 服务器插件

使用此插件

选项

`httpServer`

`stopGracePeriodMillis`