feat: 统一后端响应格式
This commit is contained in:
22
apps/backend/src/common/exceptions/business.exception.ts
Normal file
22
apps/backend/src/common/exceptions/business.exception.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
import { HttpStatus } from '@nestjs/common';
|
||||
|
||||
export class BusinessException {
|
||||
|
||||
public statusCode: HttpStatus;
|
||||
public message: string;
|
||||
public code: number;
|
||||
public data: any;
|
||||
|
||||
constructor(args: {
|
||||
statusCode?: HttpStatus,
|
||||
message?: string,
|
||||
code?: number,
|
||||
data?: any,
|
||||
}) {
|
||||
const { statusCode, message, code, data } = args;
|
||||
this.statusCode = statusCode || HttpStatus.BAD_REQUEST;
|
||||
this.message = message || '请求错误';
|
||||
this.code = code || -1;
|
||||
this.data = data || null;
|
||||
}
|
||||
}
|
||||
43
apps/backend/src/common/filters/global.exceptions.filter.ts
Normal file
43
apps/backend/src/common/filters/global.exceptions.filter.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import { ArgumentsHost, ExceptionFilter, HttpException, HttpStatus, Logger } from "@nestjs/common";
|
||||
import { Request, Response } from "express";
|
||||
import { BusinessException } from "../exceptions/business.exception";
|
||||
|
||||
export class GlobalExceptionsFilter implements ExceptionFilter {
|
||||
catch(exception: any, host: ArgumentsHost) {
|
||||
const ctx = host.switchToHttp();
|
||||
const response = ctx.getResponse<Response>();
|
||||
const request = ctx.getRequest<Request>();
|
||||
|
||||
let statusCode = HttpStatus.INTERNAL_SERVER_ERROR;
|
||||
let errorResponse = {
|
||||
success: false,
|
||||
message: '服务器内部错误',
|
||||
code: -1,
|
||||
data: null as any,
|
||||
};
|
||||
|
||||
if (exception instanceof BusinessException) {
|
||||
statusCode = exception.statusCode;
|
||||
const { message, code, data } = exception;
|
||||
errorResponse = {
|
||||
...errorResponse,
|
||||
message, code, data,
|
||||
}
|
||||
} else if (exception instanceof HttpException) {
|
||||
// 当HttpException传入类型为string时,响应data为null,message为传入的string
|
||||
// 其他请况(object/number),响应为传入数据,message为HttpException的错误码
|
||||
statusCode = exception.getStatus();
|
||||
const response = exception.getResponse() as Record<string, any>;
|
||||
if (response.message) {
|
||||
errorResponse.message = response.message;
|
||||
} else {
|
||||
errorResponse.message = '请求失败';
|
||||
errorResponse.data = response;
|
||||
}
|
||||
} else {
|
||||
Logger.warn(exception, request.path);
|
||||
}
|
||||
|
||||
response.status(statusCode).json(errorResponse);
|
||||
}
|
||||
}
|
||||
@@ -15,7 +15,8 @@ export class ResponseInterceptor implements NestInterceptor {
|
||||
): Observable<any> | Promise<Observable<any>> {
|
||||
return next.handle().pipe(
|
||||
map((data) => ({
|
||||
statusCode: 200,
|
||||
success: true,
|
||||
code: 0,
|
||||
message: '请求成功',
|
||||
data,
|
||||
})),
|
||||
|
||||
Reference in New Issue
Block a user