简介:

结合 koa 框架和 koa-router 中间件, 编写的自动化路由插件 省去纷繁复杂的路由编写

安装和使用:

初始化一个 node 项目, 安装以下依赖

npm i koa

npm i koa-router

npm i koa-automate-router

创建 index.js 文件和 router 目录

初始化代码

// 引入外部依赖
const Koa = require('koa');
const autoRouter = require("koa-automate-router")

// 实例化一个服务器并监听一个端口
const app = new Koa();
app.listen(80);

// 调用自动化路由
autoRouter(__dirname + "/router", app);

业务逻辑代码格式

1, 我们在router目录下创建一个子目录 home

2, 在 home 目录下创建文件 test.js

3, test.js 的内容如下, 基本是 koa-router 的内容, 看不懂请先学习 koa-router

const Router = require("koa-router");
let router = new Router();

router.get("/home/test/get", async(ctx) => {
    ctx.body = "这里是 GET 请求";
});

router.post("/home/test/post", async(ctx) => {
    ctx.body = "这里是 POST 请求";
});

module.exports = router;

4, 如上, 我们就可以通过路由 localhost/home/test/get 或 localhost/home/test/post 访问到 test.js 中两个配置好的路由

4.1 /home/test/get 对应 router.get() 方法的 第一个参数

4.2 为了后期好维护 路由的命名最好使用 目录名/文件名/方法名 的方式

4.3 尽量避免路由出现重复的情况，扫描时从上到下，文件排序在前的优先级高

建议

router 目录值作为控制器, 具体的业务逻辑不要写在这个目录内