Koa 框架常用知識點整理

mufengsm發表於2019-03-29

框架

簡介

Koa 就是一種簡單好用的 Web 框架。它的特點是優雅、簡潔、表達力強、自由度高。本身程式碼只有1000多行，所有功能都通過外掛實現。

學前準備

檢查Nodejs版本

開啟cmd命令列視窗node -v
注意：Koa 必須使用 7.6 以上的版本。如果你的版本低於這個要求，就要先升級 Node。
配套案例

一、基本用法

1.1 三行程式碼架設HTTP服務

npm install koa

  const Koa = require('koa');
  const app = new Koa();
  app.listen(3000);

1.2 Context 物件

Koa 提供一個 Context 物件，表示一次對話的上下文（包括 HTTP 請求和 HTTP 回覆）。通過加工這個物件，就可以控制返回給使用者的內容。

Context 物件所包含的：

context

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

app.use((ctx, next) => {
    //ctx是整個應用的上下文，包含常用的request、response
    //ctx.response代表 HTTP Response。同樣地，ctx.request代表 HTTP Request。
    //ctx.response.body可以簡寫成ctx.body
    ctx.response.body = 'hello world'
})

app.listen(3000)

1.3 HTTP Response 的型別

Koa 預設的返回型別是text/plain （純文字的形式），如果想返回其他型別的內容，可以先用ctx.request.accepts判斷一下，客戶端希望接受什麼資料（根據 HTTP Request 的Accept欄位），然後使用ctx.response.type指定返回型別。

const Koa = require('koa')
const app = new Koa()
//宣告一個main中介軟體，如果你急於瞭解中介軟體可以跳轉到（三）
const main = (ctx,next) =>{
if (ctx.request.accepts('json')) {
    ctx.response.type = 'json';
    ctx.response.body = { data: 'Hello World' };
  } else if (ctx.request.accepts('html')) {
    ctx.response.type = 'html';
    ctx.response.body = '<p>Hello World</p>';
  } else if (ctx.request.accepts('xml')) {
    ctx.response.type = 'xml';
    ctx.response.body = '<data>Hello World</data>';
  } else{
    ctx.response.type = 'text';
    ctx.response.body = 'Hello World';
  };
}; //直接執行頁面中會顯示json格式，因為我們沒有設定請求頭，所以每一種格式都是ok的。   

app.use(main)//app.use()用來載入中介軟體。
app.listen(3000)

1.4 網頁模板

實際開發中，返回給使用者的網頁往往都寫成模板檔案。我們可以讓 Koa 先讀取模板檔案，然後將這個模板返回給使用者。

關於fs.createReadStream

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

const main = ctx => {
    ctx.response.type = 'html';
    ctx.response.body = fs.createReadStream('./data/index.html');
};

app.use(main);
app.listen(3000);

二、路由

2.1 原生路由

const Koa = require('koa')
const app = new Koa()
app.use((ctx, next) => {
    if (ctx.request.url == '/') {//通過ctx.request.url獲取使用者請求路徑
        ctx.body = '<h1>首頁</h1>'
    } else if (ctx.request.url == '/my') {
        ctx.body = '<h1>聯絡我們</h1>'
    } else {
        ctx.body = '<h1>404 not found</h1>'
    }
})
app.listen(3000)

2.2 koa-router 模組路由

npm中的koa-route

npm install koa-router

const Koa = require('koa')
const Router = require('koa-router')

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

app.use(router.routes()).use(router.allowedMethods());
//routes()返回路由器中介軟體，它排程與請求匹配的路由。
//allowedMethods()處理的業務是當所有路由中介軟體執行完成之後,若ctx.status為空或者404的時候,豐富response物件的header頭.

router.get('/',(ctx,next)=>{//.get就是傳送的get請求
  ctx.response.body = '<h1>首頁</h1>'
})
router.get('/my',(ctx,next)=>{
  ctx.response.body = '<h1>聯絡我們</h1>'
})

app.listen(3000)

2.3 靜態資源

如果網站提供靜態資源（圖片、字型、樣式表、指令碼......），為它們一個個寫路由就很麻煩，也沒必要koa-static模組封裝了這部分的請求。請看下面的例子

npm中的koa-static

