AWS Amplify中GraphQL订阅返回null问题的分析与解决

问题背景

在使用AWS Amplify Gen 2版本开发React应用时，开发者遇到了一个典型的GraphQL订阅问题。当尝试订阅Message模型的创建事件时，订阅返回了null值，并伴随错误提示："Cannot return null for non-nullable type: 'String' within parent 'Message' (/onCreateMessage/chatMsg)"。

问题现象

开发者定义了一个Message模型，包含chatId、chatMsg等必填字段，并尝试通过以下方式订阅创建事件：

const createSub = client.models.Message.onCreate({
  selectionSet: ["role", "chatMsg", "options", "createdAt"]
}).subscribe({
  next: (data) => { /* ... */ },
  error: (err) => { /* ... */ }
});

然而订阅返回的数据中，onCreateMessage字段为null，并提示chatMsg字段不能为null的错误。

根本原因分析

经过深入分析，发现问题根源在于订阅选择集与创建操作返回字段的不匹配。具体表现为：

1. 创建操作（mutation）只返回了id字段，没有返回订阅请求的其他字段（role、chatMsg、options、createdAt）
2. GraphQL订阅机制要求，当订阅触发时，必须能够获取到订阅选择集中指定的所有非空字段
3. 由于创建操作没有返回chatMsg等字段，订阅服务无法提供这些数据，导致验证失败

解决方案

要解决这个问题，需要确保创建操作的返回字段能够满足订阅的选择集需求。具体有以下几种实现方式：

方案一：扩展创建操作的返回字段

修改创建操作的GraphQL mutation，确保返回订阅所需的所有字段：

mutation CreateMessage($chatId: ID!, $chatMsg: String!) {
  createMessage(input: {chatId: $chatId, chatMsg: $chatMsg, role: USER}) {
    id
    role
    chatMsg
    options
    createdAt
  }
}

方案二：使用Amplify DataStore的完整方案

如果使用Amplify DataStore，可以利用其自动同步机制：

await DataStore.save(
  new Message({
    chatId: newChat.data.chatId,
    role: "ASSISTANT",
    chatMsg: "What do you want to do?",
    // 其他字段...
  })
);

DataStore会自动处理订阅和数据同步的细节。

方案三：调整订阅选择集

如果确实无法修改创建操作，可以调整订阅的选择集，只请求创建操作会返回的字段：

const createSub = client.models.Message.onCreate({
  selectionSet: ["id"] // 仅请求确保会返回的字段
}).subscribe(/* ... */);

最佳实践建议

1. 保持一致性：确保订阅的选择集与相关操作的返回字段保持一致
2. 包含ID字段：所有订阅都应包含id字段，这是数据同步和识别的基础
3. 考虑性能：不要请求不需要的字段，但必须包含订阅逻辑依赖的所有字段
4. 错误处理：完善订阅的错误处理逻辑，及时捕获和处理类似的数据不一致问题

总结

在AWS Amplify中使用GraphQL订阅时，必须注意创建/更新操作与订阅选择集之间的字段匹配问题。这不仅是技术实现的要求，更是保证数据一致性和应用稳定性的重要实践。通过合理设计操作返回字段和订阅选择集，可以避免这类null值错误，构建更健壮的实时应用。