Koa 路由自动化

因为工作和自身(偷懒)的原因，时隔5个多月没有写文章了，今日重新提笔

一、写作背景

• 此前开发项目时，每增加一个路由就得改很多地方，很不方便
• 我发现公司原有的项目里根本没有route层，而是以文件路径+方法名作为路由
• 那么，为什么能抛却路由层，而以文件路径 + 方法名作为路由呢？经过一段时间的思考 + 网上查找资料 + 参考公司原有项目，终于得到了答案
• 下面，我会尽量详细的讲述我的思考过程 和 以文件路径 + 方法名作为路由的实现原理

二、思考过程 + 原理

• 思考过程
  • 路由的本质是什么？为什么使用了koa-router之后指定路由 + 方法名再注册就可以实现不同的路由？这两个问题知道了也就知道如何实现路由自动化了
  • 苦思冥想不如实际操作一下，我通过vscode启动我的测试项目，并使用postman请求了一个该项目根本不存的路由，通过断点测试我发现请求的路由路径会包含在ctx.url里面
  • 知道了这个，其实就是前进了一大步了
  • 既然：即使请求的路由路径在项目中不存在，也可以正常进入，仅仅只是报not found 而已，那么我为什么不能先拿到请求路径，再依赖请求路径进行下一步操作呢？
  • 而此时，我又想到一个问题：为什么已经注册过的路由，程序能够找到方法执行？而没有注册过的就不能？
  • 所以，综上，我大胆猜测：路由的注册仅仅只是一个类似于导航的作用，即：发出请求后，程序会根据当前请求路径在所有的路由中寻找匹配的项，找到了就执行对应的方法，找不到当然就没有然后了
  • 那么，我是否可以如此假设：只要在请求结束之前，根据请求的路由路径，计算出文件位置和方法名，然后使用requre获取到文件，再执行对应方法就可以了
  • 很明显在接下来的测试中验证了我的假设
  • 至此，思考过程到此结束，答案自然也浮之水面
• 路由本质
  • 在此刻，以我粗略的见解，我认为路由的本质是
    • 根据传入的路由路径的不同，执行特定的方法

三、项目实例

https://github.com/ShyGodB/qbfang-blog

• 根据之前的思考得出的结论，我在我的项目中进行了如下两部操作
  • 在项目根目录下新建 api 文件夹，并新建文件 route.js
  • 在 app.js 中通过require 引入route.js ，再使用 app.use 注册执行
• 下面是两个文件的代码，我将在代码中解释每一句的具体含义
• route.js

// 定义一个过滤方法，通过请求路径获取文件路径和方法名
const filter = (ctx) => {
    // 此句代码是为了兼容get请求，如果只用 post 可忽略
    const url = ctx.url.split('?')[0].toLowerCase()
    // 通过js的split方法将请求路径打散，得到一个数组，方法名就是数组的最后一项
    const actions = url.split('/')
    // 根据自己的项目路径和请求路径拼接文件 url
    const methodUrl = '../src/control/' + actions[2] + '/' + actions[3]
    // 取得方法名字
    const methodName = actions[4]
    // 返回文件路径和方法名
    return { methodUrl, methodName }
}

// 暴露一个异步方法，供外部使用( app.js )
module.exports = async (ctx, next) => {
    // 执行过滤方法，获得文件路径和方法名
    const { methodUrl, methodName } = filter(ctx)
    // 通过 require 引入文件
    const obj = await require(methodUrl)
    // 获得并执行方法
    await obj[methodName](ctx);
    // 下一步
    await next()
};

• app.js

const Koa = require('koa');
const json = require('koa-json');
// 引入文件 - route.js
const route = require('./api/route');
const bodyParser = require('koa-bodyparser');
const validate = require('koa-validate');
const mongodb = require('./config/mongodb');
const app = new Koa();
const port = 3000;

app.use(json());
// 通过 app.use 执行route.js 暴露出来的方法
app.use(route);
app.use(bodyParser());
validate(app);

(async () => {
    await mongodb.connect();
    app.listen(port, () => {
        console.log(`The servier is running at http:127.0.0.1:${port}`);
    });
})();

⚠️：

• 上面展示的 route.js 中对文件路径和方法名的处理仅适用于我的测试项目，如果要测试，请诸位根据自己的实际项目进行处理
• 上面的代码并未对请求的参数进行封装，而且我本人并未对请求时的参数传递进行测试，这一块请谅解，当然，我后面肯定会逐渐完善此项目，敬请期待！

附：我的项目目录

==>

image.png

四、结束语

• 好了，这片文章就到这里了，下次有机会再见了
• 最后，感谢一下关注我的童鞋们，谢谢！🙏