## 字段中間件
> <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?