AWS Amplify 中处理 GraphQL 模型类型与 JSON 字段的 TypeScript 实践

在基于 AWS Amplify 构建 Angular 应用时，开发者经常会遇到需要从 GraphQL 后端获取数据并定义前端类型的情况。本文深入探讨了在使用 Amplify Gen 2 时处理模型类型定义的最佳实践，特别是当模型包含 JSON 类型字段时的特殊处理方式。

模型类型定义的基本方法

在 Amplify 中定义 GraphQL 模型后，前端开发者通常需要获取对应的 TypeScript 类型。最直观的方式是使用 Awaited<ReturnType<typeof api.models.ModelName.list>> 这种类型推导方式：

export type PageDto = Awaited<ReturnType<typeof api.models.CmsPage.list>>;
export type PageItemsDto = PageDto['data'];
export type PageItemDto = PageItemsDto['0'];

这种方法对于简单模型有效，但当模型包含 JSON 类型字段时，TypeScript 编译器会报错 TS2589: Type instantiation is excessively deep and possibly infinite，表明类型推导过程可能进入了无限循环。

JSON 字段带来的类型挑战

当模型定义中包含 a.json() 类型的字段时，如示例中的 CmsMenu 模型的 items 字段：

CmsMenu: a.model({
  // ...
  items: a.json(),
  // ...
})

直接使用 Awaited<ReturnType> 方式获取类型会导致 TypeScript 类型系统陷入深度递归，因为 JSON 类型在 TypeScript 中的表示可能非常复杂（可以是任意嵌套的对象结构）。

推荐的解决方案

Amplify 提供了更优雅的类型辅助工具，通过 Schema 类型可以直接获取模型定义：

export type MenuDto = Schema['CmsMenu']['type'];

type MenuListReturn = {
  data: MenuDto[];
  errors?: object[];
}

这种方法有多个优势：

1. 避免了复杂的类型推导过程
2. 直接反映了 GraphQL 模型定义
3. 对包含 JSON 字段的模型也能正常工作
4. 类型定义更加清晰直观

实际应用建议

在前端应用中，我们通常需要将 DTO (Data Transfer Object) 转换为前端领域模型。建议采用以下模式：

1. 首先通过 Schema 获取原始类型定义
2. 然后定义前端领域模型接口
3. 最后创建适配器函数进行类型转换

// 获取原始DTO类型
export type CmsMenuDto = Schema['CmsMenu']['type'];

// 定义前端模型
export interface Menu {
  id: string;
  symbol: string;
  items?: MenuItem[]; // 已转换的JSON结构
  // 其他前端专用字段
}

// 适配器函数
export function adaptMenu(dto: CmsMenuDto): Menu {
  return {
    id: dto.id,
    symbol: dto.symbol,
    items: dto.items ? JSON.parse(dto.items) : undefined,
    // 其他转换逻辑
  };
}

总结

在 AWS Amplify 项目中处理 GraphQL 模型类型时，特别是当模型包含 JSON 字段时，推荐使用 Schema 类型辅助工具而非复杂的类型推导。这种方法不仅解决了 TypeScript 的类型深度问题，还使代码更加清晰可维护。通过结合适配器模式，可以有效地将后端 DTO 转换为前端领域模型，实现清晰的关注点分离。