API 参考：startStandaloneServer

本 API 参考文档描述了startStandaloneServer函数。

概述

此startStandaloneServer函数帮助您快速入门Apollo Server。此函数适用于所有不需要无服务器支持或特定 Node.js 框架（如 Fastify）的项目。在底层，startStandaloneServer函数使用 Apollo Server 4 的 Express集成（即expressMiddleware）。

由于其设置了有用的默认值，此函数的配置性不如其他 Apollo Server集成。复杂的项目最终可能需要切换到使用 expressMiddleware（此过程简单直接）。

`startStandaloneServer`

ⓘ 注意

在下面的示例中，我们使用顶级await调用以异步方式启动服务器。如果您想了解我们如何设置此配置，请查阅开始指南以获取详细信息。

此startStandaloneServer函数接受两个参数。第一个必需参数是开始监听输入请求的ApolloServer实例：

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3

4
const server = new ApolloServer({ typeDefs, resolvers });
5

6
// `startStandaloneServer` returns a `Promise` with the
7
// the URL that the server is listening on.
8
 const { url } = await startStandaloneServer(server);

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3

4
const server = new ApolloServer({ typeDefs, resolvers });
5

6
// `startStandaloneServer` returns a `Promise` with the
7
// the URL that the server is listening on.
8
 const { url } = await startStandaloneServer(server);

The startStandaloneServer function's second optional argument is an object for configuring your server's options, which can contain the following properties:

选项

名称类型	描述
`context` `Function`	一个可选的异步 `context` 初始化函数 The `context` function should return an object that all your server's resolvers share during an operation's execution. This enables resolvers to share helpful context values, such as a database connection. The `context` function receives `req` and `res` options which are `http.IncomingMessage` and `http.ServerResponse` types.
`listen` `Object`	一个可选的 `listen` 配置对象。The `listen` 选项接受具有与 `net.Server.listen` 选项对象相同属性的的对象。如果没有指定 `port`，则默认使用 `{port: 4000}`。

示例

下面是设置 startStandaloneServer 的完整示例：

1
// npm install @apollo/server graphql
2
import { ApolloServer } from '@apollo/server';
3
import { startStandaloneServer } from '@apollo/server/standalone';
4
import { typeDefs, resolvers } from './schema';
5

6
interface MyContext {
7
  token?: String;
8
}
9

10
const server = new ApolloServer<MyContext>({ typeDefs, resolvers });
11
const { url } = await startStandaloneServer(server, {
12
  context: async ({ req }) => ({ token: req.headers.token }),
13
  listen: { port: 4000 },
14
});
15
console.log(`🚀  Server ready at ${url}`);

1
// npm install @apollo/server graphql
2
import { ApolloServer } from '@apollo/server';
3
import { startStandaloneServer } from '@apollo/server/standalone';
4
import { typeDefs, resolvers } from './schema';
5

6
const server = new ApolloServer({ typeDefs, resolvers });
7
const { url } = await startStandaloneServer(server, {
8
  context: async ({ req }) => ({ token: req.headers.token }),
9
  listen: { port: 4000 },
10
});
11
console.log(`🚀  Server ready at ${url}`);

切换到 `expressMiddleware`

The startStandaloneServer 函数并不适用于所有用例，尤其是当你需要自定义服务器行为时。例如，你可能想要自定义 CORS 行为，在处理 GraphQL 请求之前运行一些中间件，或从同一服务器提供其他端点。

在这些情况下，我们建议您将 startStandaloneServer 替换为 expressMiddleware （除非您确信要使用不同的Node.js框架）。这个更改只需要几行，并且对服务器现有行为的影响最小（startStandaloneServer 在内部使用 expressMiddleware）。

我们推荐Express，因为它是最受欢迎的Node.js网络框架，并且与许多其他流行库集成良好。它确实有一些限制（例如，Express的异步支持不是基于 Promise 和 async 函数），但是与较新的库相比，框架中的向后不兼容的更改更少。

示例

假设我们当前的 startStandaloneServer 设置使用以下代码：

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3
import { typeDefs, resolvers } from './schema';
4

5
interface MyContext {
6
  token?: String;
7
}
8

9
const server = new ApolloServer<MyContext>({ typeDefs, resolvers });
10
const { url } = await startStandaloneServer(server, {
11
  context: async ({ req }) => ({ token: req.headers.token }),
12
  listen: { port: 4000 },
13
});
14
console.log(`🚀  Server ready at ${url}`);

1
import { ApolloServer } from '@apollo/server';
2
import { startStandaloneServer } from '@apollo/server/standalone';
3
import { typeDefs, resolvers } from './schema';
4

5
const server = new ApolloServer({ typeDefs, resolvers });
6
const { url } = await startStandaloneServer(server, {
7
  context: async ({ req }) => ({ token: req.headers.token }),
8
  listen: { port: 4000 },
9
});
10
console.log(`🚀  Server ready at ${url}`);

要将使用更改为 expressMiddleware，您首先需要安装以下包，以便您可以为服务器设置CORS：

1
npm install express cors

接下来，我们可以修改我们的代码以匹配以下

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

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

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

21
// Same ApolloServer initialization as before, plus the drain plugin
22
// for our httpServer.
23
const server = new ApolloServer<MyContext>({
24
  typeDefs,
25
  resolvers,
26
  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
27
});
28
// Ensure we wait for our server to start
29
await server.start();
30

31
// Set up our Express middleware to handle CORS, body parsing,
32
// and our expressMiddleware function.
33
app.use(
34
  '/',
35
  cors<cors.CorsRequest>(),
36
  // 50mb is the limit that `startStandaloneServer` uses, but you may configure this to suit your needs
37
  express.json({ limit: '50mb' }),
38
  // expressMiddleware accepts the same arguments:
39
  // an Apollo Server instance and optional configuration options
40
  expressMiddleware(server, {
41
    context: async ({ req }) => ({ token: req.headers.token }),
42
  }),
43
);
44

45
// Modified server startup
46
await new Promise<void>((resolve) => httpServer.listen({ port: 4000 }, resolve));
47
console.log(`🚀 Server ready at https://127.0.0.1:4000/`);

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

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

17
// Same ApolloServer initialization as before, plus the drain plugin
18
// for our httpServer.
19
const server = new ApolloServer({
20
  typeDefs,
21
  resolvers,
22
  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
23
});
24
// Ensure we wait for our server to start
25
await server.start();
26

27
// Set up our Express middleware to handle CORS, body parsing,
28
// and our expressMiddleware function.
29
app.use(
30
  '/',
31
  cors(),
32
  // 50mb is the limit that `startStandaloneServer` uses, but you may configure this to suit your needs
33
  express.json({ limit: '50mb' }),
34
  // expressMiddleware accepts the same arguments:
35
  // an Apollo Server instance and optional configuration options
36
  expressMiddleware(server, {
37
    context: async ({ req }) => ({ token: req.headers.token }),
38
  }),
39
);
40

41
// Modified server startup
42
await new Promise((resolve) => httpServer.listen({ port: 4000 }, resolve));
43
console.log(`🚀 Server ready at https://127.0.0.1:4000/`);

ApolloServer

expressMiddleware

API 参考：startStandaloneServer

概述

`startStandaloneServer`

选项

`context`

`listen`

示例

切换到 `expressMiddleware`

示例

API 参考：startStandaloneServer

startStandaloneServer

选项

context

listen

示例

切换到 expressMiddleware

示例

`startStandaloneServer`

`context`

`listen`

切换到 `expressMiddleware`