## 字段中间件
> <a style="color:orange;">这一章节仅适用于代码优先方式。</a>
字段中间件允许你在解析字段之前或之后运行任意代码。一个字段中间件可被用来转换字段的返回结果,验证字段的参数,甚至验证字段级别的角色(比如,某个执行了中间件函数的目标字段需要验证角色才能访问)。
你可以在一个字段上连接多个中间件函数。在这种情况下,它们将沿着链式顺序调用,即在上一个中间件中决定下一个中间件的调用。中间件函数在 `middleware` 数组中的顺序很重要。第一个解析器是“最外”层,所以它会第一个或最后一个被执行(类似 `graphql-middleware` 包)。第二个解析器是“次外”层,所以它会第二个或倒数第二个被执行。
### 快速开始
让我们开始创建一个简单的中间件,它会在一个字段被返回给客户端之前记录这个字段的值:
```typescript
import { FieldMiddleware, MiddlewareContext, NextFn } from '@nestjs/graphql';
const loggerMiddleware: FieldMiddleware = async (
ctx: MiddlewareContext,
next: NextFn,
) => {
const value = await next();
console.log(value);
return value;
};
```
> `MiddlewareContext` 是一个对象,它是由 GraphQL 解析器函数通常所接收的参数组成(`{ source, args, context, info }`),而 `NextFn` 是一个函数,它可以让你执行堆栈中的下一个中间件(绑定到此字段)或实体字段解析器。
> 字段中间件函数不能注入依赖项,也不能访问 Nest 的 DI 容器,因为它们被设计为非常轻量级而且不应该执行任何可能耗时的操作(比如从数据库中检索数据)。如果你需要从数据源调用外部服务或查询数据,你应该在一个绑定到根查询或变更处理程序的守卫/拦截器中执行此操作,并将其分配给字段中间件中你可以访问的上下文对象(具体来说,就是来自 `MiddlewareContext` 的对象)。
注意字段中间件必须和 `FieldMiddleware` 接口匹配。在上面的例子中,我们首先运行 `next()` 函数(它执行实际的字段解析器并返回一个字段值),紧接着,我们把这个值记录到我们的终端。另外,这个从中间件函数返回的值完全覆盖了之前的值,并且由于我们不想执行任何更改,因此我们只需返回原始值。
在这里,我们可以直接在 `@Field()` 装饰器里注册中间件。
```typescript
@ObjectType()
export class Recipe {
@Field({ middleware: [loggerMiddleware] })
title: string;
}
```
现在每当我们请求 `Recipe` 对象类型中的 `title` 字段时,原始的字段值将会被记录到控制台。
> 要了解如何使用扩展功能实现字段级权限系统,请查阅此[章节](https://docs.nestjs.com/graphql/extensions)。
另外,如上文所说,我们可以通过中间件函数来控制字段的值。出于演示目的,让我们将 recipe 的标题(如果存在)变成大写。
```typescript
const value = await next();
return value?.toUpperCase();
```
在这种情况下,当被请求时,所有的标题会被自动转换为大写。
同样,你可以在一个自定义字段解析器(一个被 `@ResolveField()` 装饰器注释的方法)上绑定字段中间件,如下所示:
```typescript
@ResolveField(() => String, { middleware: [loggerMiddleware] })
title() {
return 'Placeholder';
}
```
> 如果在字段解析器级别启用了增强器([了解更多](https://docs.nestjs.com/graphql/other-features#execute-enhancers-at-the-field-resolver-level)),字段中间件函数将会在所有拦截器、守卫等之前运行,绑定到方法(但在为查询或变更处理程序注册的根级增强器之后)。
### 全局字段中间件
除了将中间件直接绑定到一个特定的字段上,你还可以在全局注册一个或多个中间件函数。在这种情况下,它们将会自动连接到你的对象类型的所有字段上。
```typescript
GraphQLModule.forRoot({
autoSchemaFile: 'schema.gql',
buildSchemaOptions: {
fieldMiddleware: [loggerMiddleware],
},
}),
```
> 全局注册的字段中间件函数将在本地注册的中间件(那些直接绑定到特定字段上的)之前被执行。
- 介绍
- 概述
- 第一步
- 控制器
- 提供者
- 模块
- 中间件
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 自定义装饰器
- 基础知识
- 自定义提供者
- 异步提供者
- 动态模块
- 注入作用域
- 循环依赖
- 模块参考
- 懒加载模块
- 应用上下文
- 生命周期事件
- 跨平台
- 测试
- 技术
- 数据库
- 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?