npm install koa-staic

const Koa = require('koa');
const app = new Koa();
const path = require('path');
const serve = require('koa-static');

const main = serve(path.join(__dirname));

app.use(main);
app.listen(3000);

訪問 http://localhost:3000/data/index.html，在瀏覽器裡就可以看到這個檔案的內容。

2.4 重定向跳轉

有些場合，伺服器需要重定向訪問請求。比如，使用者登陸以後，將他重定向到登陸前的頁面。ctx.response.redirect()方法可以發出一個跳轉，將使用者導向另一個路由。

const Koa = require('koa');
const Router = require('koa-router');
const app = new Koa();
const router = new Router()

app.use(router.routes()).use(router.allowedMethods());

router.get('/cdx',(ctx,next)=>{
  ctx.response.redirect('/');//發出一個跳轉，將使用者導向另一個路由。
})
router.get('/',(ctx,next)=>{
   ctx.body = 'Hello World';
})

app.listen(3000);

訪問 http://localhost:3000/cdx，瀏覽器會將使用者導向根路由。

三、中介軟體

3.1 Logger功能

Koa 的最大特色，也是最重要的一個設計，就是中介軟體。為了理解中介軟體，我們先看一下 Logger （列印日誌）功能的實現。

./logger/koa-logger.js

module.exports = (ctx, next) => {
    console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);//自定義
}

./logger.js

const Koa = require('koa')
const koaLogger = require('./logger/koa-logger')
const app = new Koa();

app.use(koaLogger)
app.listen(3000)

列印結果 logger

3.2中介軟體的概念

處在 HTTP Request 和 HTTP Response 中間，用來實現某種中間功能的函式，就叫做"中介軟體"。

基本上，Koa 所有的功能都是通過中介軟體實現的，前面例子裡面的main也是中介軟體。每個中介軟體預設接受兩個引數，第一個引數是 Context 物件，第二個引數是next函式。只要呼叫next函式，就可以把執行權轉交給下一個中介軟體。

多箇中介軟體會形成一個棧結構，以"先進後出"的順序執行。

最外層的中介軟體首先執行。
呼叫next函式，把執行權交給下一個中介軟體。
...
最內層的中介軟體最後執行。
執行結束後，把執行權交回上一層的中介軟體。
...
最外層的中介軟體收回執行權之後，執行next函式後面的程式碼。

例子：

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

app.use((ctx, next)=>{
  console.log('>> one');
  next();
  console.log('<< one');
})

app.use((ctx, next)=>{
  console.log('>> two');
  next(); 
  console.log('<< two');
})
app.use((ctx, next)=>{
  console.log('>> three');
  next();
  console.log('<< three');
})
app.listen(3000);

輸出結果：

中介軟體

如果中介軟體內部沒有呼叫next函式，那麼執行權就不會傳遞下去。

3.4 非同步中介軟體

迄今為止，所有例子的中介軟體都是同步的，不包含非同步操作。如果有非同步操作（比如讀取資料庫），中介軟體就必須寫成async 函式。

npm install fs.promised

npm中的fs.promised

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

const main = async function (ctx, next) {
    ctx.response.type = 'html';
    ctx.response.body = await fs.readFile('./data/index.html', 'utf8');
};

app.use(main);
app.listen(3000);

上面程式碼中，fs.readFile是一個非同步操作，必須寫成await fs.readFile()，然後中介軟體必須寫成 async 函式。

app.use(async(ctx, next)=>{
  ctx.body = '1'
  //延時2秒執行下一個中介軟體，這樣是沒用的，因為是非同步函式
  setTimeout(()=>{
      next()
  },2000)
  ctx.body += '2'
})

app.use(async(ctx, next)=>{
  ctx.body += '3'
  next()
  ctx.body += '4'
})


server.js正確做法
function delay(){
    return new Promise((reslove,reject)=>{
      setTimeout(()=>{
        reslove()
      },1000)
    })
}

app.use(async(ctx, next)=>{
  ctx.body = '1'
  await next()
  ctx.body += '2'
})

app.use(async(ctx, next)=>{
  ctx.body += '3'
  await delay()
await next()
  ctx.body += '4'
})

3.5 中介軟體的合成

koa-compose 模組可以將多箇中介軟體合成一個。

