初涉nodejs后臺開發(fā)，在得知express和koa是同一個團隊開發(fā)之后果斷選擇了更前沿的koa2試水。結果發(fā)現koa生態(tài)是真的不成熟啊，不過開發(fā)起來也更有意思。
安裝依賴
此次我們使用koa-generator作為腳手架創(chuàng)建項目根暑，這個也不是官方腳手架，大家熟悉了可以隨便改徙邻。
npm install koa-generator -g
koa2 my-project
cd my-project
這樣就生成了一個基本的項目框架排嫌。
除此之外，必須要安裝的還有用來操作MongoDB的mongoose缰犁、用來進行單元測試的框架ava以及superkoa淳地。
npm install --save mongoose
npm install --save-dev ava
npm install --save-dev superkoa
下面是我項目的package.json文件的依賴，其中mount-koa-routes是一個自動讀取routes文件的框架民鼓，可以不用薇芝。
"dependencies": {
"debug": "^2.6.3",
"koa": "^2.2.0",
"koa-bodyparser": "^3.2.0",
"koa-convert": "^1.2.0",
"koa-json": "^2.0.2",
"koa-logger": "^2.0.1",
"koa-onerror": "^1.2.1",
"koa-router": "^7.1.1",
"koa-static": "^3.0.0",
"koa-views": "^5.2.1",
"mongoose": "^5.4.0",
"mongoosedao": "^1.0.13",
"mount-koa-routes": "^2.0.1",
"pug": "^2.0.0-rc.1"
},
"devDependencies": {
"ava": "^1.0.1",
"nodemon": "^1.18.9",
"superkoa": "^1.0.3",
}
定義數據庫連接和Schema對象
此次我們要做的api是做一個能夠增刪改查分類的api。MongoDB是這幾年非撤峒危火爆的一個nosql數據庫。在嘗試過后確實趕緊nosql很爽饮亏。MongoDB的學習資料建議看這個：http://www.runoob.com/mongodb/mongodb-tutorial.html
搭建一個MongoDB數據庫要比Mysql和OracleDB快多了耍贾。
我們使用mongoose.js來處理MongoDB的相關操作阅爽。mongoose.js可以看作是nodejs上MongoDB的ORM框架付翁，和java后端的hibernate以及android端的greenDAO類似百侧。有過ORM框架經驗的上手非常容易初斑。具體的mongoose學習看官網就非常好：https://mongoosejs.com/
首先我們在新建一個mongo-db.js來執(zhí)行MongoDB的連接：
const mongoose = require('mongoose');
const connect = mongoose.connect('mongodb://www.zhangyesong.com:27017/test',
{useNewUrlParser: true});
connect.then((() => {
console.log('連接數據庫成功');
}), (error => {
console.log('連接數據庫失敗' + error);
}));
是不是很簡單砂竖？然后在app.js引用就可以：
require('./config/mongo-db');
新建一個目錄用來存放所有的Scheme，在里面新建一個文件category.js，如下：
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const CategorySchema = new Schema({
_id: String,
name: {type: String, required: true},
parent: String,
level: {type: Number, min: 0, max: 5},
});
const CategoryModel = mongoose.model('Category', CategorySchema);
module.exports = CategoryModel;
雖然MongoDB沒有表的概念只有Collection的概念查库，但是正常情況下我們肯定還是讓Collection里的每條數據都有著相同的數據結構的樊销。Schema就是定義Colletion里面數據的結構的。
這里我們給category定義了四個key剂府。
_id是默認的數據的默認字段，全局唯一铡羡，默認類型是ObjectId，這里我改成了String，由用戶自己來定義贪壳。
name記錄分類的名字蚂且。
parent記錄分類的上級分類幅恋。
level記錄分類的層級品追。
定義好Schema之后哪雕，創(chuàng)建model類然后export出去。
撰寫RESTful api
RESTful api設計風格越來越流行，接口不做成RESTful怎么行呢咨油？
我所掌握的RESTful api有以下兩個要點：
- url要使用表示資源的名字法瑟，比如我這里就是category或categories，盡量不要使用動詞。
- 使用GET來做query請求淫痰，POST做創(chuàng)建請求讲冠，PATCH做修改請求竿开，DELETE做刪除請求疯攒，反正就是把Http請求用對，不用什么都用GET和POST一把干完贴浙。
想詳細學習以下RESTful的同學可以看看阮一峰老師的這篇博客：http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html
這里面爭議比較大的是query請求靈活多變袁串，url上有時候強行用資源名稱反而會導致接口語義不清到腥。因此我這里只保證query以外的請求符合REST風格晋辆。
首先我們對所有的返回簡單封裝以下：
exports.createOKResponse = function(data) {
return {
error: 0,
data: data,
}
};
exports.createFailedResponse = function(error, message) {
return {
error: error,
message: message,
}
};
然后api接口代碼如下：
const response = require('../util/response-util');
const router = require("koa-router")();
const CategoryModel = require('../model/category');
router.post('/', async (ctx) => {
let requestCategory = ctx.request.body;
if (!checkCategory(requestCategory)) {
ctx.body = response.createFailedResponse(400, 'bad request params');
return;
}
let result = await CategoryModel.create(requestCategory);
if (result) {
ctx.body = response.createOKResponse(result);
} else {
ctx.body = response.createFailedResponse(500, 'create category failed');
}
});
router.delete('/', async (ctx) => {
let _id = ctx.query._id;
if (!_id) {
ctx.body = response.createFailedResponse(400, 'bad request params');
return;
}
let result = await CategoryModel.findByIdAndDelete({_id});
if (result) ctx.body = response.createOKResponse(result);
else ctx.body = response.createFailedResponse(500, 'delete category fail')
});
router.patch('/', async (ctx) => {
let requestCategory = ctx.request.body;
let _id = requestCategory._id;
if (!_id) {
ctx.body = response.createFailedResponse(400, 'bad request params');
return;
}
let category = await CategoryModel.findById(_id);
if (!category) {
ctx.body = response.createFailedResponse(404, 'can not find such category');
return
}
if(requestCategory.name) category.name = requestCategory.name;
if(requestCategory.parent) category.parent = requestCategory.parent;
if(requestCategory.level) category.level = requestCategory.level;
let result = await category.save();
if (result) ctx.body = response.createOKResponse(result);
else ctx.body = response.createFailedResponse(500, 'update category fail')
});
router.get('/list', async (ctx) => {
let parent = ctx.query.parent;
if (!parent) {
ctx.body = response.createFailedResponse(400, 'bad request params');
}
let result = await CategoryModel.find({parent: parent}).select('_id name parent level').exec();
if (result) {
ctx.body = response.createOKResponse(result);
} else {
ctx.body = response.createFailedResponse(500, 'find categories failed');
}
});
function checkCategory(category) {
return !(category.level > 5 || category.level < 0 || !category.level || !category.name || !category._id);
}
module.exports = router;
可以看到mongoose處理數據庫的增刪改查請求都是異步，使用es7的await語句做異步是不是非常的爽？
單元測試
單元測試可以幫助發(fā)現很大比例的bug球散，ava是一新一代的nodejs測試框架尿赚，可以異步測試（雖然這次我需要的是同步- -）具體的使用說明可以看官方github主頁：https://github.com/avajs/ava
在寫測試代碼的時候尷尬了，我們請求接口是異步蕉堰，執(zhí)行測試用例也是異步凌净，但是對category四個接口的測試我是想有順序地執(zhí)行的（比如我得先創(chuàng)建一個測試分類然后才能修改、查詢屋讶、刪除冰寻，沒有順序的話沒辦法每次跑單元測試都通過）。棘手的是我好像并想不到同步執(zhí)行單元測試的方法- -最后還是查詢官方文檔得知的皿渗，在test后面加上.serial即可斩芭。看來ava還是為我們考慮到了這一點的乐疆。superkoa是基于supertest的做的一個可以讓我們在ava測試代碼里調用koa的框架划乖，使用起來非常的簡單。
新建一個test文件夾挤土，添加一個test.js文件琴庵，全部的測試代碼如下：
import test from 'ava';
import superKoa from 'superkoa';
import app from '../app';
test('hello full-stacker', async t => {
let res = await superKoa(app).get('/');
t.is(200, res.status);
t.is(res.text, 'Hello full stacker!')
});
test.serial('create category', async t => {
let testCategory = {
_id:'test',
name:'測試分類',
parent:'root',
level:1
};
let res = await superKoa(app)
.post('/category')
.send(testCategory);
t.is(200, res.status);
t.is(0, res.body.error);
t.is('測試分類', res.body.data.name);
});
test.serial('update category', async t => {
let res = await superKoa(app)
.patch('/category')
.send({_id: 'test', name: '測試分類2'});
t.is(200, res.status);
t.is(0, res.body.error);
t.is('測試分類2', res.body.data.name);
});
test.serial('query categories by parent', async t => {
let res = await superKoa(app)
.get('/category/list?parent=root');
t.is(200, res.status);
t.is(0, res.body.error);
t.true(res.body.data.length > 0);
});
test.serial('delete category', async t => {
let res = await superKoa(app)
.delete('/category?_id=test');
t.is(200, res.status);
t.is(0, res.body.error);
});
然后把package.json下的script標簽下的test命令改為"test": "ava -v"
現在我們來執(zhí)行下單元測試：
? npm test
> full-stacker-server@0.1.0 test /Users/judy/WeChatProjects/full-stacker/full-stacker-api
> ava -v
mount route /category.js
mount route /index.js
******************************************************
MoaJS Apis Dump
******************************************************
┌─────────────────────────────────────────────────────────────────────────────┬────────┬────────────────┐
│ File │ Method │ Path │
├─────────────────────────────────────────────────────────────────────────────┼────────┼────────────────┤
│ /Users/judy/WeChatProjects/full-stacker/full-stacker-api/routes/category.js │ POST │ /category/ │
├─────────────────────────────────────────────────────────────────────────────┼────────┼────────────────┤
│ /Users/judy/WeChatProjects/full-stacker/full-stacker-api/routes/category.js │ DELETE │ /category/ │
├─────────────────────────────────────────────────────────────────────────────┼────────┼────────────────┤
│ /Users/judy/WeChatProjects/full-stacker/full-stacker-api/routes/category.js │ PATCH │ /category/ │
├─────────────────────────────────────────────────────────────────────────────┼────────┼────────────────┤
│ /Users/judy/WeChatProjects/full-stacker/full-stacker-api/routes/category.js │ GET │ /category/list │
├─────────────────────────────────────────────────────────────────────────────┼────────┼────────────────┤
│ /Users/judy/WeChatProjects/full-stacker/full-stacker-api/routes/index.js │ GET │ │
└─────────────────────────────────────────────────────────────────────────────┴────────┴────────────────┘
<-- POST /category
連接數據庫成功
POST /category - 4358ms
--> POST /category 200 4,364ms 89b
? create category (4.4s)
<-- PATCH /category
PATCH /category - 87ms
--> PATCH /category 200 89ms 90b
? update category
<-- GET /category/list?parent=root
GET /category/list?parent=root - 26ms
--> GET /category/list?parent=root 200 34ms 270b
? query categories by parent
<-- DELETE /category?_id=test
DELETE /category?_id=test - 27ms
--> DELETE /category?_id=test 200 28ms 90b
? delete category
<-- GET /
GET / - 1ms
--> GET / 200 3ms 19b
? hello full-stacker
5 tests passed
看著單元測試全部通過有著莫名的快感，不知道大家是否也一樣呢～
最貼一下代碼地址仰美，目前這個項目剛剛開始迷殿，也是我的nodejs試水項目。新司機上路咖杂，有問題請大家斧正庆寺。
https://github.com/ZhangYeSong/full-stacker
