Koa+TypeScript自动化路由及全局异常处理之道

2023-10-17 17:15:21

Koa路由自动加载

Koa本身没有内置的路由功能，因此我们需要借助第三方库koa-router来实现路由功能。但是，随着路由数量的增加，在app.ts中引入大量的路由文件会使代码变得杂乱且难以维护。为了解决这个问题，我们可以通过编写一个简单的路由自动加载功能来简化代码。

首先，我们需要在项目中安装koa-router库：

npm install koa-router --save

然后，在项目目录中创建一个新的文件夹名为routes，并将所有的路由文件都放在这个文件夹中。
在app.ts文件中，我们可以编写一个简单的路由自动加载函数：

const fs = require('fs');
const path = require('path');

const router = require('koa-router')();

// 自动加载路由
const loadRoutes = () => {
  const routesPath = path.join(__dirname, 'routes');
  const files = fs.readdirSync(routesPath);
  files.forEach((file) => {
    const route = require(path.join(routesPath, file));
    router.use(route.routes(), route.allowedMethods());
  });
};

// 加载路由
loadRoutes();

这样，我们就可以通过这个函数自动加载所有的路由文件，并且无需在app.ts文件中手动引入每个路由文件。

Koa全局异常处理

在应用程序中，不可避免地会遇到各种异常情况，因此我们需要实现全局异常处理机制来捕获和处理这些异常，以确保应用程序的稳定性和可维护性。

首先，我们需要在项目中安装koa-bodyparser库，该库可以帮助我们解析请求体：

npm install koa-bodyparser --save

然后，在app.ts文件中，我们可以编写一个全局异常处理中间件：

const Koa = require('koa');
const app = new Koa();

// 全局异常处理中间件
app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    // 记录错误日志
    console.error(err);

    // 设置错误状态码
    ctx.status = err.status || 500;

    // 设置错误信息
    ctx.body = {
      code: ctx.status,
      message: err.message,
    };
  }
});