TRPC 中订阅功能与输出解析器的协同工作解析

概述

在 TRPC 框架中，开发者经常会遇到需要将订阅(subscription)功能与输出解析器(output parser)结合使用的场景。本文深入探讨了这一技术组合的实现原理、常见问题及解决方案。

技术背景

TRPC 是一个类型安全的 RPC 框架，它允许开发者定义类型化的 API 端点。订阅功能是其核心特性之一，用于实现服务器向客户端的持续数据推送。输出解析器则负责验证和转换从服务器返回的数据。

问题分析

在早期版本中，开发者尝试以下代码时会遇到问题：

export const test = t.procedure
  .output(z.string())
  .subscription(async function* () {
    yield "hello";
    await sleep(1000);
    yield "world";
  });

这段代码存在两个主要问题：

1. 类型检查错误：TypeScript 会报错
2. 运行时错误：AsyncIterable 无法直接转换为 string

解决方案

TRPC 团队通过以下方式解决了这个问题：

1. 类型系统改进：更新了类型定义，使订阅函数能够正确识别输出解析器的类型约束
2. 运行时验证增强：确保订阅产生的每个值都经过输出解析器的验证，而不是对整个订阅流进行验证

最佳实践

现在，开发者可以这样安全地使用订阅与输出解析器：

export const test = t.procedure
  .output(z.string())
  .subscription(async function* () {
    // 每个yield的值都会通过z.string()验证
    yield "valid string";
    await delay(1000);
    yield "another valid string";
  });

技术细节

实现这一功能需要考虑几个关键点：

1. 异步生成器特性：订阅函数返回的是异步生成器，需要特殊处理
2. 逐值验证：不同于普通过程调用，订阅需要对每个发出的值单独验证
3. 类型推断：需要确保类型系统能正确推断生成器产生的值类型

注意事项

开发者在使用时应注意：

1. 每个 yield 的值都必须符合输出解析器的约束
2. 错误的值会导致验证失败，客户端会收到错误
3. 类型提示现在应该能正确显示预期的输出类型

总结

TRPC 框架通过改进订阅功能与输出解析器的集成，为开发者提供了更强大且类型安全的实时数据推送能力。这一改进使得构建类型安全的实时应用变得更加简单可靠。