Koa 教程

Node 主要用在開發(fā) Web 應(yīng)用。這決定了使用 Node茸炒,往往離不開 Web 應(yīng)用框架愕乎。
Koa 就是一種簡單好用的 Web 框架。它的特點(diǎn)是優(yōu)雅壁公、簡潔感论、表達(dá)力強(qiáng)、自由度高紊册。本身代碼只有1000多行比肄,所有功能都通過插件實(shí)現(xiàn),很符合 Unix 哲學(xué)囊陡。

Koa 是一個(gè)新的 web 框架芳绩,由 Express 幕后的原班人馬打造, 致力于成為 web 應(yīng)用和 API 開發(fā)領(lǐng)域中的一個(gè)更小关斜、更富有表現(xiàn)力示括、更健壯的基石。 通過利用 async 函數(shù)痢畜,Koa 幫你丟棄回調(diào)函數(shù)垛膝,并有力地增強(qiáng)錯(cuò)誤處理鳍侣。 Koa 并沒有捆綁任何中間件, 而是提供了一套優(yōu)雅的方法吼拥,幫助您快速而愉快地編寫服務(wù)端應(yīng)用程序倚聚。

本文從零開始,循序漸進(jìn)凿可,教會(huì)你如何使用 Koa 寫出自己的 Web 應(yīng)用惑折。每一步都有簡潔易懂的示例,希望讓大家一看就懂

零枯跑,準(zhǔn)備

首先惨驶,檢查 Node 版本。

$ node -v
v10.15.0

Koa 必須使用 7.6 以上的版本敛助。如果你的版本低于這個(gè)要求粗卜,就要先升級 Node。

然后纳击,克隆本文的配套示例庫续扔。(如果不方便使用 Git,也可以下載 zip 文件解壓焕数。)

$ git clone https://github.com/ruanyf/koa-demos.git

接著纱昧,進(jìn)入示例庫,安裝依賴堡赔。

$ cd koa-demos
$ npm install

所有示例源碼识脆,都在 demos 目錄下面。

一善已、基本用法

1.1 架設(shè) HTTP 服務(wù)

只要三行代碼存璃,就可以用 Koa 架設(shè)一個(gè) HTTP 服務(wù)。

// demos/01.js
const Koa = require('koa');
const app = new Koa();

app.listen(3000);

運(yùn)行這個(gè)腳本雕拼。

$ node demos/01.js

打開瀏覽器纵东,訪問 http://127.0.0.1:3000 。你會(huì)看到頁面顯示"Not Found"啥寇,表示沒有發(fā)現(xiàn)任何內(nèi)容偎球。這是因?yàn)槲覀儾]有告訴 Koa 應(yīng)該顯示什么內(nèi)容。

1.2 Context 對象

Koa 提供一個(gè) Context 對象辑甜,表示一次對話的上下文(包括 HTTP 請求和 HTTP 回復(fù))衰絮。通過加工這個(gè)對象,就可以控制返回給用戶的內(nèi)容磷醋。

Context.response.body屬性就是發(fā)送給用戶的內(nèi)容猫牡。請看下面的例子(完整的代碼看這里)。

// demos/02.js
const Koa = require('koa');
const app = new Koa();

const main = ctx => {
  ctx.response.body = 'Hello World';
};

app.use(main);
app.listen(3000);

上面代碼中邓线,main函數(shù)用來設(shè)置ctx.response.body淌友。然后煌恢,使用app.use方法加載main函數(shù)。

你可能已經(jīng)猜到了震庭,ctx.response代表 HTTP Response瑰抵。同樣地,ctx.request代表 HTTP Request器联。

運(yùn)行這個(gè) demo二汛。

$ node demos/02.js

訪問 http://127.0.0.1:3000 ,現(xiàn)在就可以看到"Hello World"了拨拓。

二肴颊、路由

2.1 原生路由

