路由 koa-router

上一節(jié)我們學(xué)習(xí)了中間件的基本概念，本節(jié)主要帶大家學(xué)習(xí)下 koa-router 路由中間件的使用方法。

路由是用于描述 URL 與處理函數(shù)之間的對應(yīng)關(guān)系的。比如用戶訪問 http://localhost:3000/，那么瀏覽器就會顯示 index頁面的內(nèi)容，如果用戶訪問的是 http://localhost:3000/home，那么瀏覽器應(yīng)該顯示 home 頁面的內(nèi)容。

要實現(xiàn)上述功能，如果不借助 koa-router 或者其他路由中間件，我們自己去處理路由，那么寫法可能如下所示：

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx, next) => {
   if (ctx.request.path === '/') {
       ctx.response.body = '<h1>index page</h1>';
   } else {
       await next();
   }
});
app.use(async (ctx, next) => {
   if (ctx.request.path === '/home') {
       ctx.response.body = '<h1>home page</h1>';
   } else {
       await next();
   }
});
app.use(async (ctx, next) => {
   if (ctx.request.path === '/404') {
       ctx.response.body = '<h1>404 Not Found</h1>';
   } else {
       await next();
   }
});

app.listen(3000, ()=>{
 console.log('server is running at http://localhost:3000')
})

把上述代碼復(fù)制并覆蓋到 app.js 中，然后執(zhí)行以下命令啟動 node 程序:

node app.js

啟動之后在瀏覽器中分別訪問 http://localhost:3000/、http://localhost:3000/home、http://localhost:3000/404 就能看到相應(yīng)的頁面了。

上述 app.js 的代碼中，由 async 標(biāo)記的函數(shù)稱為『異步函數(shù)』，在異步函數(shù)中，可以用 await 調(diào)用另一個異步函數(shù)，async 和 await 這兩個關(guān)鍵字將在 ES7 中引入。參數(shù) ctx 是由 koa 傳入的，我們可以通過它來訪問 request 和 response，next 是 koa 傳入的將要處理的下一個異步函數(shù)。

注意： 由于 node 在 v7.6.0 中才支持 async 和 await，所以在運行 app.js 之前請確保 node 版本正確，或者使用一些第三方的 async 庫來支持。

這樣的寫法能夠處理簡單的應(yīng)用，但是，一旦要處理的 URL 多起來的話就會顯得特別笨重。所以我們可以借助 koa-router 來更簡單的實現(xiàn)這一功能。 下面來介紹一下如何正確的使用 koa-router。

安裝 koa-router

通過 npm 命令直接安裝：

npm i koa-router -S

-S 或者 --save 是為了安裝完成之后能夠在 package.json 的 dependencies 中保留 koa-router，以便于下次只需要執(zhí)行 npm i 或者 npm install 就能夠安裝所有需要的依賴包。

基本使用方法

如果要在 app.js 中使用 koa-router 來處理 URL，可以通過以下代碼來實現(xiàn)：

const Koa = require('koa')
// 注意 require('koa-router') 返回的是函數(shù):
const router = require('koa-router')()
const app = new Koa()

 // 添加路由
 router.get('/', async (ctx, next) => {
    ctx.response.body = `<h1>index page</h1>`
})

router.get('/home', async (ctx, next) => {
    ctx.response.body = '<h1>HOME page</h1>'
})

router.get('/404', async (ctx, next) => {
    ctx.response.body = '<h1>404 Not Found</h1>'
})

 // 調(diào)用路由中間件
 app.use(router.routes())

app.listen(3000, ()=>{
  console.log('server is running at http://localhost:3000')
})

運行 app.js:

node app.js

執(zhí)行完上面的操作之后，我們在瀏覽器中訪問 http://localhost:3000/：

[圖片上傳中...(image-df51e-1589252096343-2)]

在瀏覽器中訪問 http://localhost:3000/home：

[圖片上傳失敗...(image-3565e1-1589252096343)]

在瀏覽器中訪問 http://localhost:3000/404：

