Node.js 蠶食計劃（五）—— Koa 基礎項目搭建

Koa 是由 Express 原班人馬打造的超輕量服務端框架

與 Express 相比，除了自由度更高，能夠自行引入中間件以外，更重要的是使用了 ES6 + async，從而避免了回調地獄

不過也是由於代碼升級，因此 Koa2 須要 v7.60 以上的 node.js 環境

 

1、建立項目

手動建立一個項目目錄，而後快速生成一個 package.json 文件

npm init -y

安裝 koa    //當前版本 2.4.1

npm install koa -S

而後建立一個 app.js

// app.js

const Koa = require('koa');
const app = new Koa();

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

app.listen(3000);

最後在 package.json 中添加啓動指令

一個最基礎的 koa 應用就這樣完成了

能夠執行 npm start 並在瀏覽器訪問 http://localhost:3000/ 查看效果

 

若是以爲手動建立項目太過繁瑣，可使用腳手架 koa-generato 來生成項目

npm install koa-generator -g

koa2 project_name

而後在項目下 npm install 安裝依賴，npm start 啓動項目

若是是剛接觸 koa，建議先看完這篇博客，再使用腳手架工具，這樣能更好的理解各個依賴包的做用

 

 

2、配置路由

上面 app.js 中有一個 ctx，這是一個 Koa 提供的 Context 對象，封裝了 request 和 response

每一次 HTTP Request 都會建立一個 Context 對象

咱們能夠經過 Context.request.path 來獲取用戶請求的路徑，而後經過 Context.response.body 給用戶發送內容

Koa 默認的返回類型是 text/plain，若是要返回一個 html 文件（或者一個模塊文件），就須要修改 Context.response.type

另外，Context.response 能夠簡寫，好比 Context.response.type 簡寫爲 Context.type，Context.response.body 簡寫爲 Context.type

 

在項目下建立一個存放 html 文件的目錄 views，並在該目錄下建立一個 index.html，而後修改 app.js

// app.js
// 原生路由

const Koa = require('koa');
const fs = require('fs');
const app = new Koa();

app.use(async (ctx, next) => {
  if (ctx.request.path === '/index') {
  ctx.type = 'text/html';
  ctx.body = fs.createReadStream('./views/index.html');
  } else {
    await next();
  }
});

app.listen(3000);

而後在瀏覽器中訪問 http://localhost:3000/index 就能看到 index.html 頁面，而訪問別的地址則是 not found

這樣處理 url 顯得特別笨拙，因此咱們須要引入路由中間件 koa-router

npm install koa-router -S

須要注意的是，在導入 koa-router 的時候，須要在末尾加一個括號：

const router = require('koa-router')();

至關於：

const koaRouter = require('koa-router');
const router = koaRouter();

 

建立一個 routes 目錄，用來存放路由文件，並在目錄下建立 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

這裏還可使用 prefix 方法，爲文件中的全部接口添加一個 baseUrl

// router.prefix('/about')

 

修改 app.js

// app.js

const Koa = require('koa');
const app = new Koa();

const index = require('./routes/index')
app.use(index.routes(), index.allowedMethods())

app.listen(3000);

上面的 allowedMethods 用於校驗請求的方法，若是用 post 請求訪問 get 接口，就會直接返回失敗

 

另外，還能夠在 url 中添加變量，而後經過 Context.params.name 訪問

router.get('/about/:name', async (ctx, next) => {
  ctx.body = `I am ${ctx.params.name}!`;
});

 

 

3、靜態資源

在上面的 index.html 中，若是須要引入 css 等靜態資源，就須要用到 koa-static

npm install koa-static -S

建立一個目錄 public 用來存放靜態資源

 而後在 app.js 中添加如下代碼

const static = require('koa-static');
// 將 public 目錄設置爲靜態資源目錄
const main = static(__dirname + '/public');
app.use(main);

事實上，這三行代碼還能夠優化

app.use(require('koa-static')(__dirname + '/public'));

而後就能在 index.html 中引入對應的文件了

 

 

4、模板引擎

上面的路由是使用 fs 模塊直接讀取 html 文件

開發的時候更推薦使用 koa-views 中間件來渲染頁面

npm install koa-views -S

在 app.js 中將 views 目錄設定爲模版目錄

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 字段來設定模版類型

app.use(views(__dirname + '/views', {
  extension: 'pug'    // 以 pug 模版爲例
}))

 

 

5、結語

若是將 Express 看做 webstorm，那麼 Koa 就是 sublime

當 Express 流行的時候，其冗雜的依賴項被不少開發者所詬病

因此 Express 團隊將  Express 拆卸得只剩下最基本的骨架，讓開發者自行組裝，這就是 Koa

正如文中所說，從零開始太過繁瑣，可使用腳手架 koa-generato 來快速開發

不過我更推薦，在熟悉了 Koa 以後，搭一個適合本身項目的腳手架

否則爲什麼不直接用 Express 呢

我想這也是 Koa 的官方文檔中沒有提到 generato 工具的緣由吧