TypeScript 3 + Koajs + Node.js

轉(zhuǎn)發(fā)

TypeScript 3 + Koajs + Node.js

自NodeJS早期以來(lái),Express一直是NodeJS開(kāi)發(fā)人員事實(shí)上的標(biāo)準(zhǔn)Web框架赡鲜。
但是埂材,JavaScript在過(guò)去幾年中已經(jīng)走過(guò)了漫長(zhǎng)的道路痒玩,像promises和async函數(shù)這樣的功能使得構(gòu)建更小愤估,更強(qiáng)大的Web框架成為可能。

Koa就是這樣一個(gè)框架玄妈。
它由Express背后的團(tuán)隊(duì)構(gòu)建乾吻,以利用最新的JavaScript和NodeJS功能,特別是異步功能拟蜻。

與Express和其他node框架(如Hapi)不同绎签,Koa不需要使用回調(diào)。
這消除了難以跟蹤的錯(cuò)誤的巨大潛在來(lái)源酝锅,并使框架非常容易為新開(kāi)發(fā)人員選擇诡必。

在本文中,我將向您介紹如何使用Koa和TypeScript來(lái)開(kāi)發(fā)新的Web應(yīng)用程序項(xiàng)目

第一步搔扁、安裝和配置

Koa需要一個(gè)具有異步功能支持的Node版本爸舒,因此在開(kāi)始之前確保安裝了Node 8.x(或更高版本)。
Node 8將于2017年10月成為新的長(zhǎng)期支持版本稿蹲,因此它是啟動(dòng)新項(xiàng)目的絕佳選擇扭勉。

我們現(xiàn)在將創(chuàng)建一個(gè)安裝了以下內(nèi)容的新node項(xiàng)目:

1. Koa
2. Koa Router
3. TypeScript
4. TS-Node 和 Nodemon(用于在開(kāi)發(fā)期間自動(dòng)構(gòu)建和重啟)

為項(xiàng)目創(chuàng)建一個(gè)新文件夾,然后執(zhí)行以下命令:

npm init   # and follow the resulting prompts to set up the project
npm i koa koa-router
npm i --save-dev typescript ts-node nodemon
npm i --save-dev @types/koa @types/koa-router

現(xiàn)在苛聘,在項(xiàng)目的根目錄中涂炎,創(chuàng)建一個(gè)新的tsconfig.json文件并添加以下內(nèi)容:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es2017",
        "noImplicitAny": true,
        "outDir": "./dist",
        "sourceMap": true
    },
    "include": [
        "./src/***/*",
    ]
}

請(qǐng)注意,我們將TypeScript配置為轉(zhuǎn)換為ES2017 - 這可確保我們利用Node的本機(jī)async/await功能设哗。

第二步唱捣、創(chuàng)建服務(wù)器

由于Koa的核心是微框架,因此啟動(dòng)和運(yùn)行它非常簡(jiǎn)單网梢。在項(xiàng)目目錄中震缭,創(chuàng)建一個(gè)src文件夾,在其中創(chuàng)建一個(gè)新文件:server.ts战虏,其中包含以下內(nèi)容:

import * as Koa from 'koa';
import * as Router from "koa-router";

const app = new Koa();
const router = new Router();

router.get('/*', async (ctx) => {
  ctx.body = "Hi TS";
})

app.use(router.routes());

app.listen(8080);

console.log("Server running on port 8080");

第三步拣宰、使用Nodemon和TS-Node運(yùn)行服務(wù)器

在開(kāi)發(fā)過(guò)程中,每次進(jìn)行更改時(shí)都要記住重新啟動(dòng)服務(wù)器會(huì)很麻煩烦感,所以我想設(shè)置我的服務(wù)器端項(xiàng)目以自動(dòng)重新啟動(dòng)代碼更改徐裸。

為此,我們將向我們的項(xiàng)目添加watch-server npm腳本啸盏。
為此,請(qǐng)將以下內(nèi)容添加到package.json的"scripts"部分:

"watch-server": "nodemon --watch 'src/***/*' -e ts,tsx --exec 'ts-node' ./src/server.ts"