npm中的koa-compose

npm install koa-compose

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

const logger = (ctx, next) => {
  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
  next();
}

const main = ctx => {
  ctx.response.body = 'Hello World';
};

const middlewares = compose([logger, main]);//合成中介軟體

app.use(middlewares);//載入中介軟體
app.listen(3000);

輸出結果：先列印日誌，再在頁面中顯示Hello World

四、處理錯誤

4.1 500錯誤

如果程式碼執行過程中發生錯誤，我們需要把錯誤資訊返回給使用者。HTTP 協定約定這時要返回500狀態碼。Koa 提供了ctx.throw()方法，用來丟擲錯誤，ctx.throw(500)就是丟擲500錯誤。

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

const main = ctx => {
  ctx.throw(500);//這個時候你訪問首頁會報一個500的錯誤(內部伺服器錯誤)伺服器會報錯
};

app.use(main);
app.listen(3000);

500

4.2 404錯誤

如果將ctx.response.status設定成404，就相當於ctx.throw(404)，返回404錯誤。

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

const main = ctx => {
  ctx.response.status = 404;//response返回的狀態碼就是404
  ctx.response.body = 'Page Not Found';//讓頁面中顯示該內容，伺服器不不報錯
};

app.use(main);
app.listen(3000);

404

4.3 處理錯誤的中介軟體

為了方便處理錯誤，最好使用try...catch將其捕獲。但是，為每個中介軟體都寫try...catch太麻煩，我們可以讓最外層的中介軟體，負責所有中介軟體的錯誤處理。

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

const handler = async (ctx, next) => {
  try {
    await next();//執行下箇中介軟體
  } catch (err) {
     //如果main中介軟體是有問題的會走這裡
    ctx.response.status = err.statusCode || err.status || 500;
    ctx.response.body = {
      message: err.message//把錯誤資訊返回到頁面
    };
  }
};

const main = ctx => {
  ctx.throw(500);//如果這裡是沒有問題的就正常執行，如果有問題會走catach
};

app.use(handler);
app.use(main);
app.listen(3000);

解決錯誤

4.4 errors事件監聽

執行過程中一旦出錯，Koa 會觸發一個error事件。監聽這個事件，也可以處理錯誤。

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

const main = ctx => {
  ctx.throw(500);
};
app.on('error', (err, ctx) => {
   //如果有報錯的話會走這裡
  console.error('server error', err);//err是錯誤源頭
});

app.use(main);
app.listen(3000);

錯誤監聽

4.5 釋放error事件

需要注意的是，如果錯誤被try...catch捕獲，就不會觸發error事件。這時，必須呼叫ctx.app.emit()，手動釋放error事件，才能讓監聽函式生效。

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

const handler = async (ctx, next) => {
    try {
        await next();
    } catch (err) {
        ctx.response.status = err.statusCode || err.status || 500;
        ctx.response.type = 'html';
        ctx.response.body = '<p>有問題，請與管理員聯絡</p>';
        ctx.app.emit('error', err, ctx);//釋放error事件
    }
};

const main = ctx => {
    ctx.throw(500);
};

app.on('error', function (err) {
    //釋放error事件後這裡的監聽函式才可生效
    console.log('錯誤', err.message);
    console.log(err);
});

app.use(handler);
app.use(main);
app.listen(3000);

上面程式碼main函式丟擲錯誤，被handler函式捕獲。catch程式碼塊裡面使用ctx.app.emit()手動釋放error事件，才能讓監聽函式監聽到。

五、Web App的功能

ctx.cookies用來讀寫 Cookie。

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

const main = function(ctx) {
                    //讀取cookie//沒有返回0
  const n = Number(ctx.cookies.get('view') || 0) + 1;
  ctx.cookies.set('view', n);//設定cookie
  ctx.response.body = n + ' views';//顯示cookie
}

app.use(main);
app.listen(3000);

5.2 表單

Web 應用離不開處理表單。本質上，表單就是 POST 方法傳送到伺服器的鍵值對。koa-body模組可以用來從 POST 請求的資料體裡面提取鍵值對。

npm中的koa-body

npm install koa-body

const Koa = require('koa');
const koaBody = require('koa-body');
const app = new Koa();

