Koa2 是由 Express 團(tuán)隊(duì)打造的下一代 Node.js Web 框架,基于 ES7 的 async/await 實(shí)現(xiàn)。由于 Node.js v7.6.0 開始完全支持 async/await,所以需要 Node.js 版本在 7.6.0 以上才能正常使用 Koa2。
Koa2 只封裝了 context、request、response 以及最核心的中間件處理流程,所以很多功能,比如路由等都需要自行編寫或從 npm 安裝中間件來實(shí)現(xiàn)。本文僅對 Koa2 做一個簡單的體驗(yàn),使用一些常用的中間件,使用 yarn 作為包管理工具。
Hello World
首先安裝 Koa2:
# 初始化 package.json
yarn init
# 安裝 Koa2
yarn add koa
按照慣例,先來個 Hello World,新建一個 app.js 文件:
const Koa = require('koa');
const app = new Koa();
app.use(ctx => {
ctx.body = 'Hello World';
});
app.listen(3000);
啟動上面的 Hello World:
node app.js
瀏覽器訪問 localhost:3000 就可以看到 Hello World 了!
路由
Koa2 本身并沒有封裝路由,但是可以通過判斷 ctx.request.url 來定制所需的路由。但是這樣做比較繁瑣,本文就不做贅述,我們直接使用路由中間件 koa-router 。
首先安裝 koa-router:
yarn add koa-router@next
然后在上文的基礎(chǔ)上修改 app.js 文件:
const Koa = require('koa');
const Router = require('koa-router');
const app = new Koa();
const router = new Router();
router
.get('/', ctx => {
ctx.body = 'Home Page'
})
.get('/user', ctx => {
ctx.body = 'User Page'
})
app.use(router.routes()).use(router.allowedMethods());
app.listen(3000);
用瀏覽器分別訪問 localhost:3000 和 localhost:3000/user 就可以看到效果了!
除了 GET 方法外,koa-router 支持 POST、PUT 等多種 HTTP 方法,本文不再詳細(xì)講述,更多用法請參考 koa-router 文檔。
獲取 GET 請求數(shù)據(jù)
獲取 GET 請求數(shù)據(jù)是通過 request 對象中的 query 方法或 querystring 方法,query 方法返回格式化的參數(shù)對象,querystring 返回的是請求字符串,例如下面的路由:
router.get('/query', ctx => {
console.log(ctx.query);
console.log(ctx.querystring);
})
訪問 localhost:3000/query?a=1&b=2,ctx.query 的值為 { a: '1', b: '2' },ctx.querystring 的值為 a=1&b=2。
獲取 POST 請求數(shù)據(jù)
Koa2 中沒有封裝獲取 POST 請求中參數(shù)的方法,需要解析 ctx.req 對象獲取數(shù)據(jù),ctx.req 為原生 Node.js 請求對象。本文不對其進(jìn)行詳細(xì)解析,我們直接使用 koa-bodyparser 中間件將數(shù)據(jù)解析到 ctx.request.body 中。首先安裝 koa-bodyparser 中間件:
yarn add koa-bodyparser
然后在 app.js 中使用該中間件:
const bodyParser = require('koa-bodyparser');
app.use(bodyParser());
然后再添加一個 POST 請求的路由:
router.post('/query', ctx => {
ctx.body = ctx.request.body
})
使用 Postman 提交一個帶參數(shù)的 POST 請求,就可以看到效果了!
模板引擎
在 Koa2 中使用模板引擎,首先要安裝 koa-views 中間件,該中間件支持 ejs、jade、pug、swig、react 等大多數(shù)模板引擎,然后再安裝你想要使用模板引擎,本文以 ejs 為例:
yarn add koa-views ejs
在 app.js 中引入中間件并配置模板引擎:
const views = require('koa-views');
// 配置模板文件目錄和后綴名
app.use(views(__dirname + '/views', {
extension: 'ejs'
}))
新建模板文件 views/index.ejs:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title><%= title %></title>
</head>
<body>
<h1><%= title %></h1>
<p>Welcome to Koa2</p>
</body>
</html>
然后添加一個路由:
router.get('/ejs', async (ctx) => {
let title = 'Hello Koa2'
await ctx.render('index', { title })
})
使用瀏覽器訪問 localhost:3000/ejs 就可以看到效果了!
Cookie
Koa2 提供了從上下文中直接讀取和寫入 cookie 的方法 ctx.cookies.get(name, [options]) 和 ctx.cookies.set(name, value, [options])。
由于 Koa2 的 cookies 操作是使用的 cookies 模塊,所以參數(shù)和用法都與其一致。
本文參考了 koa2 進(jìn)階學(xué)習(xí)筆記,在此對原作者表示感謝,更多關(guān)于 Koa2 的用法請參考 Koa2 的官方文檔。