[圖片上傳失敗...(image-79f744-1589252096343)]

通過上面的例子，我們可以看到和之前不使用 koa-router 的顯示效果是一樣的。不過使用了 koa-router 之后，代碼稍微簡化了一些，而且少了 if 判斷，還有省略了 await next()（因為沒有其他中間件需要執(zhí)行，所以這里就先省略了）。

當(dāng)然，除了 GET 方法，koa-router 也支持處理其他的請求方法，比如：

router
  .get('/', async (ctx, next) => {
    ctx.body = 'Hello World!';
  })
  .post('/users', async (ctx, next) => {
    // ... 
  })
  .put('/users/:id', async (ctx, next) => {
    // ... 
  })
  .del('/users/:id', async (ctx, next) => {
    // ... 
  })
  .all('/users/:id', async (ctx, next) => {
    // ... 
  });

在任意http請求中，遵從 RESTful 規(guī)范，可以把 GET、POST、PUT、DELETE 類型的請求分別對應(yīng) 查，增，改，刪，這里 router 的方法也一一對應(yīng)。通常我們使用 GET 來查詢和獲取數(shù)據(jù)，使用 POST 來更新資源。PUT 和 DELETE 使用比較少，但是如果你們團隊采用 RESTful架構(gòu)，就比較推薦使用了。我們注意到，上述代碼中還有一個all 方法。all 方法通常用于匹配一組路由或者全部路由從而做一些統(tǒng)一設(shè)置和處理，也可以處理不確定客戶端發(fā)送的請求方法類型的情況。

舉個例子，假設(shè)客戶端使用 jQuery 來開發(fā)，有如下幾個 ajax 請求：

// 優(yōu)先匹配和 router.get 方法中 url 規(guī)則一樣的請求，如果匹配不到的話就匹配和 router.all 方法中 url 規(guī)則一樣的請求。
$.ajax({
  method: "GET",
  url: "some.php",
  data: { name: "John" }
}).done(function( msg ) {
  // do something 
});

// 優(yōu)先匹配和 router.post 方法中 url 規(guī)則一樣的請求，如果匹配不到的話就匹配和 router.all 方法中 url 規(guī)則一樣的請求。
$.ajax({
  method: "POST",
  url: "some.php",
  data: { name: "John" }
}).done(function( msg ) {
  // do something 
});

上面例子中兩個方法最主要的區(qū)別就是 ajax 中 method 的值，method 的值和 router 的方法一一對應(yīng)。
再舉一個使用all方法的例子，假設(shè)我們要為所有請求設(shè)置跨域頭，可以通過如下代碼實現(xiàn)：

router.all('/*', async (ctx, next) => {
 // *代表允許來自所有域名請求
 ctx.set("Access-Control-Allow-Origin", "*");
 // 其他一些設(shè)置...
 await next();
});

這段代碼表示對于所有請求，允許來自所有域名。這是一種很危險的做法，在真實項目中一定不能這么做。

* 號是一種通配符，表示匹配任意 URL。這里的返回是一種簡化的寫法，真實開發(fā)中，我們肯定要去讀取 HTML 文件或者其他模板文件的內(nèi)容，再響應(yīng)請求。關(guān)于這部分的內(nèi)容后面的章節(jié)中會詳細介紹。

另外，如果一條路由在all方法和其他方法中同時命中，只有執(zhí)行了await next()，那么這條路由會在all方法和其他方法中都會起作用，舉個例子，看如下代碼：

const Koa = require('koa')
const router = require('koa-router')()
const app = new Koa()

// 添加路由
router.get('/', async (ctx, next) => {
  ctx.response.body = `<h1>index page</h1>`
  await next();
})
router.all('/', async (ctx, next) => {
  console.log('match "all" method')
  await next();
});
// 調(diào)用路由中間件
app.use(router.routes())

app.listen(3000, ()=>{
  console.log('server is running at http://localhost:3000')
})

