如何在Node.js和Koa2中拆分路由以精简app.js文件？

好的，我来帮你搞定Koa路由拆分的事儿，这样你的app.js就能瞬间清爽起来！下面分步骤给你讲清楚怎么写拆分后的路由文件，以及怎么在主文件里引入使用。

一、编写单个路由文件 #

咱们以routers/help.js为例，其他的signup.js、signin.js写法基本一致，只需要对应调整路径和业务逻辑就行：

const Router = require('koa-router');
// 给这个路由设置前缀，这样所有该文件下的路由都会自动带上/help前缀
const router = new Router({ prefix: '/help' });

// 这里就是原来app.js里/help路由的逻辑，直接搬过来就行
router.get('/', async (ctx) => {
  // 你的业务代码，比如渲染页面、返回数据等
  ctx.body = '这是帮助页面';
});

// 如果这个路由下还有子路由，比如/help/faq，也可以直接在这里添加
// router.get('/faq', async (ctx) => {
//   ctx.body = '常见问题页面';
// });

// 导出这个路由实例
module.exports = router;

同理，signup.js的写法只需要把prefix改成'/signup'，然后处理对应的get('/')请求；signin.js对应改成'/signin'即可，逻辑代码直接从原app.js里迁移过来就好。

二、在app.js中整合拆分后的路由 #

为了让app.js更简洁，推荐在routers文件夹下建一个index.js作为路由统一入口，这样主文件只需要引入这一个文件就够了。

方式1：使用第三方包简化路由合并（推荐） #

先安装koa-combine-routers这个包，它能帮你快速合并多个路由实例：

npm install koa-combine-routers

然后编写routers/index.js：

const combineRouters = require('koa-combine-routers');

// 逐个引入拆分好的路由文件
const helpRouter = require('./help');
const signupRouter = require('./signup');
const signinRouter = require('./signin');

// 合并所有路由并导出
module.exports = combineRouters(
  helpRouter,
  signupRouter,
  signinRouter
);

最后修改app.js：

const Koa = require('koa');
const app = new Koa();
// 引入合并后的路由
const routers = require('./routers');

// 挂载路由中间件
app.use(routers());

// 你的其他中间件、配置等...

app.listen(3000, () => {
  console.log('服务已启动在http://localhost:3000');
});

方式2：手动挂载路由（无需额外依赖） #

如果你不想引入第三方包，也可以手动逐个挂载路由，写在routers/index.js里：

// 引入所有路由文件
const helpRouter = require('./help');
const signupRouter = require('./signup');
const signinRouter = require('./signin');

// 导出一个函数，接收app实例来挂载路由
module.exports = (app) => {
  // 挂载每个路由，同时调用allowedMethods处理405/501等状态
  app.use(helpRouter.routes()).use(helpRouter.allowedMethods());
  app.use(signupRouter.routes()).use(signupRouter.allowedMethods());
  app.use(signinRouter.routes()).use(signinRouter.allowedMethods());
};

对应的app.js修改：

const Koa = require('koa');
const app = new Koa();
const mountRouters = require('./routers');

// 调用挂载函数
mountRouters(app);

// 其他逻辑...

app.listen(3000);

最后看一下你的项目目录结构 #

整理后你的目录应该是这样的，非常清晰：

你的项目根目录
├── app.js
└── routers/
    ├── index.js
    ├── help.js
    ├── signup.js
    └── signin.js

这样拆分后，app.js里就不会堆满路由代码了，后续维护单个路由也更方便！

内容的提问来源于stack exchange，提问作者yupang