上下文和contextValue

在服务器上共享信息和请求详情

在进行GraphQL 操作时，您可以在服务器上共享解析器和插件，通过创建一个名为contextValue的

对象。contextValue可以通过contextValue传递任何解析器可能需要的有用信息，例如认证作用域、数据获取源、数据库连接和自定义获取函数。如果您正在使用数据加载器来批量处理解析器的请求，您还可以将它们附加到共享的contextValue上。

`context`函数

📣 Apollo Server 4 更改了定义context函数的语法。查看更多详情。

context函数应该是异步的并返回一个对象。这个对象随后可以通过使用名称contextValue在您的服务器解析器和插件中访问。

您可以将一个context函数传递到您的任何集成函数中（例如expressMiddleware或startStandaloneServer）。

服务器为每个请求调用一次context函数，这使得您可以针对每个请求的详细信息（例如HTTP头）自定义您的contextValue：

1
import { GraphQLError } from 'graphql';
2

3
const resolvers = {
4
  Query: {
5
    // Example resolver
6
    adminExample: (parent, args, contextValue, info) => {
7
      if (contextValue.authScope !== ADMIN) {
8
        throw new GraphQLError('not admin!', {
9
          extensions: { code: 'UNAUTHENTICATED' },
10
        });
11
      }
12
    },
13
  },
14
};
15

16
interface MyContext {
17
  // You can optionally create a TS interface to set up types
18
  // for your contextValue
19
  authScope?: String;
20
}
21

22
const server = new ApolloServer<MyContext>({
23
  typeDefs,
24
  resolvers,
25
});
26

27
const { url } = await startStandaloneServer(server, {
28
  // Your async context function should async and
29
  // return an object
30
  context: async ({ req, res }) => ({
31
    authScope: getScope(req.headers.authorization),
32
  }),
33
});

1
import { GraphQLError } from 'graphql';
2

3
const resolvers = {
4
  Query: {
5
    // Example resolver
6
    adminExample: (parent, args, contextValue, info) => {
7
      if (contextValue.authScope !== ADMIN) {
8
        throw new GraphQLError('not admin!', {
9
          extensions: { code: 'UNAUTHENTICATED' },
10
        });
11
      }
12
    },
13
  },
14
};
15

16
const server = new ApolloServer({
17
  typeDefs,
18
  resolvers,
19
});
20

21
const { url } = await startStandaloneServer(server, {
22
  // Your async context function should async and
23
  // return an object
24
  context: async ({ req, res }) => ({
25
    authScope: getScope(req.headers.authorization),
26
  }),
27
});

以上示例假设您正在使用 startStandaloneServer 或 expressMiddleware，这两者都使用底层的 Express。您 context 函数的传入参数可能会有所不同，如果您使用的是不同的集成。

如果您使用 TypeScript，您必须提供一个命名的 context 函数，如果您通过将类型参数传递给 ApolloServer 来对上下文进行类型化（即您不使用 ApolloServer<BaseContext>）。

由于 context 初始化函数是异步的，您可以使用它来建立数据库连接并等待其他操作完成：

1
context: async () => ({
2
  db: await client.connect(),
3
})
4

5
// Resolver
6
(parent, args, contextValue, info) => {
7
  return contextValue.db.query('SELECT * FROM table_name');
8
}

抛出错误

默认情况下，如果您的 context 函数抛出错误，Apollo 服务器将以 500 HTTP 状态码在 JSON 响应中返回该错误。如果错误不是 GraphQLError，错误的消息将用 "上下文创建失败：" 预先添加。

您可以通过抛出一个具有 GraphQLError 和一个 http 扩展来更改错误的 HTTP 状态码。例如：

