nestjs中異常過濾器Exceptionfilter的具體使用
說起Nestjs的異常過濾器,不能不提.Net的全局過濾器Filter,功能那是相當(dāng)?shù)膹?qiáng)悍,用理論話說叫AOP 面向切面編程,可謂方便了太多需要異常處理的場景。說回Nestjs的異常過濾器,實現(xiàn)類似的功能,采用相似的處理方式,只不過一個面向C#,一個面向Nodejs,很榮幸的我,在兩個框架都找到了類似的東西。
面向切面編程AOP,是一種類似于編程規(guī)范的東東,同門師兄弟有叫面向接口編程、SOLID原則等等。
Nestjs的異常處理
默認(rèn)異常處理
Nestjs內(nèi)置了默認(rèn)的全局異常過濾器,處理能夠轉(zhuǎn)換成Httpexception的異常。
如果是Httpexception或其子類異常,那么會返回該異常的JSON格式:
{"exceptionCode":40005,"message":"自定義異常","path":"/"}
如果不是Httpexception或其子類異常,那么會返回:
{"statusCode":500,"message":"Internal server error"}
由于Nestjs采用了內(nèi)置的默認(rèn)異常處理,因此不會出現(xiàn)由于出現(xiàn)未捕獲的異常導(dǎo)致程序崩潰。
自定義異常過濾器處理
由于內(nèi)置異常處理返回值格式無法調(diào)整,因此自定義異常就顯得又為正常。自定義異??梢允狗祷禺惓P畔⒆远x,且可以增加自定義異常編碼,方便客戶端人員根據(jù)異常編碼進(jìn)行不同的展示。
如何自定義異常?
不重復(fù)造輪子是程序員的自我約束,首先我們新建我們自己的異常基類:
import { HttpException } from "@nestjs/common"; /** * 定義基礎(chǔ)異常類 * * @export * @class BaseException * @extends {HttpException} */ export class BaseException extends HttpException { /** * Creates an instance of BaseException. * @param {number} exceptionCode 自定義異常編號 * @param {string} errorMessage 提示信息 * @param {number} statusCode 狀態(tài)碼 * @memberof BaseException */ constructor(public exceptionCode: number, public errorMessage: string, public statusCode: number) { super({ exceptionCode: exceptionCode, errorMessage: errorMessage }, statusCode); } /** * 獲取自定義異常代碼 * * @return {*} * @memberof BaseException */ getExceptionCode(): number { return this.exceptionCode; } getErrorMessage(): string { return this.errorMessage; } getStatusCode(): number { return this.statusCode; } }
然后我們新建一個未授權(quán)異常類型,其中增加了自定義異常代碼:
import { HttpStatus } from "@nestjs/common"; import { BaseException } from "./base.exception"; export class UnCauhtException extends BaseException { constructor() { super(40000, "系統(tǒng)運(yùn)行異常,請聯(lián)系管理員!", HttpStatus.FORBIDDEN); } }
建立好了自定義異常,那么我們就需要處理未授權(quán)異常,首先新建自定義異常處理基類,請注意 此處我們使用的事Express:
import { ArgumentsHost, ExceptionFilter, HttpException } from "@nestjs/common"; import { HttpArgumentsHost } from "@nestjs/common/interfaces"; import { BaseException } from "src/exceptions/base.exception"; import { Response, Request } from "express"; /** * 異?;A(chǔ)類過濾器 * * @export * @class BaseExceptionFilter * @implements {ExceptionFilter<BaseException>} */ export abstract class BaseExceptionFilter implements ExceptionFilter<BaseException> { /** * 異常類捕獲 * * @abstract * @param {BaseException} exception * @param {ArgumentsHost} host * @memberof BaseExceptionFilter */ abstract catch(exception: BaseException, host: ArgumentsHost); /** * 獲取http請求上下文參數(shù) * * @protected * @param {ArgumentsHost} host * @return {*} * @memberof BaseExceptionFilter */ protected getHttpContext(host: ArgumentsHost) { return host.switchToHttp(); } /** * 獲取http 響應(yīng)參數(shù) * * @protected * @param {HttpArgumentsHost} httpContext * @return {*} * @memberof BaseExceptionFilter */ protected getResponse(httpContext: HttpArgumentsHost): Response { return httpContext.getResponse<Response>(); } /** * 獲取http請求參數(shù) * * @protected * @param {HttpArgumentsHost} httpContext * @return {*} * @memberof BaseExceptionFilter */ protected getRequest(httpContext: HttpArgumentsHost): Request { return httpContext.getRequest<Request>(); } /** * 寫入異常信息到客戶端 * * @param {ArgumentsHost} host * @param {BaseException} exception * @memberof BaseExceptionFilter */ protected writeToClient(host: ArgumentsHost, exception: BaseException) { const ctx = this.getHttpContext(host); if(exception instanceof BaseException){ this.getResponse(ctx).status(exception.statusCode).json({ exceptionCode: exception.getExceptionCode(), message: exception.getErrorMessage(), path: this.getRequest(ctx).url }); }else { const httpException=exception ; this.getResponse(ctx).status(500).json({ message: "未處理的異常", path: this.getRequest(ctx).url }); } } }
新建未授權(quán)異常處理:
import { ArgumentsHost, Catch } from "@nestjs/common"; import { AuthException } from "src/exceptions/auth.exception"; import { BaseException } from "src/exceptions/base.exception"; import { BaseExceptionFilter } from "./base.exception.filter"; @Catch(AuthException) export class AuthExceptionFilter extends BaseExceptionFilter { constructor(){ super(); console.log("授權(quán)異常構(gòu)造函數(shù)初始化"+new Date().toISOString()); } catch(exception: AuthException, host: ArgumentsHost) { exception.exceptionCode=40002; console.log("授權(quán)異常執(zhí)行"+new Date().toISOString()); this.writeToClient(host,exception); } }
針對未授權(quán)異常處理類,進(jìn)行幾點(diǎn)說明:
- 增加了Catch注解,只捕獲Authexception的異常,其他類型的異常此類不進(jìn)行處理
- 繼承自定義異常處理類Baseexceptionfilter
應(yīng)用范圍
異常處理類可應(yīng)用于method、controller、全局,甚至同一個Controller可以定義多個自定義異常類
import { Controller, ForbiddenException, Get, HttpException, HttpStatus, UseFilters } from '@nestjs/common'; import { AppService } from './app.service'; import { AuthException } from './exceptions/auth.exception'; import { BusinessException } from './exceptions/business.exception'; import { UnCauhtException } from './exceptions/uncauht.exception'; import { AuthExceptionFilter } from './filters/auth.exception.filter'; import { BusinessExceptionFilter } from './filters/business.exception.filter'; /** * 帶有單個路由的基本控制器示例ff */ @UseFilters(AuthExceptionFilter,BusinessExceptionFilter) @Controller() export class AppController { constructor(private readonly appService: AppService) {} @Get() getHello(): string { //throw new Error("666"); throw new BusinessException("自定義異常",HttpStatus.OK); throw new AuthException(); throw new HttpException("自定義異常",HttpStatus.FORBIDDEN); return this.appService.getHello(); } @Get("name") getName():string { return "guozhiqi"; } }
幾點(diǎn)說明:
- 我們使用Usefilters注解進(jìn)行異常過濾器的添加
- 我們在Appcontroller中定義了兩種不同類型的自定義異常處理類
- 也就是我們Appcontroller中拋出的異常,只要是我們定義的這兩種,那么都可以被正常處理。
幾點(diǎn)疑問
Usefitlers中我們自定義的異常處理類會初始化幾次?
答案:我們通過類型注冊到Appcontroller的自定義異常類只會在程序初始化的時候初始化一次。也就是說程序啟動之后,每個
controller、每個method定義了哪些異常處理類都已經(jīng)確定。
如果我們捕獲到異常,但不進(jìn)行任何處理,會發(fā)生什么?
答案:如果我們的異常處理方法什么也不做,那么恭喜你,會成功的將瀏覽器請求hang死,因為異常未處理,那么瀏覽器會一直得不到響應(yīng)。
多個異常之間的處理順序如何?
答案:如果多個異常處理均可以捕獲到該異常,那么只有第一個有效,也就是說異常處理類和 中間件不同,異常處理類只能其中一個處理,而中間件需要都進(jìn)行處理。
Nestjs的@Usefilters 像誰?
首先從JS角度來看,像Angular,如果往后端看,最像Spring。
Nestjs的異常處理并不復(fù)雜,復(fù)雜的是需要我們針對不同類型的異常進(jìn)行處理,提取異常的共性。
參考文檔:docs.nestjs.cn
到此這篇關(guān)于nestjs中異常過濾器Exceptionfilter的具體使用的文章就介紹到這了,更多相關(guān)nest 異常過濾器Exceptionfilter內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- 利用Dockerfile優(yōu)化Nestjs構(gòu)建鏡像大小詳情
- Dapr+NestJs編寫Pub及Sub裝飾器實戰(zhàn)示例
- Docker?Compose+Nestjs構(gòu)建Dapr?Redis發(fā)布訂閱分布式應(yīng)用
- NestJS+Redis實現(xiàn)緩存步驟詳解
- nestjs返回給前端數(shù)據(jù)格式的封裝實現(xiàn)
- NestJs使用Mongoose對MongoDB操作的方法
- NestJs 靜態(tài)目錄配置詳解
- 使用NestJS開發(fā)Node.js應(yīng)用的方法
- nestjs搭建HTTP與WebSocket服務(wù)詳細(xì)過程
相關(guān)文章
使用Meteor配合Node.js編寫實時聊天應(yīng)用的范例
這篇文章主要介紹了使用Meteor配合Node.js編寫實時聊天應(yīng)用的范例,Node.js作為異步框架,其最突出的使用便是用來編寫實時應(yīng)用程序,需要的朋友可以參考下2015-06-06Node.js中的async?和?await?關(guān)鍵字微任務(wù)和宏任務(wù)
這篇文章主要介紹了Node.js中的async和await關(guān)鍵字微任務(wù)和宏任務(wù),文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價值,需要的小伙伴可以參考一下2022-07-07詳解Node.js利用node-git-server快速搭建git服務(wù)器
本篇文章主要介紹了詳解Node.js利用node-git-server快速搭建git服務(wù)器,非常具有實用價值,需要的朋友可以參考下2017-09-09nodeJs爬蟲獲取數(shù)據(jù)簡單實現(xiàn)代碼
這篇文章主要為大家詳細(xì)介紹了nodeJs爬蟲獲取數(shù)據(jù)簡單實現(xiàn)代碼,感興趣的小伙伴們可以參考一下2016-03-03NestJS開發(fā)核心概念Providers類基本用法詳解
這篇文章主要為大家介紹了NestJS開發(fā)核心概念Providers類基本用法詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-08-08我的Node.js學(xué)習(xí)之路(三)--node.js作用、回調(diào)、同步和異步代碼 以及事件循環(huán)
本篇文章主要介紹了node.js的幾個重要的知識點(diǎn):node.js作用、回調(diào)、同步和異步代碼 以及事件循環(huán)2014-07-07