TypeScript 3 + Koajs + Node.js

轉(zhuǎn)發(fā)

TypeScript 3 + Koajs + Node.js

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

Koa就是這樣一個框架。
它由Express背后的團隊構(gòu)建,以利用最新的JavaScript和NodeJS功能,特別是異步功能。

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

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

第一步、安裝和配置

Koa需要一個具有異步功能支持的Node版本,因此在開始之前確保安裝了Node 8.x(或更高版本)。
Node 8將于2017年10月成為新的長期支持版本,因此它是啟動新項目的絕佳選擇。

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

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

為項目創(chuàng)建一個新文件夾,然后執(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)在,在項目的根目錄中,創(chuàng)建一個新的tsconfig.json文件并添加以下內(nèi)容:

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

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

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

由于Koa的核心是微框架,因此啟動和運行它非常簡單。在項目目錄中,創(chuàng)建一個src文件夾,在其中創(chuàng)建一個新文件: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運行服務(wù)器

在開發(fā)過程中,每次進(jìn)行更改時都要記住重新啟動服務(wù)器會很麻煩,所以我想設(shè)置我的服務(wù)器端項目以自動重新啟動代碼更改。

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

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

現(xiàn)在開始新的TypeScript Koa項目,只需執(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)該能夠在瀏覽器中訪問http//localhost:8080/ :)

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

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

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)在定義兩個中間件函數(shù):

1. 第一個中間件函數(shù)從請求上下文(ctx.url)獲取Url,并使用console.log()將其輸出到控制臺
2. 然后該函數(shù)await next(),告訴Koa將請求傳遞給堆棧中的下一個中間件函數(shù)
3. 第二個中間件函數(shù)來自koa-router - 它使用請求的url來匹配我們通過router.get()配置的路由現(xiàn)在,當(dāng)您在瀏覽器中訪問http://localhost:8080/時,您應(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ù)您要創(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(許多有用的東西,包括錯誤處理)
https://github.com/koajs/examples

我已經(jīng)創(chuàng)建了一個基本的TypeScript和Koa項目??梢赃M(jìn)行后面自己感興趣的開發(fā)了。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 轉(zhuǎn)載 TypeScript 3 + Express + Node.js 第一步、安裝需要的配置 首先,我們將使用n...
    鵬鯤云之上閱讀 6,342評論 5 1
  • 1.簡書 koa是由Express原班人馬打造,致力于成為一個更小、更富有表現(xiàn)力、更健壯的Web框架。使用koa編...
    不去解釋閱讀 2,813評論 0 11
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,697評論 19 139
  • "一旦一個人在乎一件事,就發(fā)現(xiàn)不得不開始在乎一切事" "沒有誰是一座孤島,每本書都是一個世界" "我們讀書然后知道...
    白姑娘的精靈奶奶閱讀 534評論 0 0
  • 火車站的人潮在我身邊匆匆而過,光陰在此化作一趟又一趟的列車,駛進(jìn)站臺,又匆忙離開,在嘈雜的輪回之中,亦如此安寧。我...
    為了552的沭沭閱讀 284評論 0 0

友情鏈接更多精彩內(nèi)容