執(zhí)行這段代碼，我們不僅能夠訪問http://localhost:3000/看到“index page”，也能夠在控制臺中看到“'match "all" method'”，說明路由"/"不僅執(zhí)行了get方法的回調(diào)，也執(zhí)行了all方法的回調(diào)函數(shù)。但是，如果我們把get方法中的await next()去掉，那么就不會命中all方法的路由規(guī)則，也不會執(zhí)行all方法的回調(diào)函數(shù)了。因為說到底，對路由的處理也是一種中間件，如果不執(zhí)行await next()把控制權(quán)交給下一個中間件，那么后面的路由就不會再執(zhí)行了。

其他特性

命名路由

在開發(fā)過程中我們能夠很方便的生成路由 URL：

router.get('user', '/users/:id', function (ctx, next) {
  // ... 
});

router.url('user', 3);
// => 生成路由 "/users/3" 

router.url('user', { id: 3 });
// => 生成路由 "/users/3" 

router.use(function (ctx, next) {
  // 重定向到路由名稱為 “sign-in” 的頁面 
  ctx.redirect(ctx.router.url('sign-in'));
})

router.url 方法方便我們在代碼中根據(jù)路由名稱和參數(shù)(可選)去生成具體的 URL，而不用采用字符串拼接的方式去生成 URL了。

多中間件

koa-router 也支持單個路由多中間件的處理。通過這個特性，我們能夠為一個路由添加特殊的中間件處理。也可以把一個路由要做的事情拆分成多個步驟去實現(xiàn)，當(dāng)路由處理函數(shù)中有異步操作時，這種寫法的可讀性和可維護性更高。比如下面的示例代碼所示：

router.get(
  '/users/:id',
  function (ctx, next) {
    return User.findOne(ctx.params.id).then(function(user) {
      // 首先讀取用戶的信息，異步操作
      ctx.user = user;
      next();
    });
  },
  function (ctx) {
    console.log(ctx.user);
    // 在這個中間件中再對用戶信息做一些處理
    // => { id: 17, name: "Alex" }
  }
);

嵌套路由

我們可以在應(yīng)用中定義多個路由，然后把這些路由組合起來用，這樣便于我們管理多個路由，也簡化了路由的寫法。

var forums = new Router();
var posts = new Router();

posts.get('/', function (ctx, next) {...});
posts.get('/:pid', function (ctx, next) {...});
forums.use('/forums/:fid/posts', posts.routes(), posts.allowedMethods());

// 可以匹配到的路由為 "/forums/123/posts" 或者 "/forums/123/posts/123"
app.use(forums.routes());

路由前綴

通過 prefix 這個參數(shù)，我們可以為一組路由添加統(tǒng)一的前綴，和嵌套路由類似，也方便我們管理路由和簡化路由的寫法。不同的是，前綴是一個固定的字符串，不能添加動態(tài)參數(shù)。

var router = new Router({
  prefix: '/users'
});

router.get('/', ...); // 匹配路由 "/users" 
router.get('/:id', ...); // 匹配路由 "/users/:id" 

URL 參數(shù)

koa-router 也支持參數(shù)，參數(shù)會被添加到 ctx.params 中。參數(shù)可以是一個正則表達式，這個功能的實現(xiàn)是通過 path-to-regexp 來實現(xiàn)的。原理是把 URL 字符串轉(zhuǎn)化成正則對象，然后再進行正則匹配，之前的例子中的 * 通配符就是一種正則表達式。

router.get('/:category/:title', function (ctx, next) {
  console.log(ctx.params);
  // => { category: 'programming', title: 'how-to-node' } 
});

通過上面的例子可以看出，我們可以通過 ctx.params 去訪問路由中的參數(shù)，使得我們能夠?qū)?shù)做一些處理后再執(zhí)行后續(xù)的代碼。

使用了 koa-router 之后，代碼簡潔了很多。下一節(jié)中，我們將學(xué)習(xí)下如何響應(yīng)瀏覽器的各種請求。

原文https://github.com/ikcamp/koa2-tutorial/tree/2-koa-router