Koa2學習（六）使用koa-router

配置簡單路由

1. 引入中介軟體
2. 配置需要的路由
3. 通過app.use註冊路由

const Koa = require('koa')
const app = new Koa()
// 引入koa-router並對其例項化
const router = require('koa-router')()
// 配置get路由
router.get('/get', function (ctx, next) {
  ctx.body = 'this is a get response!'
})
// 配置post路由
router.post('/post', function (ctx, next) {
  ctx.body = 'this is a post response!'
})
// 註冊路由
app.use(router.routes(), router.allowedMethods())

app.listen(8000)

module.exports = app
 

請求後我們可以看到結果：
GET:

this is a get response!

POST:

this is a post response!

這是最基本的路由配置，雖然所有的路由都可以通過這樣的方式配，但是在實際專案中，這樣的程式碼後期會極其難以維護，我們還有更優雅的方式去配置你的路由。

配置路由層級

router.prefix

koa-router提供一種router.prefix方法，此方法對於某一個router來說，是一個全域性配置，此router的所有路徑都會自動被新增該字首。

const Koa = require('koa')
const app = new Koa()
// 引入koa-router
const router = require('koa-router')
// 這兩行程式碼等同於 const router1 = require('koa-router')()
const router1 = new router()
// 為router1配置路由字首
router1.prefix('/pre')
router1.get('/get', function (ctx, next) {
  ctx.body = 'this is a get1 response!'
})
// router2不配置路由字首
const router2 = new router()
router2.get('/get', function (ctx, next) {
  ctx.body = 'this is a get2 response!'
})
// 註冊路由
app.use(router1.routes(), router1.allowedMethods())
app.use(router2.routes(), router2.allowedMethods())

app.listen(8000)

module.exports = app
 

我們用瀏覽器訪問，發現get1的路由是/pre/get1，get2的路由是/get2:
localhost:8000/pre/get

this is a get1 response!

localhost:8000/get

this is a get2 response!

router.use

使用router.use方法，同樣的能夠為路由分層，並且不會因為忽略了prefix的全域性配置造成一些不必要的失誤，
推薦使用這一種方法為路由分層。

const Koa = require('koa')
const app = new Koa()
const router = require('koa-router')
// 定義子路由
const router_children = new router()
router_children.get('/get', function (ctx, next) {
  ctx.body = 'this is a get response from router.use!'
})
// 根路由
const router_root = new router()
// 在根路由中註冊子路由
router_root.use('/root', router_children.routes(), router_children.allowedMethods())
// 在app中註冊根路由
app.use(router_root.routes(), router_root.allowedMethods())
app.listen(8000)

module.exports = app
 

瀏覽器訪問localhost:8000/root/get:

this is a get response from router.use!

動態路由引數

類似於vue-router，可以將引數直接以 /path/parma 的形式傳遞引數。
路由的param引數通過ctx.params獲取。

const Koa = require('koa')
const app = new Koa()
const koa_router = require('koa-router')
const router = new koa_router()
router.get('/:category/:page/:id', function (ctx, next) {
  ctx.body = ctx.params
})
app.use(router.routes(), router.allowedMethods())
app.listen(8000)

module.exports = app

瀏覽器訪問localhost:8000/story/99/195c6f5b-2f71-4412-9634-bfd05f80c7c4：

{
    "category": "story",
    "page": "99",
    "id": "195c6f5b-2f71-4412-9634-bfd05f80c7c4"
}

分割路由檔案

當我們的專案越做越大時，可能最終會有成百上千個路由，如果這些路由全部寫在一個檔案下面，對後期的維護將是一個極大的考驗。
因此為了讓我們的程式碼具備高可維護性，可拓展性，我們最好對路由進行切割並分層，我們藉助node.js的fs模組對檔案操作能夠很輕易的實現路由切割。
如果你對fs模組還不太瞭解，請先自行學習此模組。

app.js:

const Koa = require('koa')
const app = new Koa()
const routes = require('./routes')
app.use(routes.routes(), routes.allowedMethods())
app.listen(8000)

module.exports = app

此段用來引入並註冊routes資料夾下的index.js檔案。

routes/index.js:

const router = require('koa-router')()
const fs = require('fs')
const path = require('path')

const files = fs.readdirSync(__dirname)
files
    .filter(file => ~file.search(/^[^\.].*\.js$/))
    .forEach(file => {
        const file_name = file.substr(0, file.length - 3);
        const file_entity = require(path.join(__dirname, file));
        if (file_name !== 'index') {
            router.use(`/${file_name}`, file_entity.routes(), file_entity.allowedMethods())
        }
    })

module.exports = router

這一段程式碼特別關鍵，用來引入並註冊所有同級目錄下的js檔案（此目錄下的js檔案都是路由檔案），併為他們配上以檔名命名的層級字首。

routes/demo.js:

const router = require('koa-router')()

router.get('/', function (ctx, next) {
  ctx.body = 'demo'
})

router.get('/child', function (ctx, next) {
  ctx.body = 'demo child'
})

module.exports = router

這個就是業務的示例檔案，沒什麼特別的。需要新增路由只需要新增此類檔案即可。

通過瀏覽器進行訪問測試
localhost:8000/demo/child：

demo child

localhost:8000/demo：

demo

好了，路由已經被成功分割。