第一步：創(chuàng)建一個基礎項目
第二步：創(chuàng)建寫接口的模塊嘲玫，建立moogodb數(shù)據(jù)庫連接泽裳，寫添加與查詢接口
第三步：加入Swagger文檔
第四步：加入請求參數(shù)校驗
第五步：解決跨域問題网梢，返回 token，校驗token, 并定義將接收的參數(shù)全局存儲的方法
-
注：不要關心注釋代碼畦幢，那是屬于后面功能的區(qū)域入热。因為隨著代碼體量加大，功能不再明確解总，只需按照步驟并參考效果圖贮匕，把關鍵代碼寫入即可，所以下只寫關鍵代碼花枫，具體請看效果圖粗合。
項目地址
1 日志配置
// 日志 - 配置包描述
// 日志庫
import * as winston from 'winston';
// 日志庫的插件
import { WinstonModule } from 'nest-winston';
// 一個用于 winston 日志庫的插件 // https://www.npmjs.com/package/winston-daily-rotate-file
import * as DailyRotateFile from 'winston-daily-rotate-file';
mports: [
// 日志配置
WinstonModule.forRoot({
transports: [
new DailyRotateFile({
dirname: `logs`, // 日志保存的目錄
// dirname: `D:\\`, // 日志保存的目錄 // 保存到本地
filename: '%DATE%.log', // 日志名稱，%DATE% 占位符表示日期乌昔。隙疚。
datePattern: 'YYYY-MM-DD', // 日志輪換的頻率，此處表示每天磕道。
zippedArchive: true, // 是否通過壓縮的方式歸檔被輪換的日志文件供屉。
maxSize: '20m', // 設置日志文件的最大大小，m 表示 mb 溺蕉。
maxFiles: '14d', // 保留日志文件的最大天數(shù)伶丐，此處表示自動刪除超過 14 天的日志文件。
// 記錄時添加時間戳信息
format: winston.format.combine(
winston.format.timestamp({
format: 'YYYY-MM-DD HH:mm:ss',
}),
winston.format.json(),
),
}),
],
}),
]
效果圖
2 創(chuàng)建處理請求頭信息的方法
- 在項目
src文件夾下創(chuàng)建logServer文件夾疯特，并創(chuàng)建requestData.ts文件
～ /src/logServer/requestData.ts
// 處理請求頭信息的方法
import { Request } from 'express';
export const getReqMainInfo: (req: Request) => {
[prop: string]: any;
} = (req) => {
const { query, headers, url, method, body, connection } = req;
// 獲取 IP
const xRealIp = headers['X-Real-IP'];
const xForwardedFor = headers['X-Forwarded-For'];
const { ip: cIp } = req;
const { remoteAddress } = connection || {};
const ip = xRealIp || xForwardedFor || cIp || remoteAddress;
return {
url,
host: headers.host,
ip,
method,
query,
body,
};
};
3 開啟請求攔截器與異常過濾器來記錄日志
3.1 響應攔截器
3.1.1 在項目src文件夾下創(chuàng)建unify-response.interceptor.ts文件
～ /src/unify-response.interceptor.ts
// 在響應攔截器中記錄日志
// https://docs.nestjs.cn/9/interceptors
import {
CallHandler,
ExecutionContext,
Inject,
Injectable,
NestInterceptor,
} from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
import { Request } from 'express';
import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
import { Logger } from 'winston';
import { getReqMainInfo } from './logServer/requestData';
@Injectable()
export class UnifyResponseInterceptor implements NestInterceptor {
constructor(
@Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
) {}
intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
const ctx = context.switchToHttp();
const req = ctx.getRequest<Request>();
return next.handle().pipe(
map((data) => {
this.logger.info('response', {
responseData: data,
req: getReqMainInfo(req),
});
return data
}),
);
}
}
3.1.2 在項目app.module.ts文件夾下引入并使用unify-response.interceptor.ts文件
～ /src/app.module.ts
//攔截器
import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core';
// 全局響應攔截器
import { UnifyResponseInterceptor } from './unify-response.interceptor';
providers: [
AppService,
GlobalParamsService,
// 應用響應攔截器
{
provide: APP_INTERCEPTOR,
useClass: UnifyResponseInterceptor,
},
],
效果圖
3.2 異常過濾器
3.2.1 在項目src文件夾下創(chuàng)建uinify-exception.filter.ts文件
～ /src/uinify-exception.filter.ts
// 在全局異常過濾器中記錄日志
// https://docs.nestjs.cn/9/exceptionfilters?id=%e5%bc%82%e5%b8%b8%e8%bf%87%e6%bb%a4%e5%99%a8-1
import {
ArgumentsHost,
Catch,
ExceptionFilter,
HttpException,
HttpStatus,
Inject,
} from '@nestjs/common';
import { Response, Request } from 'express';
import { WINSTON_MODULE_PROVIDER } from 'nest-winston';
import { Logger } from 'winston';
import { getReqMainInfo } from './logServer/requestData';
@Catch()
export default class UnifyExceptionFilter implements ExceptionFilter {
// 注入日志服務相關依賴
constructor(
@Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
) {}
catch(exception: HttpException, host: ArgumentsHost) {
const ctx = host.switchToHttp(); // 獲取當前執(zhí)行上下文
const response = ctx.getResponse<Response>(); // 獲取響應對象
const request = ctx.getRequest<Request>(); // 獲取請求對象
const status =
exception instanceof HttpException
? exception.getStatus()
: HttpStatus.INTERNAL_SERVER_ERROR;
const responses = response.status(status).json({
statusCode: status,
timestamp: new Date().toISOString(),
path: request.url,
});
// 記錄日志（錯誤消息哗魂，錯誤碼，請求信息等）
this.logger.error('', {
status,
req: getReqMainInfo(request),
stack: exception.stack,
});
response.status(status >= 500 ? status : 201).json(response);
}
}
3.1.2 在項目app.module.ts文件夾下引入并使用uinify-exception.filter.ts文件
～ /src/app.module.ts
//攔截器
import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core';
// 全局異常過濾器
import UnifyExceptionFilter from './uinify-exception.filter';
providers: [
AppService,
GlobalParamsService,
// 應用全局異常過濾器
{
provide: APP_FILTER,
useClass: UnifyExceptionFilter,
},
],
效果圖
3 效果
-
此時隨便調用一個接口就會在項目里看到日志
效果圖