現(xiàn)在開(kāi)始新的TypeScript Koa項(xiàng)目骑祟,只需執(zhí)行以下操作即可

npm run watch-server

您應(yīng)該看到以下輸出:

> ts_node_koa_blog@1.0.0 watch-server /Users/durban/nodejs/ts_node_koa_blog
> nodemon --watch 'src/***/*' -e ts,tsx --exec 'ts-node' ./src/server.ts

[nodemon] 1.18.4
[nodemon] to restart at any time, enter `rs`
[nodemon] watching: src/***/*
[nodemon] starting `ts-node ./src/server.ts`
Server running on port 8080

現(xiàn)在您應(yīng)該能夠在瀏覽器中訪問(wèn)http//localhost:8080/ :)

第四步回懦、構(gòu)建應(yīng)用程序 - 添加中間件

主要的Koa庫(kù)只包含基本的HTTP功能气笙。
要構(gòu)建完整的Web應(yīng)用程序,我們需要添加適當(dāng)?shù)闹虚g件怯晕,例如Logging, Error Handling, CSRF Protection等潜圃。在Koa中,中間件本質(zhì)上是一堆函數(shù)舟茶,通過(guò)app.use()創(chuàng)建谭期。
收到Web請(qǐng)求后,它將傳遞給堆棧中的第一個(gè)函數(shù)吧凉。
該函數(shù)可以處理請(qǐng)求隧出,然后可選地將其傳遞給下一個(gè)中間件函數(shù)。
讓我們將上面的示例擴(kuò)展為包含一個(gè)中間件函數(shù)阀捅,該函數(shù)將每個(gè)Web請(qǐng)求的URL記錄到控制臺(tái):

import * as Koa from 'koa';
import * as Router from "koa-router";

const app = new Koa();

app.use(async (ctx, next) => {
  // Log the request to the console
  console.log("Url: ", ctx.url);

  // Pass the request to the next middleware function
  await next();
})

const router = new Router();

router.get('/*', async (ctx) => {
  ctx.body = "Hi TS";
})

app.use(router.routes());

app.listen(8080);

console.log("Server running on port 8080");

在上面的示例中胀瞪,我們現(xiàn)在定義兩個(gè)中間件函數(shù):

1. 第一個(gè)中間件函數(shù)從請(qǐng)求上下文(ctx.url)獲取Url,并使用console.log()將其輸出到控制臺(tái)
2. 然后該函數(shù)await next()饲鄙,告訴Koa將請(qǐng)求傳遞給堆棧中的下一個(gè)中間件函數(shù)
3. 第二個(gè)中間件函數(shù)來(lái)自koa-router - 它使用請(qǐng)求的url來(lái)匹配我們通過(guò)router.get()配置的路由現(xiàn)在凄诞,當(dāng)您在瀏覽器中訪問(wèn)http://localhost:8080/時(shí),您應(yīng)該看到類似于以下內(nèi)容的輸出:

> ts_node_koa_blog@1.0.0 watch-server /Users/durban/nodejs/ts_node_koa_blog
> nodemon --watch 'src/***/*' -e ts,tsx --exec 'ts-node' ./src/server.ts

[nodemon] 1.18.4
[nodemon] to restart at any time, enter `rs`
[nodemon] watching: src/***/*
[nodemon] starting `ts-node ./src/server.ts`
Server running on port 8080
Url:  /
Url:  /
Url:  /blog
Url:  /blog

第五步忍级、標(biāo)準(zhǔn)中間件

顯然帆谍,你真的不想為你的網(wǎng)絡(luò)應(yīng)用重新發(fā)明輪子。
根據(jù)您要?jiǎng)?chuàng)建的應(yīng)用程序類型轴咱,以下中間件可能很有用:

Koa路由器
https://github.com/alexmingoia/koa-router

Koa Body Parser(用于JSON和Form Data支持)
https://github.com/dlau/koa-body

Koa Cross-Site-Request-Forgery(CSRF)預(yù)防
https://github.com/koajs/csrf

Koa Examples(許多有用的東西汛蝙,包括錯(cuò)誤處理)
https://github.com/koajs/examples

