Apollo Client 订阅功能在 Next.js 中的实现与问题解决

前言

在现代 Web 开发中，实时数据更新是一个常见需求。GraphQL 订阅功能为此提供了优雅的解决方案。本文将深入探讨如何在使用 Apollo Client 和 Next.js 的项目中正确实现 GraphQL 订阅功能，并解决常见的"TypeError: Cannot return null for non-nullable field"错误。

技术栈背景

Apollo Client 是一个强大的 GraphQL 客户端，而 Next.js 是 React 的框架，支持服务端渲染。当两者结合使用时，特别是在处理实时数据订阅时，需要注意一些特殊的配置。

常见问题分析

许多开发者在尝试实现 GraphQL 订阅时，会遇到后端订阅正常工作但前端却报错的情况。典型的错误信息是"TypeError: Cannot return null for non-nullable field"，这通常表明订阅连接未能正确建立。

问题根源

经过分析，这类问题通常源于以下原因：

1. WebSocket 连接配置不正确
2. 订阅链接(wsLink)被错误地放置在服务端配置中
3. 客户端和服务端渲染环境混淆

解决方案详解

正确的配置位置

关键在于将 WebSocket 订阅链接配置放在客户端组件中。Next.js 的架构特点决定了服务端渲染环境无法直接处理 WebSocket 连接，因此必须明确区分客户端和服务端配置。

ApolloWrapper 的正确实现

以下是经过验证的有效实现方案：

"use client";
import {ApolloLink, HttpLink} from "@apollo/client";
import {
    ApolloNextAppProvider,
    NextSSRInMemoryCache,
    NextSSRApolloClient,
    SSRMultipartLink,
} from "@apollo/experimental-nextjs-app-support/ssr";
import {GraphQLWsLink} from "@apollo/client/link/subscriptions";
import {createClient} from "graphql-ws";
import {getMainDefinition} from "@apollo/client/utilities";

function makeClient() {
    const httpLink = new HttpLink({
        uri: "http://localhost:8000/graphql",
    });
    
    const wsLink = new GraphQLWsLink(createClient({
        url: 'ws://localhost:8000/graphql',
        connectionParams: {
            authToken: "有效的认证令牌",
        },
    }));

    const splitLink = split(
        ({ query }) => {
            const definition = getMainDefinition(query);
            return (
                definition.kind === 'OperationDefinition' &&
                definition.operation === 'subscription'
            );
        },
        wsLink,
        httpLink,
    );

    return new NextSSRApolloClient({
        cache: new NextSSRInMemoryCache(),
        link:
            typeof window === "undefined"
                ? ApolloLink.from([
                    new SSRMultipartLink({
                        stripDefer: true,
                    }),
                    splitLink,
                ])
                : splitLink,
    });
}

export function ApolloWrapper({ children }) {
    return (
        <ApolloNextAppProvider makeClient={makeClient}>
            {children}
        </ApolloNextAppProvider>
    );
}

关键点说明

1. "use client"指令：明确标识这是一个客户端组件
2. 环境判断：通过typeof window检查当前环境
3. 链接分离：使用splitLink区分普通查询和订阅
4. 认证处理：在connectionParams中传递认证信息

最佳实践建议

1. 始终将WebSocket相关配置放在客户端组件中
2. 为生产环境配置安全的WebSocket连接(wss://)
3. 实现完善的错误处理和重连机制
4. 考虑使用环境变量管理后端URL
5. 在开发阶段启用详细的日志记录以帮助调试

总结

通过正确理解Next.js的架构特点和Apollo Client的工作机制，我们可以有效地实现GraphQL订阅功能。关键在于区分客户端和服务端环境，并将WebSocket配置放置在适当的位置。本文提供的解决方案已经过实际项目验证，能够解决常见的订阅连接问题。

对于更复杂的场景，建议进一步研究Apollo Client的实时数据策略和Next.js的高级数据获取方法，以构建更加健壮的实时应用程序。