如何将额外数据附加到 Apollo Server 上的 GraphQL 响应

假设我们希望在每个 graphql 响应中包含唯一的请求标识符。

我们可以通过向查询类型添加 requestid 字段，然后将该字段解析为我们在每个请求的上下文中设置的某个唯一标识符来实现这一点。但这不是一个完美的解决方案，因为我们必须在客户端的每个请求中包含该字段，并且它会稍微增加发送到服务器的请求的大小。

有更好的方法！

我们可以创建一个小插件（中间件），将我们的自定义数据附加到响应正文的扩展字段。

根据“创建 apollo 服务器插件”文档页面告诉我们的内容，我们的插件应如下所示：

// extensionsplugin.js

export const extensionsplugin = () => {
    return {
        requestdidstart: () => {
            return {
                willsendresponse(requestcontext) {
                    requestcontext.response.body.singleresult = {
                        ...requestcontext.response.body.singleresult,
                        extensions: {
                            ...requestcontext.response.body?.extensions,
                            requestid: requestcontext.contextvalue.requestid
                        },
                    };
                },
            }
        }
    }
};

随意使用console.log(requestcontent.response)来了解数据的结构。

请记住，只有 body.singleresult 的扩展键可以开箱即用，因为它是 graphql 标准的一部分。我们无法将 requestid 直接添加到 body.singleresult。

独响

一个轻笔记+角色扮演的app

下载

现在我们只需实施它即可！

此示例使用 ulid 包生成紧凑且可按时间排序的 id。

// main.js

import { ulid } from 'ulid';
import { extensionsPlugin } from "./extensionsPlugin.js";

// ...

const server = new ApolloServer({
    // ...
    plugins: [extensionsPlugin()],
    // ...
})

const { url } = await startStandaloneServer(server, {
    // ...
    context: async () => {
        // ...
        const requestId = ulid();

        return {
            requestId,
        }
    },
    // ...
})

就是这样！

为什么它有效？上下文是为每个请求单独构建的（上下文），并且始终可供处理该请求的所有解析器使用。最好在上下文中设置所有需要的变量，因为它是在触发任何插件挂钩之前创建的（例如：requestdidstart）。我们将 requestid 添加到我们的上下文中并使其在任何地方都可用，然后我们的插件从上下文中提取它并在发送回之前将其附加到响应正文。

知道我们还可以在我们的回复中附加什么内容吗？请在评论中分享:)