網(wǎng)站一般都有多個(gè)頁面。通過ctx.request.path可以獲取用戶請求的路徑渣磷,由此實(shí)現(xiàn)簡單的路由苫昌。請看下面的例子(完整代碼看這里

// demos/05.js
const main = ctx => {
  if (ctx.request.path !== '/') {
    ctx.response.type = 'html';
    ctx.response.body = '<a href="/">Index Page</a>';
  } else {
    ctx.response.body = 'Hello World';
  }
};

運(yùn)行這個(gè) demo。

$ node demos/05.js

訪問 http://127.0.0.1:3000/about 幸海,可以看到一個(gè)鏈接,點(diǎn)擊后就跳到首頁奥务。

2.2 koa-route 模塊

原生路由用起來不太方便物独,我們可以使用封裝好的koa-route模塊。請看下面的例子(完整代碼看這里)氯葬。

// demos/06.js
const route = require('koa-route');

const about = ctx => {
  ctx.response.type = 'html';
  ctx.response.body = '<a href="/">Index Page</a>';
};

const main = ctx => {
  ctx.response.body = 'Hello World';
};

app.use(route.get('/', main));
app.use(route.get('/about', about));

上面代碼中挡篓,根路徑/的處理函數(shù)是main,/about路徑的處理函數(shù)是about帚称。

運(yùn)行這個(gè) demo官研。

$ node demos/06.js

三、中間件

3.1 Logger 功能

Koa 的最大特色闯睹,也是最重要的一個(gè)設(shè)計(jì)戏羽,就是中間件(middleware)。為了理解中間件楼吃,我們先看一下 Logger (打印日志)功能的實(shí)現(xiàn)始花。

最簡單的寫法就是在main函數(shù)里面增加一行(完整代碼看這里)。

// demos/07.js
const main = ctx => {
 console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
 ctx.response.body = 'Hello World';
};

運(yùn)行這個(gè) Demo孩锡。

$ node demos/07.js

訪問 http://127.0.0.1:3000 酷宵,命令行就會(huì)輸出日志。

1502144902843 GET /

3.2 中間件的概念

上一個(gè)例子里面的 Logger 功能躬窜,可以拆分成一個(gè)獨(dú)立函數(shù)(完整代碼看這里)浇垦。

// demos/08.js
const logger = (ctx, next) => {
  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
  next();
}
app.use(logger);

像上面代碼中的logger函數(shù)就叫做"中間件"(middleware),因?yàn)樗幵?HTTP Request 和 HTTP Response 中間荣挨,用來實(shí)現(xiàn)某種中間功能男韧。app.use()用來加載中間件朴摊。

基本上,Koa 所有的功能都是通過中間件實(shí)現(xiàn)的煌抒,前面例子里面的main也是中間件仍劈。每個(gè)中間件默認(rèn)接受兩個(gè)參數(shù),第一個(gè)參數(shù)是 Context 對象寡壮,第二個(gè)參數(shù)是next函數(shù)贩疙。只要調(diào)用next函數(shù),就可以把執(zhí)行權(quán)轉(zhuǎn)交給下一個(gè)中間件况既。

運(yùn)行這個(gè) demo这溅。

$ node demos/08.js

訪問 http://127.0.0.1:3000 ,命令行窗口會(huì)顯示與上一個(gè)例子相同的日志輸出棒仍。

3.3 中間件棧

多個(gè)中間件會(huì)形成一個(gè)棧結(jié)構(gòu)(middle stack)悲靴,以"先進(jìn)后出"(first-in-last-out)的順序執(zhí)行。

  1. 最外層的中間件首先執(zhí)行莫其。
  2. 調(diào)用next函數(shù)癞尚,把執(zhí)行權(quán)交給下一個(gè)中間件。
  3. ...
  4. 最內(nèi)層的中間件最后執(zhí)行乱陡。
  5. 執(zhí)行結(jié)束后浇揩,把執(zhí)行權(quán)交回上一層的中間件。
  6. ...
  7. 最外層的中間件收回執(zhí)行權(quán)之后憨颠,執(zhí)行next函數(shù)后面的代碼胳徽。

請看下面的例子(完整代碼看這里)。

// demos/09.js
const one = (ctx, next) => {
  console.log('>> one');
  next();
  console.log('<< one');
}

const two = (ctx, next) => {
  console.log('>> two');
  next(); 
  console.log('<< two');
}

const three = (ctx, next) => {
  console.log('>> three');
  next();
  console.log('<< three');
}

app.use(one);
app.use(two);
app.use(three);

運(yùn)行這個(gè) demo爽彤。

$ node demos/09.js