1
context: async ({ req }) => {
2
  const user = await getUserFromReq(req);
3
  if (!user) {
4
    throw new GraphQLError('User is not authenticated', {
5
      extensions: {
6
        code: 'UNAUTHENTICATED',
7
        http: { status: 401 },
8
      }
9
    });
10
  }
11

12
  // If the below throws a non-GraphQLError, the server returns
13
  // `code: "INTERNAL_SERVER_ERROR"` with an HTTP status code 500, and
14
  // a message starting with "Context creation failed: ".
15
  const db = await getDatabaseConnection();
16

17
  return { user, db };
18
},

contextValue 对象

context 函数返回一个对象，contextValue，它对您的插件和解析器都是可访问的。

解析器

解析器不应该破坏性地修改 contextValue 参数。 这确保了所有 resolvers 之间的一致性，并且可以防止出现意外的错误。

您的解析器可以通过它们第三个位置参数访问共享的contextValue对象。所有正在执行特定操作的解析器都有访问contextValue的权限。

1
import { AnimalAPI } from './datasources/animals';
2

3
const resolvers = {
4
  Query: {
5
    // All of our resolvers can access our shared contextValue!
6
    dogs: (_, __, contextValue) => {
7
      return contextValue.dataSources.animalApi.getDogs();
8
    },
9
    cats: (_, __, contextValue) => {
10
      return contextValue.dataSources.animalApi.getCats();
11
    },
12
  },
13
};
14

15
interface MyContext {
16
  // Context typing
17
  dataSources: {
18
    animalApi: AnimalAPI;
19
  };
20
}
21

22
const server = new ApolloServer<MyContext>({
23
  typeDefs,
24
  resolvers,
25
});
26

27
const { url } = await startStandaloneServer(server, {
28
  context: async () => {
29
    const animalApi = new AnimalAPI();
30
    return {
31
      dataSources: {
32
        animalApi,
33
      },
34
    };
35
  },
36
});

1
import { AnimalAPI } from './datasources/animals';
2

3
const resolvers = {
4
  Query: {
5
    // All of our resolvers can access our shared contextValue!
6
    dogs: (_, __, contextValue) => {
7
      return contextValue.dataSources.animalApi.getDogs();
8
    },
9
    cats: (_, __, contextValue) => {
10
      return contextValue.dataSources.animalApi.getCats();
11
    },
12
  },
13
};
14

15
const server = new ApolloServer({
16
  typeDefs,
17
  resolvers,
18
});
19

20
const { url } = await startStandaloneServer(server, {
21
  context: async () => {
22
    const animalApi = new AnimalAPI();
23
    return {
24
      dataSources: {
25
        animalApi,
26
      },
27
    };
28
  },
29
});

插件

内置和自定义插件可以通过请求生命周期函数访问contextValue，如下所示：

1
interface MyContext {
2
  token: string;
3
}
4

5
const server = new ApolloServer<MyContext>({
6
  typeDefs,
7
  resolvers: {
8
    Query: {
9
      hello: (root, args, { token }) => {
10
        return token;
11
      },
12
    },
13
  },
14
  plugins: [
15
    {
16
      async requestDidStart({ contextValue }) {
17
        // token is properly inferred as a string
18
        console.log(contextValue.token);
19
      },
20
    },
21
  ],
22
});
23

24
const { url } = await startStandaloneServer(server, {
25
  context: async ({ req, res }) => ({
26
    token: await getTokenForRequest(req),
27
  }),
28
});

1
const server = new ApolloServer({
2
  typeDefs,
3
  resolvers: {
4
    Query: {
5
      hello: (root, args, { token }) => {
6
        return token;
7
      },
8
    },
9
  },
10
  plugins: [
11
    {
12
      async requestDidStart({ contextValue }) {
13
        // token is properly inferred as a string
14
        console.log(contextValue.token);
15
      },
16
    },
17
  ],
18
});
19

20
const { url } = await startStandaloneServer(server, {
21
  context: async ({ req, res }) => ({
22
    token: await getTokenForRequest(req),
23
  }),
24
});

解析器

错误处理

上下文和contextValue

在服务器上共享信息和请求详情

context函数

抛出错误

contextValue 对象

解析器

插件

`context`函数