带你快速入门koa：koa-router路由系统解析带你快速入门koa：koa-router路由系统解析目录 [TOC

带你快速入门koa：koa-router路由系统解析

[TOC]

一、自己手写实现简单的koa路由系统

koa本身是一个高级应用框架之下的框架，所以很多东西都是精简的，需要我们自己根据需要引入插件，本身是没有路由系统的。本身要做路由引导，可以简单的做逻辑处理。

需要返回什么给客户端，直接传给ctx.body就可以，koa自动帮我们做了序列化操作。

二、koa-router插件，三步实现简单的路由

var Koa = require('koa');
var Router = require('koa-router');
 
// 第一步：实例化koa-router
var app = new Koa();
var router = new Router();
 
// 第二步：给koa-router对象添加路由和对应的处理函数
router.get('/', (ctx, next) => {
  // 后面会把这个函数注册成中间件，所以这里放心使用ctx和next
  // ctx.router available
});
 
// 第三步：将koa-router对象的所有路由和处理函数注册成为中间件
app
  .use(router.routes())
  .use(router.allowedMethods());

allowedMethods 方法

allowedMethods 方法是 koa-router 的一个实例方法，它用于处理HTTP请求中不被当前路由支持的方法。当一个请求到达，但是没有匹配的路由可以处理这个请求的方法时（例如，一个 POST 请求到达了一个只接受 GET 请求的路由）， koa-router 会使用这个方法来响应。

功能： allowedMethods 方法会检查当前请求的方法是否被允许。如果不被允许，它会发送一个 405 Method Not Allowed 响应，包含一个 Allow 头部，列出所有允许的方法。
使用场景 ：当你希望在不支持某些HTTP方法时，给客户端一个清晰的反馈，告诉它们哪些方法是被支持的。
配置：这个方法通常不需要手动调用， koa-router 会自动处理不支持的方法，并调用 allowedMethods 方法来响应。

routes 方法

routes 方法是 koa-router 的一个实例方法，用于获取所有注册的路由。

功能： routes 方法返回一个中间件，这个中间件会处理所有注册的路由。当Koa应用调用这个中间件时，它会根据请求的路径和方法来匹配路由，并执行相应的路由处理函数。
使用场景 ：这个方法通常在设置路由中间件时被调用，以确保所有的路由都能被Koa应用处理。
配置：你可以在创建 koa-router 实例后，使用 .routes() 方法来获取中间件，并将其应用到Koa应用中。例如：

const Router = require('koa-router');
const router = new Router();
 
// 定义一些路由
router.get('/users', async (ctx) => {
  ctx.body = '用户列表';
});
 
// 将路由中间件应用到Koa应用
app.use(router.routes());

在上述代码中， router.routes() 返回的中间件包含了所有注册的路由，并且会被Koa应用使用来处理请求。

三、常见类型请求的处理

//根据需要修改
router
  .get('/', (ctx, next) => {
    ctx.body = 'Hello World!';
  })
  .post('/users', (ctx, next) => {
    // ...
  })
  .put('/users/:id', (ctx, next) => {
    // ...
  })
  .del('/users/:id', (ctx, next) => {
    // ...
  })
  .all('/users/:id', (ctx, next) => {
    // ...
  });

四、router中的参数传递方式

（1）地址query

路由：/users

地址：localhost:4000/users?q=1

取值：ctx.query

结果：{ q: 1 }

（2）获取router params

路由：/users/:id

地址：localhost:4000/users/1

取值方式：ctx.params

结果：{ id: 1}

（3）请求体body

路由：/users

地址：localhost:4000/users，content-type为application/json，参数{"name": "zj"}

取值：先提前安装 koa-bodyparser： const bodyParser = require("koa-bodyparser"); app.use(bodyParser()); 再：ctx.request.body

结果：{ "name": "zj" }

五、将api router抽离到单独文件

入口代码导入抽离逻辑代码，上层代码导入下层代码

// demo/api/api1.js
 
const Router = require("koa-router");
 
const router = new Router();
 
router.get("/api1", async (ctx, next) => {
  ctx.body = "api1";
});
 
module.exports = router;

// demo/app.js
 
const Koa = require("koa");
const api1 = require("./api/api1");
const api2 = require("./api/api2");
 
const app = new Koa();
const port = 3000;
 
app.use(api1.routes()).use(api1.allowedMethods());
app.use(api2.routes()).use(api2.allowedMethods());
 
app.listen(3000);
console.log("程序已经启动，在" + port + "端口监听");

六、router.prefix()将路径中公共的部分先抽离出来

在实例化 Router 的时候可以设置前缀，之后匹配的请求都会自动添加这个前缀。

const router = require('koa-router')()
 
router.prefix('/users')
 
router.get('/', function (ctx, next) {
  ctx.body = 'this is a users response!'
})
 
router.get('/bar', function (ctx, next) {
  ctx.body = 'this is a users/bar response'
})
 
module.exports = router

七、实现路由自动加载

思路：

1.自动去寻找文件夹中的api文件 require进来

2.router require进来以后，自动注册到app中

router.use() 是 Koa Router 的一个重要方法，主要有以下几个用途：

注册中间件

// 可以注册应用级中间件
router.use(async (ctx, next) => {
    // 中间件逻辑
    await next()
})

挂载路由模块

// 可以挂载其他路由实例
const userRouter = new Router()
router.use('/users', userRouter.routes())

挂载路由模块

// 可以挂载其他路由实例
const userRouter = new Router()
router.use('/users', userRouter.routes())

具体实现

const fs = require("fs");
const Router = require("koa-router");
const router = new Router();
 
fs.readdirSync(__dirname).forEach((file) => {
  // 排除 index.js 文件和非路由文件
  if (file !== "index.js") {
    // 导入路由模块
    const r = require(`./${file}`);
    // 注册路由 （r.routes() 返回一个中间件）
    router.use(r.routes());
  }
});
 
module.exports = router;

这行代码的作用是将其他路由模块(如 goods.route.js)的路由配置整合到主路由实例中。r.routes() 会返回一个中间件函数，这个函数包含了该路由模块定义的所有路由规则。

const router = require("../router");
// 注册路由 routes方法返回一个中间件注册所有的 (allowedMethods 处理404 500)
app.use(router.routes()).use(router.allowedMethods());