透過Node.js使用Koa進行專案搭建

時下前端工程師有很多人比較關注NodeJs以及express 框架或Koa 框架之類的新技術。難得我最近閒時較多，利用一下舊曆新年尚未正式到來的這片閒暇，也來涉足其中，一窺其中奧妙。

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

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

不過也是因為程式碼升級，所以Koa2 需要v7.60 以上的node.js 環境

一、創建專案

手動建立一個專案目錄，然後快速產生一個 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，建議先看完這篇博客，再使用腳手架工具，這樣能更好的理解各個依賴包的作用

二、設定路由

上面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}!`;
});

三、靜態資源

在上面的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 中引入對應的檔案了

 

四、模板引擎

上面的路由是使用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 模版为例
}))

五、結語

如果將Express 看作webstorm，那麼Koa就是sublime

當Express 流行的時候，其冗餘的依賴項被很多開發者所詬病

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

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

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

上面是我整理給大家的，希望今後對大家有幫助。

相關文章：

express與koa的使用比較（詳細教學）

在vue中首次使用stylus安裝方法（詳細教程）

Vue框架中有關goods元件開發

#

以上是透過Node.js使用Koa進行專案搭建的詳細內容。更多資訊請關注PHP中文網其他相關文章！