在 Relay Resolvers 中定义客户端状态类型（Strong / Weak / 抽象类型全指南）

前端开发工具【免费下载链接】relayRelay is a JavaScript framework for building>项目地址https://gitcode.com/gh_mirrors/relay29/relay点击查看免费下载本指南以 Relay v18 文档 Defining Types 为骨架讲解如何为客户端状态定义 GraphQL 类型包括带唯一 ID 的strong 类型、不带唯一 ID 的weak 类型以及实现服务端抽象类型interface / union的具体写法。读完你将掌握RelayResolver与weakdocblock 的完整语法、model resolver 与 model type 的区别并能结合本仓库的编译器源码理解这些类型在 Relay 编译期与运行期是如何被处理的。一、理解“客户端状态即 GraphQL 服务器”Relay Resolvers 允许你把仅在客户端已知的值接入 Relay 的 GraphQL 数据图详见 Introduction to Relay Resolvers。你可以把客户端状态解析器想象成一个运行在客户端的 GraphQL 服务器与服务器端 GraphQL 一样你需要先定义 schema 中存在的type类型再定义这些类型上的field字段与 GraphQL 服务器一样字段被定义为“从父对象计算出 GraphQL 值”的函数在 Relay Resolvers 中这个作为父对象的 JavaScript 对象被称为该类型的model模型。每个客户端状态 GraphQL 类型都由一个 JavaScript 对象类型作为支撑文档中称之为该类型的model type。定义在该类型上的 resolver 会把该类型的实例作为第一个参数传入。二、用RelayResolver声明类型Resolver 类型通过RelayResolver标签加上你要定义的类型名来声明。默认情况下Relay 假定你的客户端类型是strong强的——即每个实例拥有一个在该类型内唯一的 ID。这一属性使 Relay 能够应用一系列优化例如对 resolver 的计算结果进行记忆化memoizing。2.1 定义一个 strong 类型Strong 类型由一个 docblock加一个与之同名的导出函数组成该函数仅接受一个ID作为唯一参数返回该类型 model 的一个实例文档中把该函数称为该类型的model resolver模型解析器。例如从用户服务中按 ID 取出用户模型/** * RelayResolver User */ export function User(id: DataID): UserModel { return UserService.getById(id); }由于 strong 类型的 ID 唯一且稳定指向该类型的edge边resolver 只需返回对象的 ID而无需自己派生整个 model 对象——Relay 会自动调用该类型的 model resolver 完成对象的获取与缓存。从编译器的角度看strong 类型的 model resolver 会被编译进一张带__RelayResolverModel标记的客户端扩展类型中。仓库中的编译期测试夹具 relay-model-resolver.graphql 展示了其产物形态type ClientUser __RelayResolverModel { id: ID! __relay_model_instance: RelayResolverValue relay_resolver( fragment_name: ClientUser__id import_path: ./path/to/UserModelResolver.js inject_fragment_data: id ) }可以看到编译后的类型会生成一个__relay_model_instance内部字段并记录 model resolver 的import_path与fragment_name这正是 Relay 在运行期按 ID 重建 model 实例的实现依据。2.2 注意客户端数据是可变的一般而言客户端数据存储中的对象会随时间变化。为此Relay Resolvers 支持订阅底层数据源的 resolver即 Live Fields。若你的类型数据会变化建议阅读 Live Fields 章节将类型或字段声明为live使 Relay 在数据变更时自动重算并触发 UI 更新。三、定义 weak 类型无唯一 ID 的类型如果某个类型没有唯一标识符你可以通过在 docblock 中加入weak标签将其声明为 weak 类型Weak 类型由一个 docblock加一个与之同名的导出类型定义组成该类型定义export type ...即该类型的 model type 结构指向 weak 类型的 edge resolver必须返回一个完全填充的、符合该类型的 model 对象因为没有 ID 可让 Relay 去查。例如定义一个头像这样的值对象/** * RelayResolver ProfilePicture * weak */ export type ProfilePicture { url: string, height: number, width: number };提示weak 类型通常用于为“最终归属于某个父对象的一组字段”创建命名空间相当于内嵌的值对象value object而不是可独立寻址的实体。3.1 编译器眼中的 weak 类型weak 类型在编译期与 strong 类型走完全不同的代码路径。在 field_transform.rs约 L205-L213中可以看到当 resolver 的返回类型是某个具体weakmodel 时编译器会为其查找“唯一的 model 实例字段”weak_object_instance_field。源码注释明确解释了原因A weak value has no DataID and no separate record to refetch, so it must be read INLINE offType____relay_model_instancerather than via a pointer.即weak 值没有 DataID、也没有独立的 record 可以按指针重取因此编译产物会把 weak 值内联在父对象记录的____relay_model_instance字段上读取而不是像 strong 类型那样生成指向另一个记录的边。这是理解 weak 类型“随父对象一起存储、不可独立缓存”语义的关键实现细节。四、实现抽象类型interface / unionRelay Resolver 类型可以实现 GraphQL schema 中定义的抽象类型abstract type。这里的抽象类型既可以来自你的 GraphQL 服务器 schema也可以来自客户端 schema 扩展。假设服务端定义了如下 interface# IUser.graphql interface IUser { name: String }你可以定义两个或更多具体 resolver 类型通过在 docblock 中附加implements IUser注解来实现该接口union 同理/** * RelayResolver BasicUser implements IUser */ export function BasicUser(id: DataID): BasicUserModel { return { ...BasicUserService.getById(id), name: BasicUser1}; } /** * RelayResolver SpecialUser implements IUser */ export function SpecialUser(id: DataID): SpecialUserModel { return { ...SpecialUserService.getById(id), name: SpecalUser1}; }要点实现抽象类型的 resolver 类型本身必须是strong 类型即带 model resolver 函数因为 Relay 需要 ID 来分辨运行时实际的具体类型每个具体类型仍必须提供自己的 model resolver 来返回各自的 model 实例声明格式为RelayResolver TypeName implements InterfaceName多个接口/union 成员按 GraphQL SDL 惯例书写。五、类型定义的完整语法速查结合官方 Docblock Format 参考页RelayResolver家族的语法规则如下写法含义后续必须提供RelayResolver User定义一个 strong 客户端类型同名导出函数model resolver接收 ID返回 model 实例RelayResolver Userweak定义一个 weak 客户端类型同名导出类型定义model type 结构RelayResolver User.name: String在已有类型上定义字段同名导出函数接收父类型 model 实例返回字段值RelayResolver BasicUser implements IUser定义实现抽象接口的具体类型同名导出函数model resolver补充说明只有包含RelayResolver标签的 docblock 才会被 Relay 编译器扫描其余 docblock 一律忽略strong 类型的 model resolver 是类型定义的一部分weak 类型则没有 model resolver而是直接由类型定义充当 model type关于如何在类型上定义字段见 Defining Fields关于字段可返回的各类值标量、列表、客户端类型边、服务端类型边、RelayResolverValue见 Resolver Return Types。六、使用前的环境要求Relay Resolvers 目前仍是experimental实验性功能启用方式如下详见 Enabling Relay Resolvers运行时使用实验性的LiveResolverStore作为 Relay store并开启ENABLE_RELAY_RESOLVERS特性开关import { Environment, RecordSource, RelayFeatureFlags } from relay-runtime; import LiveResolverStore from relay-runtime/lib/store/live-resolvers/LiveResolverStore; RelayFeatureFlags.ENABLE_RELAY_RESOLVERS true;编译器在relay.config.json中开启enable_relay_resolver_transform{ src: ./src, schema: ./schema.graphql, language: typescript, featureFlags: { enable_relay_resolver_transform: true } }若查询中只包含客户端字段需使用useClientQuery而非useLazyLoadQuery/usePreloadedQuery来读取数据见 Introduction 中的示例。七、总结与选型建议strong 类型有唯一 ID、可被独立缓存与记忆化、edge resolver 只返回 ID。适合用户、文章、订单等可寻址实体。weak 类型无 ID、作为父对象的嵌套值对象内联存储、edge resolver 返回完整 model。适合头像、坐标、设置块等纯值结构。抽象类型实现让客户端类型参与多态与服务端 interface/union 无缝衔接但仅支持 strong 具体类型。参考仓库中的编译产物与源码可以进一步验证这些语义编译结果可查看 relay-model-resolver.graphql 测试夹具weak 类型的内联读取逻辑可阅读 relay-transforms/src/relay_resolvers/field_transform.rs。赞分享前端开发工具【免费下载链接】relayRelay is a JavaScript framework for building>项目地址https://gitcode.com/gh_mirrors/relay29/relay点击查看免费下载相关推荐Relay Resolvers 类型定义指南用 RelayResolver 构建客户端 Schema 中的强类型与弱类型Relay Resolvers 类型定义指南用 RelayResolver 构建客户端 Schema 中的强类型与弱类型 Relay Resolvers 允前端开发工具Relay Resolver 字段定义完全指南在 Relay 中为客户端状态模型扩展 GraphQL 字段Relay Resolver 字段定义完全指南在 Relay 中为客户端状态模型扩展 GraphQL 字段 Relay Resolvers 是 Relay 的前端开发工具Relay Resolvers 完全指南在 Relay 15 中用客户端字段构建响应式派生状态Relay Resolvers 完全指南在 Relay 15 中用客户端字段构建响应式派生状态 Relay Resolvers 是 Relay 的一个实验性特前端开发工具创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考