我已經(jīng)創(chuàng)建了一個(gè)基本的TypeScript和Koa項(xiàng)目∴戮粒可以進(jìn)行后面自己感興趣的開(kāi)發(fā)了患雇。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市宇挫,隨后出現(xiàn)的幾起案子苛吱,更是在濱河造成了極大的恐慌,老刑警劉巖器瘪,帶你破解...
    沈念sama閱讀 218,525評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件翠储,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡橡疼,警方通過(guò)查閱死者的電腦和手機(jī)援所,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,203評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)欣除,“玉大人住拭,你說(shuō)我怎么就攤上這事。” “怎么了滔岳?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,862評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵杠娱,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我谱煤,道長(zhǎng)摊求,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,728評(píng)論 1 294
  • 正文 為了忘掉前任刘离,我火速辦了婚禮室叉,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘硫惕。我一直安慰自己茧痕,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,743評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布疲憋。 她就那樣靜靜地躺著凿渊,像睡著了一般。 火紅的嫁衣襯著肌膚如雪缚柳。 梳的紋絲不亂的頭發(fā)上埃脏,一...
    開(kāi)封第一講書(shū)人閱讀 51,590評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音秋忙,去河邊找鬼彩掐。 笑死,一個(gè)胖子當(dāng)著我的面吹牛灰追,可吹牛的內(nèi)容都是我干的堵幽。 我是一名探鬼主播,決...
    沈念sama閱讀 40,330評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼弹澎,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼朴下!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起苦蒿,我...
    開(kāi)封第一講書(shū)人閱讀 39,244評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤殴胧,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后佩迟,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體团滥,經(jīng)...
    沈念sama閱讀 45,693評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,885評(píng)論 3 336
  • 正文 我和宋清朗相戀三年报强,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了灸姊。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,001評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡秉溉,死狀恐怖力惯,靈堂內(nèi)的尸體忽然破棺而出碗誉,到底是詐尸還是另有隱情,我是刑警寧澤夯膀,帶...
    沈念sama閱讀 35,723評(píng)論 5 346
  • 正文 年R本政府宣布诗充,位于F島的核電站,受9級(jí)特大地震影響诱建,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜碟绑,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,343評(píng)論 3 330
  • 文/蒙蒙 一俺猿、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧格仲,春花似錦押袍、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,919評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至侮东,卻和暖如春圈盔,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背悄雅。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,042評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工驱敲, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人宽闲。 一個(gè)月前我還...
    沈念sama閱讀 48,191評(píng)論 3 370
  • 正文 我出身青樓众眨,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親容诬。 傳聞我的和親對(duì)象是個(gè)殘疾皇子娩梨,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,955評(píng)論 2 355

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

  • 轉(zhuǎn)載 TypeScript 3 + Express + Node.js 第一步、安裝需要的配置 首先览徒,我們將使用n...
    鵬鯤云之上閱讀 6,253評(píng)論 5 1
  • 1.簡(jiǎn)書(shū) koa是由Express原班人馬打造狈定,致力于成為一個(gè)更小、更富有表現(xiàn)力吱殉、更健壯的Web框架掸冤。使用koa編...
    不去解釋閱讀 2,666評(píng)論 0 11
  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)友雳,斷路器稿湿,智...
    卡卡羅2017閱讀 134,657評(píng)論 18 139
  • "一旦一個(gè)人在乎一件事,就發(fā)現(xiàn)不得不開(kāi)始在乎一切事" "沒(méi)有誰(shuí)是一座孤島押赊,每本書(shū)都是一個(gè)世界" "我們讀書(shū)然后知道...
    白姑娘的精靈奶奶閱讀 463評(píng)論 0 0
  • 火車(chē)站的人潮在我身邊匆匆而過(guò)饺藤,光陰在此化作一趟又一趟的列車(chē)包斑,駛進(jìn)站臺(tái),又匆忙離開(kāi)涕俗,在嘈雜的輪回之中罗丰,亦如此安寧。我...
    為了552的沭沭閱讀 265評(píng)論 0 0