feat: 添加路由装饰器系统和全局异常处理
- 新增装饰器支持(@Get, @Post, @Put, @Delete, @Patch, @Controller) - 实现路由自动注册机制(RouteScanner) - 添加全局异常处理中间件(Exception) - 实现统一响应体格式(ApiResponse) - 新增请求体解析中间件(BodyParser) - 重构控制器为类模式，支持装饰器路由 - 添加示例用户控制器(UserController) - 更新TypeScript配置支持装饰器 - 添加reflect-metadata依赖 - 完善项目文档 Breaking Changes: - 控制器现在返回数据而不是直接设置ctx.body - 新增统一的API响应格式
This commit is contained in:
46
apps/server/middlewares/body-parser.ts
Normal file
46
apps/server/middlewares/body-parser.ts
Normal file
@@ -0,0 +1,46 @@
|
||||
import type Koa from 'koa';
|
||||
import type { Middleware } from './types.ts';
|
||||
|
||||
/**
|
||||
* 请求体解析中间件
|
||||
*/
|
||||
export class BodyParser implements Middleware {
|
||||
apply(app: Koa): void {
|
||||
// 使用动态导入来避免类型问题
|
||||
app.use(async (ctx, next) => {
|
||||
if (ctx.request.method === 'POST' ||
|
||||
ctx.request.method === 'PUT' ||
|
||||
ctx.request.method === 'PATCH') {
|
||||
|
||||
// 简单的JSON解析
|
||||
if (ctx.request.type === 'application/json') {
|
||||
try {
|
||||
const chunks: Buffer[] = [];
|
||||
|
||||
ctx.req.on('data', (chunk) => {
|
||||
chunks.push(chunk);
|
||||
});
|
||||
|
||||
await new Promise((resolve) => {
|
||||
ctx.req.on('end', () => {
|
||||
const body = Buffer.concat(chunks).toString();
|
||||
try {
|
||||
(ctx.request as any).body = JSON.parse(body);
|
||||
} catch {
|
||||
(ctx.request as any).body = {};
|
||||
}
|
||||
resolve(void 0);
|
||||
});
|
||||
});
|
||||
} catch (error) {
|
||||
(ctx.request as any).body = {};
|
||||
}
|
||||
} else {
|
||||
(ctx.request as any).body = {};
|
||||
}
|
||||
}
|
||||
|
||||
await next();
|
||||
});
|
||||
}
|
||||
}
|
||||
138
apps/server/middlewares/exception.ts
Normal file
138
apps/server/middlewares/exception.ts
Normal file
@@ -0,0 +1,138 @@
|
||||
import type Koa from 'koa';
|
||||
import type { Middleware } from './types.ts';
|
||||
|
||||
/**
|
||||
* 统一响应体结构
|
||||
*/
|
||||
export interface ApiResponse<T = any> {
|
||||
code: number; // 状态码：0表示成功，其他表示失败
|
||||
message: string; // 响应消息
|
||||
data?: T; // 响应数据
|
||||
timestamp: number; // 时间戳
|
||||
}
|
||||
|
||||
/**
|
||||
* 自定义业务异常类
|
||||
*/
|
||||
export class BusinessError extends Error {
|
||||
public code: number;
|
||||
public httpStatus: number;
|
||||
|
||||
constructor(message: string, code = 1000, httpStatus = 400) {
|
||||
super(message);
|
||||
this.name = 'BusinessError';
|
||||
this.code = code;
|
||||
this.httpStatus = httpStatus;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 全局异常处理中间件
|
||||
*/
|
||||
export class Exception implements Middleware {
|
||||
apply(app: Koa): void {
|
||||
app.use(async (ctx, next) => {
|
||||
try {
|
||||
await next();
|
||||
|
||||
// 如果没有设置响应体，则返回404
|
||||
if (ctx.status === 404 && !ctx.body) {
|
||||
this.sendResponse(ctx, 404, '接口不存在', null, 404);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('全局异常捕获:', error);
|
||||
this.handleError(ctx, error);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 处理错误
|
||||
*/
|
||||
private handleError(ctx: Koa.Context, error: any): void {
|
||||
if (error instanceof BusinessError) {
|
||||
// 业务异常
|
||||
this.sendResponse(ctx, error.code, error.message, null, error.httpStatus);
|
||||
} else if (error.status) {
|
||||
// Koa HTTP 错误
|
||||
const message = error.status === 401 ? '未授权访问' :
|
||||
error.status === 403 ? '禁止访问' :
|
||||
error.status === 404 ? '资源不存在' :
|
||||
error.status === 422 ? '请求参数错误' :
|
||||
error.message || '请求失败';
|
||||
|
||||
this.sendResponse(ctx, error.status, message, null, error.status);
|
||||
} else {
|
||||
// 系统异常
|
||||
const isDev = process.env.NODE_ENV === 'development';
|
||||
const message = isDev ? error.message : '服务器内部错误';
|
||||
const data = isDev ? { stack: error.stack } : null;
|
||||
|
||||
this.sendResponse(ctx, 500, message, data, 500);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送统一响应
|
||||
*/
|
||||
private sendResponse(
|
||||
ctx: Koa.Context,
|
||||
code: number,
|
||||
message: string,
|
||||
data: any = null,
|
||||
httpStatus = 200
|
||||
): void {
|
||||
const response: ApiResponse = {
|
||||
code,
|
||||
message,
|
||||
data,
|
||||
timestamp: Date.now()
|
||||
};
|
||||
|
||||
ctx.status = httpStatus;
|
||||
ctx.body = response;
|
||||
ctx.type = 'application/json';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建成功响应的辅助函数
|
||||
*/
|
||||
export function createSuccessResponse<T>(data: T, message = '操作成功'): ApiResponse<T> {
|
||||
return {
|
||||
code: 0,
|
||||
message,
|
||||
data,
|
||||
timestamp: Date.now()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建成功响应的辅助函数（自动设置消息）
|
||||
*/
|
||||
export function createAutoSuccessResponse<T>(data: T): ApiResponse<T> {
|
||||
let message = '操作成功';
|
||||
|
||||
// 根据数据类型自动生成消息
|
||||
if (Array.isArray(data)) {
|
||||
message = `获取列表成功，共${data.length}条记录`;
|
||||
} else if (data && typeof data === 'object') {
|
||||
message = '获取数据成功';
|
||||
} else if (data === null || data === undefined) {
|
||||
message = '操作完成';
|
||||
}
|
||||
|
||||
return createSuccessResponse(data, message);
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建失败响应的辅助函数
|
||||
*/
|
||||
export function createErrorResponse(code: number, message: string, data?: any): ApiResponse {
|
||||
return {
|
||||
code,
|
||||
message,
|
||||
data,
|
||||
timestamp: Date.now()
|
||||
};
|
||||
}
|
||||
@@ -1,10 +1,25 @@
|
||||
import { Router } from './router.ts';
|
||||
import { ResponseTime } from './responseTime.ts';
|
||||
import { Exception } from './exception.ts';
|
||||
import { BodyParser } from './body-parser.ts';
|
||||
import type Koa from 'koa';
|
||||
|
||||
export function registerMiddlewares(app: Koa) {
|
||||
const router = new Router();
|
||||
/**
|
||||
* 初始化中间件
|
||||
* @param app Koa
|
||||
*/
|
||||
export function initMiddlewares(app: Koa) {
|
||||
// 全局异常处理中间件必须最先注册
|
||||
const exception = new Exception();
|
||||
exception.apply(app);
|
||||
|
||||
// 请求体解析中间件
|
||||
const bodyParser = new BodyParser();
|
||||
bodyParser.apply(app);
|
||||
|
||||
const responseTime = new ResponseTime();
|
||||
responseTime.apply(app);
|
||||
|
||||
const router = new Router();
|
||||
router.apply(app);
|
||||
}
|
||||
|
||||
@@ -1,18 +1,83 @@
|
||||
import KoaRouter from '@koa/router';
|
||||
import type Koa from 'koa';
|
||||
import type { Middleware } from './types.ts';
|
||||
import { createAutoSuccessResponse } from './exception.ts';
|
||||
import { RouteScanner } from '../libs/route-scanner.ts';
|
||||
import { ApplicationController } from '../controllers/application.ts';
|
||||
import { UserController } from '../controllers/user.ts';
|
||||
import * as application from '../controllers/application.ts';
|
||||
|
||||
/**
|
||||
* 包装控制器函数，统一处理响应格式
|
||||
*/
|
||||
function wrapController(controllerFn: Function) {
|
||||
return async (ctx: Koa.Context, next: Koa.Next) => {
|
||||
try {
|
||||
// 调用控制器函数获取返回数据
|
||||
const result = await controllerFn(ctx, next);
|
||||
|
||||
// 如果控制器返回了数据，则包装成统一响应格式
|
||||
if (result !== undefined) {
|
||||
ctx.body = createAutoSuccessResponse(result);
|
||||
}
|
||||
// 如果控制器没有返回数据，说明已经自己处理了响应
|
||||
} catch (error) {
|
||||
// 错误由全局异常处理中间件处理
|
||||
throw error;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
export class Router implements Middleware {
|
||||
private router: KoaRouter;
|
||||
private routeScanner: RouteScanner;
|
||||
|
||||
constructor() {
|
||||
this.router = new KoaRouter({
|
||||
prefix: '/api',
|
||||
});
|
||||
this.router.get('/application/list', application.list);
|
||||
|
||||
// 初始化路由扫描器
|
||||
this.routeScanner = new RouteScanner('/api');
|
||||
|
||||
// 注册装饰器路由
|
||||
this.registerDecoratorRoutes();
|
||||
|
||||
// 注册传统路由（向后兼容）
|
||||
this.registerTraditionalRoutes();
|
||||
}
|
||||
|
||||
/**
|
||||
* 注册装饰器路由
|
||||
*/
|
||||
private registerDecoratorRoutes(): void {
|
||||
// 注册所有使用装饰器的控制器
|
||||
this.routeScanner.registerControllers([
|
||||
ApplicationController,
|
||||
UserController
|
||||
]);
|
||||
|
||||
// 输出注册的路由信息
|
||||
const routes = this.routeScanner.getRegisteredRoutes();
|
||||
console.log('装饰器路由注册完成:');
|
||||
routes.forEach(route => {
|
||||
console.log(` ${route.method} ${route.path} -> ${route.controller}.${route.action}`);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 注册传统路由（向后兼容）
|
||||
*/
|
||||
private registerTraditionalRoutes(): void {
|
||||
// 保持对老版本的兼容，如果需要可以在这里注册非装饰器路由
|
||||
// this.router.get('/application/list-legacy', wrapController(application.list));
|
||||
}
|
||||
|
||||
apply(app: Koa) {
|
||||
// 应用装饰器路由
|
||||
this.routeScanner.applyToApp(app);
|
||||
|
||||
// 应用传统路由
|
||||
app.use(this.router.routes());
|
||||
app.use(this.router.allowedMethods());
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user