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

四、结束语

  • 好了,这片文章就到这里了,下次有机会再见了
  • 最后,感谢一下关注我的童鞋们,谢谢!🙏
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容