iKcamp團隊制作|基于Koa2搭建Node.js實戰(zhàn)(含視頻)? 路由koa-router

路由koa-router——MVC 中重要的環(huán)節(jié):Url 處理器

???? iKcamp 制作團隊

原創(chuàng)作者:大哼鸦难、阿干三三员淫、小虎合蔽、胖子小哈介返、DDU拴事、可木晃晃
文案校對:李益圣蝎、大力萌刃宵、AuDDU捅彻、小溪里组去、小哈
風(fēng)采主播:可木阿干步淹、Au从隆、DDU小哈
視頻剪輯:小溪里
主站運營:給力xi缭裆、xty
教程主編:張利濤


視頻地址:https://www.cctalk.com/v/15114923889954

WX20171225-103614@2x.png

文章

路由 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ù),asyncawait 這兩個關(guān)鍵字將在 ES7 中引入套啤。參數(shù) ctx 是由 koa 傳入的宽气,我們可以通過它來訪問 requestresponsenextkoa 傳入的將要處理的下一個異步函數(shù)纲岭。

注意: 由于 nodev7.6.0 中才支持 asyncawait抹竹,所以在運行 app.js 之前請確保 node 版本正確,或者使用一些第三方的 async 庫來支持止潮。


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


安裝 koa-router

通過 npm 命令直接安裝:

npm i koa-router -S

-S 或者 --save 是為了安裝完成之后能夠在 package.jsondependencies 中保留 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/

2222.png

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

2222.png

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

3333.png

通過上面的例子逗旁,我們可以看到和之前不使用 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 協(xié)議方法中,GET唠叛、POST只嚣、PUTDELETE 分別對應(yīng) 艺沼,册舞,澳厢,這里 router 的方法也一一對應(yīng)环础。通常我們使用 GET 來查詢和獲取數(shù)據(jù),使用 POST 來更新資源剩拢。PUTDELETE 使用比較少线得,但是如果你們團隊采用 RESTful架構(gòu),就比較推薦使用了徐伐。我們注意到贯钩,上述代碼中還有一個all 方法。all 方法用于處理上述方法無法匹配的情況办素,或者你不確定客戶端發(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ū)別就是 ajaxmethod 的值,method 的值和 router 的方法一一對應(yīng)呆万。上述代碼中沒有處理異常商源,當(dāng)請求都無法匹配的時候,我們可以跳轉(zhuǎn)到自定義的 404 頁面谋减,比如:

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

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

其他特性

命名路由

在開發(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)瀏覽器的各種請求问拘。

下一篇:POST/GET請求——常見請求方式處理

移動Web前端高效開發(fā)實戰(zhàn).png
gh_a55f9a070958_860.jpg

上一篇:iKcamp新課程推出啦~~~~~iKcamp團隊制作|基于Koa2搭建Node.js實戰(zhàn)(含視頻)? 中間件用法

推薦: 翻譯項目Master的自述:

1. 干貨|人人都是翻譯項目的Master

2. iKcamp出品微信小程序教學(xué)共5章16小節(jié)匯總(含視頻)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市惧所,隨后出現(xiàn)的幾起案子骤坐,更是在濱河造成了極大的恐慌,老刑警劉巖下愈,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件纽绍,死亡現(xiàn)場離奇詭異,居然都是意外死亡势似,警方通過查閱死者的電腦和手機拌夏,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來履因,“玉大人障簿,你說我怎么就攤上這事≌て” “怎么了站故?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵,是天一觀的道長毅舆。 經(jīng)常有香客問我西篓,道長愈腾,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任岂津,我火速辦了婚禮顶滩,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘寸爆。我一直安慰自己,他們只是感情好盐欺,可當(dāng)我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布赁豆。 她就那樣靜靜地躺著,像睡著了一般冗美。 火紅的嫁衣襯著肌膚如雪魔种。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天粉洼,我揣著相機與錄音节预,去河邊找鬼。 笑死属韧,一個胖子當(dāng)著我的面吹牛安拟,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播宵喂,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼糠赦,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了锅棕?” 一聲冷哼從身側(cè)響起拙泽,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎裸燎,沒想到半個月后顾瞻,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡德绿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年荷荤,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片脆炎。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡梅猿,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出秒裕,到底是詐尸還是另有隱情袱蚓,我是刑警寧澤,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布几蜻,位于F島的核電站喇潘,受9級特大地震影響体斩,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜颖低,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一絮吵、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧忱屑,春花似錦蹬敲、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至从铲,卻和暖如春瘪校,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背名段。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工阱扬, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人伸辟。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓麻惶,卻偏偏與公主長得像,于是被迫代替她去往敵國和親信夫。 傳聞我的和親對象是個殘疾皇子用踩,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,691評論 2 361