Nest-js 是如何實現 AOP 架構的？

Nest.js 是一個 Node.js 的後端框架，它對 express 等 http 平臺做了一層封裝，解決了架構問題。它提供了 express 沒有的 MVC、IOC、AOP 等架構特性，使得代碼更容易維護、擴展。

這裏的 MVC、IOC、AOP 都是啥意思呢？我們分別看一下：

MVC、IOC

MVC 是 Model View Controller 的簡寫。MVC 架構下，請求會先發送給 Controller，由它調度 Model 層的 Service 來完成業務邏輯，然後返回對應的 View。

Nest.js 提供了 @Controller 裝飾器用來聲明 Controller：

而 Service 會用 @Injectable 裝飾器來聲明：

通過 @Controller、@Injectable 裝飾器聲明的 class 會被 Nest.js 掃描，創建對應的對象並加到一個容器裏，這些所有的對象會根據構造器裏聲明的依賴自動注入，也就是 DI（dependency inject），這種思想叫做 IOC（Inverse Of Control）。

IOC 架構的好處是不需要手動創建對象和根據依賴關係傳入不同對象的構造器中，一切都是自動掃描並創建、注入的。

此外，Nest.js 還提供了 AOP （Aspect Oriented Programming）的能力，也就是面向切面編程的能力：

AOP

AOP 是什麼意思呢？什麼是面向切面編程呢？

一個請求過來，可能會經過 Controller（控制器）、Service（服務）、Repository（數據庫訪問） 的邏輯：

如果想在這個調用鏈路里加入一些通用邏輯該怎麼加呢？比如日誌記錄、權限控制、異常處理等。

容易想到的是直接改造 Controller 層代碼，加入這段邏輯。這樣可以，但是不優雅，因爲這些通用的邏輯侵入到了業務邏輯裏面。能不能透明的給這些業務邏輯加上日誌、權限等處理呢？

那是不是可以在調用 Controller 之前和之後加入一個執行通用邏輯的階段呢？

比如這樣：

這樣的橫向擴展點就叫做切面，這種透明的加入一些切面邏輯的編程方式就叫做 AOP （面向切面編程）。

AOP 的好處是可以把一些通用邏輯分離到切面中，保持業務邏輯的存粹性，這樣切面邏輯可以複用，還可以動態的增刪

其實 Express 的中間件的洋蔥模型也是一種 AOP 的實現，因爲你可以透明的在外面包一層，加入一些邏輯，內層感知不到。

而 Nest.js 實現 AOP 的方式更多，一共有五種，包括 Middleware、Guard、Pipe、Inteceptor、ExceptionFilter：

Middleware

Nest.js 基於 Express 自然也可以使用中間件，但是做了進一步的細分，分爲了全局中間件和路由中間件：

全局中間件就是 Express 的那種中間件，在請求之前和之後加入一些處理邏輯，每個請求都會走到這裏：

路由中間件則是針對某個路由來說的，範圍更小一些：

這個是直接繼承了 Express 的概念，比較容易理解。

再來看一些 Nest.js 擴展的概念，比如 Guard：

Guard

Guard 是路由守衛的意思，可以用於在調用某個 Controller 之前判斷權限，返回 true 或者 flase 來決定是否放行：

創建 Guard 的方式是這樣的：

Guard 要實現 CanActivate 接口，實現 canActive 方法，可以從 context 拿到請求的信息，然後做一些權限驗證等處理之後返回 true 或者 false。

通過 @Injectable 裝飾器加到 IOC 容器中，然後就可以在某個 Controller 啓用了：

Controller 本身不需要做啥修改，卻透明的加上了權限判斷的邏輯，這就是 AOP 架構的好處。

而且，就像 Middleware 支持全局級別和路由級別一樣，Guard 也可以全局啓用：

Guard 可以抽離路由的訪問控制邏輯，但是不能對請求、響應做修改，這種邏輯可以使用 Interceptor：

Interceptor

Interceptor 是攔截器的意思，可以在目標 Controller 方法前後加入一些邏輯：

創建 Inteceptor 的方式是這樣的：

Interceptor 要實現 NestInterceptor 接口，實現 intercept 方法，調用 next.handle() 就會調用目標 Controller，可以在之前和之後加入一些處理邏輯。

Controller 之前之後的處理邏輯可能是異步的。Nest.js 裏通過 rxjs 來組織它們，所以可以使用 rxjs 的各種 operator。

Interceptor 支持每個路由單獨啓用，只作用於某個 controller，也同樣支持全局啓用，作用於全部 controller：

除了路由的權限控制、目標 Controller 之前之後的處理這些都是通用邏輯外，對參數的處理也是一個通用的邏輯，所以 Nest.js 也抽出了對應的切面，也就是 Pipe：

Pipe

Pipe 是管道的意思，用來對參數做一些驗證和轉換：

創建 Pipe 的方式是這樣的：

