## 联合类型
联合类型与接口非常相似,但是它们没有指定类型之间的任何公共字段(详情请参阅[这里](https://graphql.org/learn/schema/#union-types))。联合类型对于单个字段返回不相交的数据类型很有用。
### 代码优先
要定义 GraphQL 联合类型,我们必须先定义组成这个联合类型的各个类。遵循 Apollo 文档中的[示例](https://www.apollographql.com/docs/apollo-server/schema/unions-interfaces/#union-type),我们将创建两个类。首先,`Book`:
```typescript
import { Field, ObjectType } from '@nestjs/graphql';
@ObjectType()
export class Book {
@Field()
title: string;
}
```
然后是 `Author`:
```typescript
import { Field, ObjectType } from '@nestjs/graphql';
@ObjectType()
export class Author {
@Field()
name: string;
}
```
在这里,我们使用从 `@nestjs/graphql` 包里导出的 `createUnionType` 函数来注册 `ResultUnion` 这个联合类型。
~~~typescript
export const ResultUnion = createUnionType({
name: 'ResultUnion',
types: () => [Author, Book] as const,
});
~~~
> `createUnionType` 函数的 types 属性返回的数组应该被赋予一个 `const `断言。 如果没有给出 `const` 断言,编译时会生成错误的声明文件,从另一个项目中使用时会出错。
现在,我们就可以在查询中引用 `ResultUnion` 这个联合类型来。
```typescript
@Query(returns => [ResultUnion])
search(): Array<typeof ResultUnion> {
return [new Author(), new Book()];
}
```
最终的结果是在 SDL 中生成以下部分的 GraphQL schema:
```graphql
type Author {
name: String!
}
type Book {
title: String!
}
union ResultUnion = Author | Book
type Query {
search: [ResultUnion!]!
}
```
默认的 `resolveType()` 函数是通过库根据解析器方法返回值提取的类型来生成的。这意味着你必须返回类的实例(你不能返回 JavaScript 对象字面量)。
提供自定义的 `resolveType()` 函数,将 `resolveType` 属性传递给 `@InterfaceType()` 装饰器里的选项对象,如下所示:
```typescript
export const ResultUnion = createUnionType({
name: 'ResultUnion',
types: () => [Author, Book],
resolveType(value) {
if (value.name) {
return Author;
}
if (value.title) {
return Book;
}
return null;
},
});
```
### 模式优先
在模式优先方式中定义联合类型,只需使用 SDL 创建一个 GraphQL 联合类型。
```graphql
type Author {
name: String!
}
type Book {
title: String!
}
union ResultUnion = Author | Book
```
然后,你可以使用类型生成功能(如[快速开始](/8/graphql?id=快速开始)章节所示)生成相应的 TypeScript 定义。
```typescript
export class Author {
name: string;
}
export class Book {
title: string;
}
export type ResultUnion = Author | Book;
```
在解析器映射图中,联合类型需要一个额外的 `__resolveType` 字段,来确定联合类型应该解析为哪个类型。另外,请注意, `ResultUnionResolver` 这个类在任何模块中都必须被注册为提供者。让我们创建一个 `ResultUnionResolver` 类并定义 `__resolveType` 方法:
```typescript
@Resolver('ResultUnion')
export class ResultUnionResolver {
@ResolveField()
__resolveType(value) {
if (value.name) {
return 'Author';
}
if (value.title) {
return 'Book';
}
return null;
}
}
```
> 所有装饰器都是从 `@nestjs/graphql` 包里导出。
- 介绍
- 概述
- 第一步
- 控制器
- 提供者
- 模块
- 中间件
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 自定义装饰器
- 基础知识
- 自定义提供者
- 异步提供者
- 动态模块
- 注入作用域
- 循环依赖
- 模块参考
- 懒加载模块
- 应用上下文
- 生命周期事件
- 跨平台
- 测试
- 技术
- 数据库
- Mongo
- 配置
- 验证
- 缓存
- 序列化
- 版本控制
- 定时任务
- 队列
- 日志
- Cookies
- 事件
- 压缩
- 文件上传
- 流式处理文件
- HTTP模块
- Session(会话)
- MVC
- 性能(Fastify)
- 服务器端事件发送
- 安全
- 认证(Authentication)
- 授权(Authorization)
- 加密和散列
- Helmet
- CORS(跨域请求)
- CSRF保护
- 限速
- GraphQL
- 快速开始
- 解析器(resolvers)
- 变更(Mutations)
- 订阅(Subscriptions)
- 标量(Scalars)
- 指令(directives)
- 接口(Interfaces)
- 联合类型
- 枚举(Enums)
- 字段中间件
- 映射类型
- 插件
- 复杂性
- 扩展
- CLI插件
- 生成SDL
- 其他功能
- 联合服务
- 迁移指南
- Websocket
- 网关
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 适配器
- 微服务
- 概述
- Redis
- MQTT
- NATS
- RabbitMQ
- Kafka
- gRPC
- 自定义传输器
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 独立应用
- Cli
- 概述
- 工作空间
- 库
- 用法
- 脚本
- Openapi
- 介绍
- 类型和参数
- 操作
- 安全
- 映射类型
- 装饰器
- CLI插件
- 其他特性
- 迁移指南
- 秘籍
- CRUD 生成器
- 热重载
- MikroORM
- TypeORM
- Mongoose
- 序列化
- 路由模块
- Swagger
- 健康检查
- CQRS
- 文档
- Prisma
- 静态服务
- Nest Commander
- 问答
- Serverless
- HTTP 适配器
- 全局路由前缀
- 混合应用
- HTTPS 和多服务器
- 请求生命周期
- 常见错误
- 实例
- 迁移指南
- 发现
- 谁在使用Nest?