koa-router 使用教程

本系列是我的常用 koa 中间件使用笔记，防止忘记使用方法而作记录

Koa-router 是 koa 的一个路由中间件，它可以将请求的URL和方法（如：GET 、 POST 、 PUT 、 DELETE 等） 匹配到对应的响应程序或页面。可以把路由分发到各个文件里，起到分层的作用。

 

基本配置

下面的代码创建了一个 koa 的http 服务，引入user.js文件并且使用，并且监听3000端口。

//app.js

const Koa = require('koa'); // 引入koa
const app = new Koa(); // 创建koa应用

const user = require('./user');     //引入suer
app.use(user.routes(),user.allowedMethods());

app.listen(3000);

这是 user.js 文件。 

//user.js

const Router = require('koa-router')

const router = new Router({ //设置前缀
    prefix: '/user'
});

router.get('/string', async (ctx, next) => {
    ctx.body = 'user'
})

module.exports = router

 

不同请求方式

Koa-router 请求方式： get 、 put 、 post 、 patch 、 delete 、 del ，而使用方法就是 router.方式() ，比如 router.get() 和 router.post() 。而 router.all() 会匹配所有的请求方法。

当匹配成功就会执行中间件运行。

//匹配到get请求，在/string下
router.get('/string', async (ctx, next) => {
    ctx.body = 'user'
})

 

设置前缀

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

下面的链接 localhost:3000/user/string

const router = new Router({ //设置前缀
    prefix: '/user'
});

//我的链接 localhost:3000/user/string
router.get('/string', async (ctx, next) => {
    ctx.body = 'user'
})

 

.allowedMethods()用途

如果使用 post 请求访问 user 路由，默认会返回 not find 状态码404，因为没有匹配到。使用了 allowedMethods 会返回 Method Not Allowed 状态码 405。

并且如果访问 option 请求会默认返回1 状态码200

const Koa = require('koa'); // 引入koa
const app = new Koa(); // 创建koa应用

const user = require('./user');     //引入suer
app.use(user.routes(),user.allowedMethods());

throw 设置为 true 便会触发 methodNotAllowed 这个回调函数

app.use(user.allowedMethods({
    throw: true, //抛出错误，代替设置响应头状态
    methodNotAllowed: () => {  //不匹配方法执行的回调函数
        console.log('没有匹配到');
    }
}))