const main = async function (ctx) {
    const body = ctx.request.body;
    if (!body.name){
        ctx.throw(400, '.name required')
    };
    ctx.body = { name: body.name };
};

app.use(koaBody());
app.use(main);
app.listen(3000);

模擬post

上面程式碼使用 POST 方法向伺服器傳送一個鍵值對，會被正確解析。如果傳送的資料不正確，就會收到錯誤提示。

5.3 檔案上傳

koa-body模組還可以用來處理檔案上傳。

./demo/檔案上傳.js

const Koa = require('koa');
const koaBody = require('koa-body');
const Router = require('koa-router');
const fs = require('fs');
const path = require('path');
const router = new Router()
const app = new Koa();

app.use(koaBody({
    multipart: true,//解析多部分主體，預設false
    formidable: {
        maxFileSize: 200 * 1024 * 1024    // 設定上傳檔案大小最大限制，預設2M
    }
}));

app.use(router.routes()).use(router.allowedMethods());

router.post('/uploadfile', (ctx, next) => {
    // 上傳單個檔案
    const file = ctx.request.files.file; // 獲取上傳檔案
    // 建立可讀流
    const reader = fs.createReadStream(file.path);
    let filePath = path.join(__dirname, 'data/') + `/${file.name}`;
    // 建立可寫流
    const upStream = fs.createWriteStream(filePath);
    // 可讀流通過管道寫入可寫流
    reader.pipe(upStream);
    return ctx.body = "上傳成功！";
});

app.listen(3000)

./demo/web/index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
    <form action="http://127.0.0.1:3000/uploadfile" method="post" enctype="multipart/form-data">
    <input type="file" name="file" id="file" value="" multiple="multiple" />
    <input type="submit" value="提交"/>
</form>
</body>
</html>

nodejs中的fs檔案系統模組，可以幫你讀檔案寫檔案，但是不會幫你建立資料夾。

本文思路來源http://www.ruanyifeng.com/blog/2017/08/koa.html

Flow 常用知識點整理
2019-03-31
java框架之Hibernate框架知識點整理。
2018-07-21
Java框架
Runtime知識點整理
2018-08-04
JavaScript知識點整理
2019-02-17
JavaScript
MQTT知識點整理
2024-08-07
MQQT
CANFD知識點整理
2024-06-20
String知識點整理
2023-04-16
原生JS知識點整理
2019-04-17
JS
webpack常用知識點
2019-10-16
Web
SVN - 常用知識點
2020-10-12
PHP 易錯知識點整理
2019-03-02
PHP
Servlet基礎知識點整理
2018-12-14
Servlet
vue知識點整理（轉發）
2018-12-06
Vue
struts2知識點整理
2018-07-14
jQuery面試知識點整理
2018-05-30
jQuery面試
React入門知識點整理
2018-05-17
React
整理：iOS開發知識點
2020-06-17
iOS
【整理】JVM知識點大梳理
2020-06-04
JVM
MySQL 叢集知識點整理
2021-01-13
MySql
vue常用的知識點
2018-10-29
Vue
線性代數常用基本知識整理
2018-07-13
FPGA數碼管知識點整理
2024-03-03
FPGA
Java容器相關知識點整理
2020-06-18
Java
Oracle 選擇題知識點整理
2019-12-31
Oracle
python中pandas的知識點整理
2021-09-11
Python
docker常用知識點總結
2024-11-06
Docker
mysql 常用知識點總結
2024-09-16
MySql
RabbitMQ 常用知識點總結
2021-07-12
MQ
ES6部分常用知識整理
2019-05-10
Python基礎知識之常用框架Flask！
2021-01-25
Python框架Flask
HTML DOM 知識點整理（一）—— Document物件
2018-11-29
HTML物件
Vue 面試中常問知識點整理
2018-09-15
Vue面試
React學習筆記知識點整理
2018-06-29
React筆記
PHP 面試知識點整理歸納
2018-09-05
PHP面試
Spring和Springboot相關知識點整理
2020-06-24
Spring Boot
前端面試知識點目錄整理
2019-05-06
前端面試
自己整理的php面試知識點
2023-02-10
PHP面試
機器學習知識點整理（三）
2020-12-22
機器學習