Pipe 要實現 PipeTransform 接口，實現 transform 方法，裏面可以對傳入的參數值 value 做參數驗證，比如格式、類型是否正確，不正確就拋出異常。也可以做轉換，返回轉換後的值。

內置的有 8 個 Pipe，從名字就能看出它們的意思：

• ValidationPipe

• ParseIntPipe

• ParseBoolPipe

• ParseArrayPipe

• ParseUUIDPipe

• DefaultValuePipe

• ParseEnumPipe

• ParseFloatPipe

同樣，Pipe 可以只對某個路由生效，也可以對每個路由都生效：

不管是 Pipe、Guard、Interceptor 還是最終調用的 Controller，過程中都可以拋出一些異常，如何對某種異常做出某種響應呢？

這種異常到響應的映射也是一種通用邏輯，Nest.js 提供了 ExceptionFilter 來支持：

ExceptionFilter

ExceptionFilter 可以對拋出的異常做處理，返回對應的響應：

創建 ExceptionFilter 的形式是這樣的：

首先要實現 ExceptionFilter 接口，實現 catch 方法，就可以攔截異常了，但是要攔截什麼異常還需要用 @Catch 裝飾器來聲明，攔截了異常之後，可以異常對應的響應，給用戶更友好的提示。

當然，也不是所有的異常都會處理，只有繼承 HttpException 的異常纔會被 ExceptionFilter 處理，Nest.js 內置了很多 HttpException 的子類：

• BadRequestException

• UnauthorizedException

• NotFoundException

• ForbiddenException

• NotAcceptableException

• RequestTimeoutException

• ConflictException

• GoneException

• PayloadTooLargeException

• UnsupportedMediaTypeException

• UnprocessableException

• InternalServerErrorException

• NotImplementedException

• BadGatewayException

• ServiceUnavailableException

• GatewayTimeoutException

當然，也可以自己擴展：

Nest.js 通過這樣的方式實現了異常到響應的對應關係，代碼裏只要拋出不同的 HttpException，就會返回對應的響應，很方便。

同樣，ExceptionFilter 也可以選擇全局生效或者某個路由生效：

某個路由：全局：

我們瞭解了 Nest.js 提供的 AOP 的機制，但它們的順序關係是怎樣的呢？

幾種 AOP 機制的順序

Middleware、Guard、Pipe、Interceptor、ExceptionFilter 都可以透明的添加某種處理邏輯到某個路由或者全部路由，這就是 AOP 的好處。

但是它們之間的順序關係是什麼呢？

調用關係這個得看源碼了。

對應的源碼是這樣的：

很明顯，進入這個路由的時候，會先調用 Guard，判斷是否有權限等，如果沒有權限，這裏就拋異常了：

拋出的 HttpException 會被 ExceptionFilter 處理。

如果有權限，就會調用到攔截器，攔截器組織了一個鏈條，一個個的調用，最後會調用的 controller 的方法：

調用 controller 方法之前，會使用 pipe 對參數做處理：

會對每個參數做轉換：

ExceptionFilter 的調用時機很容易想到，就是在響應之前對異常做一次處理。

而 Middleware 是 express 中的概念，Nest.js 只是繼承了下，那個是在最外層被調用。

這就是這幾種 AOP 機制的調用順序。把這些理清楚，就算是對 Nest.js 有很好的掌握了。

總結

Nest.js 基於 express 這種 http 平臺做了一層封裝，應用了 MVC、IOC、AOP 等架構思想。

MVC 就是 Model、View Controller 的劃分，請求先經過 Controller，然後調用 Model 層的 Service、Repository 完成業務邏輯，最後返回對應的 View。

IOC 是指 Nest.js 會自動掃描帶有 @Controller、@Injectable 裝飾器的類，創建它們的對象，並根據依賴關係自動注入它依賴的對象，免去了手動創建和組裝對象的麻煩。

AOP 則是把通用邏輯抽離出來，通過切面的方式添加到某個地方，可以複用和動態增刪切面邏輯。

Nest.js 的 Middleware、Guard、Interceptor、Pipe、ExceptionFileter 都是 AOP 思想的實現，只不過是不同位置的切面，它們都可以靈活的作用在某個路由或者全部路由，這就是 AOP 的優勢。

我們通過源碼來看了它們的調用順序，Middleware 是 Express 的概念，在最外層，到了某個路由之後，會先調用 Guard，Guard 用於判斷路由有沒有權限訪問，然後會調用 Interceptor，對 Contoller 前後擴展一些邏輯，在到達目標 Controller 之前，還會調用 Pipe 來對參數做驗證和轉換。所有的 HttpException 的異常都會被 ExceptionFilter 處理，返回不同的響應。

Nest.js 就是通過這種 AOP 的架構方式，實現了松耦合、易於維護和擴展的架構。

AOP 架構的好處，你感受到了麼？

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/fs7EPC8lzOABHhj3ayS0Jw