使用Koa搭建 基礎(chǔ)項(xiàng)目

一、創(chuàng)建項(xiàng)目

手動(dòng)創(chuàng)建一個(gè)項(xiàng)目目錄，然后快速生成一個(gè) package.json 文件
npm init -y

安裝 koa
npm install koa -S

然后創(chuàng)建一個(gè) app.js，寫入
const Koa = require('koa');
const app = new Koa();

app.use(async ctx => {
ctx.body = 'Wise Wrong';
});
app.listen(3000);

如果覺得手動(dòng)創(chuàng)建項(xiàng)目太過繁瑣，可以使用腳手架 koa-generator 來生成項(xiàng)目
npm install koa-generator -g
koa2 project_name
然后在項(xiàng)目下 npm install 安裝依賴，npm start 啟動(dòng)項(xiàng)目

二、配置路由

上面 app.js 中有一個(gè) ctx，這是一個(gè) Koa 提供的 Context 對象，封裝了 request 和 response
在項(xiàng)目下創(chuàng)建一個(gè)存放 html 文件的目錄 views，并在該目錄下創(chuàng)建一個(gè) index.html，然后修改 app.js
我們需要引入路由中間件 koa-router
npm install koa-router -S
需要注意的是，在導(dǎo)入 koa-router 的時(shí)候，需要在末尾加一個(gè)括號：
const router = require('koa-router')();
相當(dāng)于：
const koaRouter = require('koa-router');
const router = koaRouter();

創(chuàng)建一個(gè) routes 目錄，用來存放路由文件，并在目錄下創(chuàng)建 index.js
// routes/index.js
const fs = require('fs');
const router = require('koa-router')()
router.get('/index', async (ctx, next) => {
ctx.type = 'text/html';
ctx.body = fs.createReadStream('./views/index.html');
});
module.exports = router
上面的 allowedMethods 用于校驗(yàn)請求的方法，如果用 post 請求訪問 get 接口，就會直接返回失敗
另外，還可以在 url 中添加變量，然后通過 Context.params.name 訪問
router.get('/about/:name', async (ctx, next) => {
ctx.body = I am ${ctx.params.name}!;
});

三、靜態(tài)資源

在上面的 index.html 中，如果需要引入 css 等靜態(tài)資源，就需要用到 koa-static
npm install koa-static -S
創(chuàng)建一個(gè)目錄 public 用來存放靜態(tài)資源
然后在 app.js 中添加以下代碼
const static = require('koa-static');
// 將 public 目錄設(shè)置為靜態(tài)資源目錄
const main = static(__dirname + '/public');
app.use(main);

事實(shí)上，這三行代碼還可以優(yōu)化
app.use(require('koa-static')(__dirname + '/public'));
然后就能在 index.html 中引入對應(yīng)的文件了

四、模板引擎

上面的路由是使用 fs 模塊直接讀取 html 文件
開發(fā)的時(shí)候更推薦使用 koa-views中間件來渲染頁面
npm install koa-views -S
在 app.js 中將 views 目錄設(shè)定為模版目錄
const views = require('koa-views')
app.use(views(__dirname + '/views'));
然后在路由文件中，就能使用 render 方法了
routes/index.js
const router = require('koa-router')()
router.get('/index', async (ctx, next) => {
await ctx.render('index');
});
module.exports = router

以上是直接渲染 html 文件的方法，如果要引入模板引擎，可以添加 extension 字段來設(shè)定模版類型
app.use(views(__dirname + '/views', {
extension: 'pug' // 以 pug 模版為例
}))

五、結(jié)語

如果將 Express 看作 webstorm，那么 Koa 就是 sublime
當(dāng) Express 流行的時(shí)候，其冗雜的依賴項(xiàng)被很多開發(fā)者所詬病
所以 Express 團(tuán)隊(duì)將 Express 拆卸得只剩下最基本的骨架，讓開發(fā)者自行組裝，這就是 Koa
正如文中所說，從零開始太過繁瑣，可以使用腳手架 koa-generato 來快速開發(fā)
不過我更推薦，在熟悉了 Koa 之后，搭一個(gè)適合自己項(xiàng)目的腳手架
不然為何不直接用 Express 呢
我想這也是 Koa 的官方文檔中沒有提到 generator 工具的原因吧