添加中间件注释,优化APILoader日志

This commit is contained in:
tone
2024-09-25 01:25:03 +08:00
parent 7acdfc2c68
commit 3b500c71ec
4 changed files with 6 additions and 2 deletions

View File

@@ -25,10 +25,10 @@ class APILoader {
try { try {
await func(req, res, next); await func(req, res, next);
} catch (error) { } catch (error) {
this.logger.error(`[${instance.method}][${instance.path}][API Middleware Function: ${func.name}]: ${error}`); this.logger.error(`[${instance.method}][${instance.path}][Middleware Function: ${func.name}]: ${error}`);
} }
}); });
this.logger.info(`[${instance.method}][${instance.path}][API Middleware Function: ${func.name}] is enabled`); this.logger.info(`[${instance.method}][${instance.path}][Middleware Function: ${func.name}] is enabled`);
} }
// handle request // handle request

View File

@@ -2,6 +2,7 @@ import { Request, Response, NextFunction } from "express"
import Logger from "@lib/Logger/Logger"; import Logger from "@lib/Logger/Logger";
const logger = new Logger('API', 'Middleware', 'MountIP'); const logger = new Logger('API', 'Middleware', 'MountIP');
// 挂载IP将请求的ip地址挂载到data._ip属性下
let MountIP = (req: Request, res: Response, next: NextFunction) => { let MountIP = (req: Request, res: Response, next: NextFunction) => {
let ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.ip; let ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.ip;
if (ip == undefined || ip.length <= 0) { if (ip == undefined || ip.length <= 0) {

View File

@@ -2,6 +2,7 @@ import { Request, Response, NextFunction } from "express"
import Logger from "@lib/Logger/Logger"; import Logger from "@lib/Logger/Logger";
const logger = new Logger('API', 'Middleware', 'MountUserAgent') const logger = new Logger('API', 'Middleware', 'MountUserAgent')
// 挂载用户代理将请求的请求代理挂载到data._userAgent属性下
let MountUserAgent = (req: Request, res: Response, next: NextFunction) => { let MountUserAgent = (req: Request, res: Response, next: NextFunction) => {
req.body._userAgent = req.headers['user-agent']; req.body._userAgent = req.headers['user-agent'];
logger.info(`[${req.method}][${req.url.split('?')[0]}] User agent parsed successfully: ${req.body._userAgent}`); logger.info(`[${req.method}][${req.url.split('?')[0]}] User agent parsed successfully: ${req.body._userAgent}`);

View File

@@ -1,6 +1,8 @@
import { Request, Response, NextFunction } from "express"; import { Request, Response, NextFunction } from "express";
import Logger from "@lib/Logger/Logger"; import Logger from "@lib/Logger/Logger";
const logger = new Logger('API', 'Middleware', "Unbind"); const logger = new Logger('API', 'Middleware', "Unbind");
// 解绑接口用于生产环境应用屏蔽某些不建议启用的API
const Unbind = (req: Request, res: Response, next: NextFunction) => { const Unbind = (req: Request, res: Response, next: NextFunction) => {
let ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.ip; let ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.ip;
logger.warn(`API[${req.method}][${req.url.split('?')[0]}] requested an unbound endpoint [${ip}]`); logger.warn(`API[${req.method}][${req.url.split('?')[0]}] requested an unbound endpoint [${ip}]`);