Koa 腳手架
koa-generator 是用于生成 Koa 項(xiàng)目骨架的生成器鹤树，雖然比較精簡(jiǎn)击费，但它的結(jié)構(gòu)十分清晰俏让，足以滿足一般的開(kāi)發(fā)需求。
與 express-generator 的功能對(duì)比
express-generator 提供的功能如下
- 生成項(xiàng)目骨架鳍徽，集成必要的中間件。
- 約定目錄結(jié)構(gòu)敢课。
- 支持 css 預(yù)處理器阶祭。
koa-generator 提供的功能如下
- 生成項(xiàng)目的骨架，集成必要的中間件直秆。
- 約定目錄結(jié)構(gòu)（和 express-generator 約定的結(jié)構(gòu)一模一樣）
兩個(gè)生成器共同支持的項(xiàng)目骨架描述如下
- app.js 為入口
- bin/www 為啟動(dòng)入口
- 支持靜態(tài)服務(wù)器濒募，即 publish 目錄
- 支持 routes 目錄
- 支持 views 視圖目錄
- 默認(rèn)將 Pug （之前的名字是 Jade）作為模板引擎。
1.2.1 安裝 Koa 生成器
npm install -g koa-generator
koa-generator 支持 v1 和 v2 圾结，安裝后分別使用 koa 和 koa2 命令創(chuàng)建 Koa 項(xiàng)目模板瑰剃，以 koa2 為例。
1.2.2 創(chuàng)建 Hello world
koa2 helloworld
1.2.3 目錄解析
使用 koa-generator 生成的目錄結(jié)構(gòu)如下：
.
├── app.js
├── bin
| └── www
├── directoryList.md
├── out.txt
├── package.json
├── public
| ├── images
| ├── javascripts
| └── stylesheets
├── routes
| ├── index.js
| └── users.js
└── views
├── error.pug
├── index.pug
└── layout.pug
下面會(huì)對(duì)以上文件作用和文件的內(nèi)容做簡(jiǎn)單的介紹
package.json
package.json 是 Node.js 模塊定義的核心配置文件筝野，接觸新項(xiàng)目的第一件事就是打開(kāi)該文件了解模塊的各個(gè)屬性晌姚。比如名稱，版本歇竟，依賴模塊挥唠，開(kāi)發(fā)方式等。
package.json 文件里包含了 4 個(gè) npm script 腳本焕议，分別介紹如下：
- npm start 是開(kāi)發(fā)階段使用的腳本宝磨，使用時(shí)代碼發(fā)生變動(dòng)，需要重啟 Node.js 進(jìn)程。
- npm run dev 也是開(kāi)發(fā)階段使用的腳本唤锉，使用時(shí)代碼會(huì)發(fā)生變動(dòng)世囊， nodemon 會(huì)自動(dòng)啟動(dòng) Node.js 進(jìn)程。
- npm run prd 是產(chǎn)品環(huán)境使用的腳本窿祥，通過(guò) pm2 來(lái)啟動(dòng)工程株憾，默認(rèn)按照 CPU 核數(shù)來(lái)啟動(dòng)對(duì)應(yīng)的進(jìn)程數(shù)，是目前最流行的方式壁肋。
- test 只會(huì)打印未實(shí)現(xiàn)日志号胚，和 Express 里的用法是一樣的。
入口文件 bin/www
入口文件的核心代碼如下：
const server = http.createServer(app.callback())
server.listen(port)
server.on('error', onError);
server.on('listening', onListening);
這里唯一和 Express 不同的是浸遗，Koa 里的 app.callback() 返回的是 function(req, res){}猫胁，所以想在 http.createServer 里啟動(dòng) Koa，就必須將 app 修改為 app.callback().
核心文件 app.js
app.js 是 Koa 的核心文件跛锌，主要包含 4 個(gè)部分弃秆，分別如下
- 中間件
- 路由
- 靜態(tài)服務(wù)
- 視圖
這里注意，中間件按照加載順序執(zhí)行髓帽，下面是 app.js 里包含的中間件的名稱菠赚，用途（按照加載順序排列）。
| 中間件名稱 | 用途 | 加載順序 |
|---|---|---|
| bodyparser | 解析 Post 類 HTTP 動(dòng)詞的 body 內(nèi)容郑藏，加上 bodyparser 后就可以處理所有請(qǐng)求了 | 1 |
| json | 更好的支持 JSON | 2 |
| logger | 開(kāi)發(fā)階段的日志 | 3 |
| koa-static | 提供 HTTP 靜態(tài)托管服務(wù) | 4 |
| koa-views | 視圖渲染衡查，支持模板引擎 | 5 |
| 自定義的 logger 中間件 | 記錄日志 | 6 |
路由位于 routes 目錄下
路由支持返回 視圖渲染，JSON API 和字符串
- 視圖渲染
router.get('/', async(ctx, next) => {
await ctx.render('index', {
title: 'Hello Koa 2!'
})
})
- JSON API
router.get('/json', async (ctx, next) => {
ctx.body = {a:1}
})
- 字符串
router.get('/string', async(ctx, next) => {
ctx.body = 'koa2 string'
})
賦予 ctx.body 不同類型的值時(shí)會(huì)返回不同的結(jié)果必盖；值得注意的是拌牲，ctx.render 是 koa-views 中間件綁定到 ctx上的，原本 ctx 上是沒(méi)有 render 函數(shù)的歌粥。
靜態(tài)服務(wù)位于 public 目錄下
靜態(tài)服務(wù)主要用于存放靜態(tài)資源塌忽，比如 HTML，CSS失驶，JS 文件等土居，但是值得注意的是，靜態(tài)服務(wù)是方便開(kāi)發(fā)存在的嬉探，實(shí)際項(xiàng)目處理時(shí)擦耀，一般將靜態(tài)文件存放在 CDN 服務(wù)器上。
public目錄是為了方便開(kāi)發(fā)而存在的甲馋，一般真正的項(xiàng)目有如下三類：
- 純 API 項(xiàng)目埂奈，不需要 public 目錄。
- 純前后端分離項(xiàng)目定躏，后端不需要 public 目錄账磺，前端需要
- 需要 public 目錄的項(xiàng)目芹敌，但會(huì)將 public 目錄的內(nèi)容發(fā)布到 cdn 上。
tip： 注意垮抗，不要把 static 中間件放到 Koa 的全局中間件上（如果對(duì)于每個(gè)請(qǐng)求都需要判斷一次是不是靜態(tài)資源氏捞，會(huì)影響 QPS），最好結(jié)合 koa-router 來(lái)處理冒版，按需掛在液茎，上代碼。
router.get('/public/', async (ctx, next) => {
ctx.url = path.basename(ctx.url)
await next()
}, staticServer(resolve('./public'), {gzip: true}))
視圖位于 views 目錄下
Koa 多采用 Pug 作為模板辞嗡，使用時(shí)可根據(jù)需要自行選擇捆等。
1.2.4 Koa v2 中間件的寫(xiě)法
Koa 支持三種中間件寫(xiě)法，功能是一樣的
- async 函數(shù)優(yōu)先級(jí)最高续室，最簡(jiǎn)單易懂栋烤。
- Promise 其次。await 結(jié)合 Promise 是非常常見(jiàn)的挺狰，而且利用 Promise的特性是剛需明郭，比如，通過(guò) Promise.race 和 Promise.all 等實(shí)現(xiàn)并發(fā)可以在某種程度上彌補(bǔ) async 函數(shù)的不足丰泊。
- Generator 主要在 Koa v1 中使用薯定，ES6 Generator 風(fēng)格的中間件非常常見(jiàn)。使用時(shí)可以通過(guò) co 庫(kù)來(lái)調(diào)用 ES6 Generator瞳购，由于 co 的返回值是 Promise话侄，所以相當(dāng)于重復(fù)了 await + Promise 的用法。
1.2.5 路由
koa-router 中間件提供了路由機(jī)制学赛，使用時(shí)進(jìn)一步學(xué)習(xí)满葛。
1.2.6 切換視圖模板引擎
使用以下命令可以在創(chuàng)建項(xiàng)目時(shí)切換模板
koa2 -e hellowrold -ejs
下面以切換 react 模板引擎為例，演示模板的切換過(guò)程
- 安裝對(duì)應(yīng)的模板引擎模塊：npm install --save react罢屈。
- 修改 app.js 里與 koa-views 相關(guān)的配置，將 extension 設(shè)置為 react篇亭，代碼如下：
app.use(views(__dirname + './views'), {
extension: 'react'
})
1.2.7 Koa 代碼調(diào)試
各個(gè)編輯器都提供了調(diào)試功能缠捌，根據(jù)編輯器自行調(diào)試即可。