訪問 http://127.0.0.1:3000 养盗,命令行窗口會(huì)有如下輸出。

>> one
>> two
>> three
<< three
<< two
<< one

如果中間件內(nèi)部沒有調(diào)用next函數(shù)适篙,那么執(zhí)行權(quán)就不會(huì)傳遞下去往核。作為練習(xí),你可以將two函數(shù)里面next()這一行注釋掉再執(zhí)行嚷节,看看會(huì)有什么結(jié)果铆铆。

3.4 異步中間件

迄今為止,所有例子的中間件都是同步的丹喻,不包含異步操作薄货。如果有異步操作(比如讀取數(shù)據(jù)庫),中間件就必須寫成 async 函數(shù)碍论。請看下面的例子(完整代碼看這里)谅猾。

// demos/10.js
const fs = require('fs.promised');
const Koa = require('koa');
const app = new Koa();

const main = async function (ctx, next) {
  ctx.response.type = 'html';
  ctx.response.body = await fs.readFile('./demos/template.html', 'utf8');
};

app.use(main);
app.listen(3000);

上面代碼中,fs.readFile是一個(gè)異步操作,必須寫成await fs.readFile()税娜,然后中間件必須寫成 async 函數(shù)坐搔。

運(yùn)行這個(gè) demo。

$ node demos/10.js

訪問 http://127.0.0.1:3000 敬矩,就可以看到模板文件的內(nèi)容概行。

五、常用庫

koa-router 路由

koa-bodyparser 請求解析

koa2-cors 跨域處理

koa-static 靜態(tài)資源

六弧岳、示例項(xiàng)目

前端頁面:NodeTemplate-todoList
后端服務(wù):NodeTemplateKoa

參考

Koa 框架教程

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末凳忙,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子禽炬,更是在濱河造成了極大的恐慌涧卵,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,406評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件腹尖,死亡現(xiàn)場離奇詭異柳恐,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)热幔,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,395評論 3 398
  • 文/潘曉璐 我一進(jìn)店門乐设,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人绎巨,你說我怎么就攤上這事近尚。” “怎么了认烁?”我有些...
    開封第一講書人閱讀 167,815評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長介汹。 經(jīng)常有香客問我却嗡,道長,這世上最難降的妖魔是什么嘹承? 我笑而不...
    開封第一講書人閱讀 59,537評論 1 296
  • 正文 為了忘掉前任窗价,我火速辦了婚禮,結(jié)果婚禮上叹卷,老公的妹妹穿的比我還像新娘撼港。我一直安慰自己,他們只是感情好骤竹,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,536評論 6 397
  • 文/花漫 我一把揭開白布帝牡。 她就那樣靜靜地躺著,像睡著了一般蒙揣。 火紅的嫁衣襯著肌膚如雪靶溜。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,184評論 1 308
  • 那天,我揣著相機(jī)與錄音罩息,去河邊找鬼嗤详。 笑死,一個(gè)胖子當(dāng)著我的面吹牛瓷炮,可吹牛的內(nèi)容都是我干的葱色。 我是一名探鬼主播,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼娘香,長吁一口氣:“原來是場噩夢啊……” “哼苍狰!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起茅主,我...
    開封第一講書人閱讀 39,668評論 0 276
  • 序言:老撾萬榮一對情侶失蹤舞痰,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后诀姚,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體响牛,經(jīng)...
    沈念sama閱讀 46,212評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,299評論 3 340
  • 正文 我和宋清朗相戀三年赫段,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了呀打。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,438評論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡糯笙,死狀恐怖贬丛,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情给涕,我是刑警寧澤豺憔,帶...
    沈念sama閱讀 36,128評論 5 349
  • 正文 年R本政府宣布,位于F島的核電站够庙,受9級特大地震影響恭应,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜耘眨,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,807評論 3 333
  • 文/蒙蒙 一昼榛、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧剔难,春花似錦胆屿、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,279評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至纯趋,卻和暖如春彻秆,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,395評論 1 272
  • 我被黑心中介騙來泰國打工唇兑, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留酒朵,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,827評論 3 376
  • 正文 我出身青樓扎附,卻偏偏與公主長得像蔫耽,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子留夜,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,446評論 2 359

推薦閱讀更多精彩內(nèi)容