(原創) 一個Restify+Mongoose+Redis的nodejs開發案例

在以往使用python進行web開發工作時，接觸過Django、Flask、Tornado等框架；而現在投入nodejs的懷抱，自然而然接觸到了Express和Restify框架，下面就根據自己的入門經驗，寫一個restify+mongoose+redis進行web開發的簡單示例。

零、開發環境

1.使用的node版本為v6.11.3 LTS（特此聲明:示例代碼使用了ES6的特性）；
2.MongoDB和Redis請自行下載（為什么要同時使用這兩個呢？因為懶
得寫restify+mongoose和restify+redis兩篇）；
3.依賴的node_modules包括：restify、mongoose、redis，
4.安裝好node后自帶包管理工具npm（比Python的pip更強大一點點）
-- npm install xxx -g 全局安裝
-- npm install xxx --save 安裝在本項目
一個名為package.json的文件是它的好基友，不信自己慢慢看

一、創建一個使用restify API的新服務器

假設啟動文件為app.js，直接上代碼

var restify = require('restify');

// 可配置項
var addr = '127.0.0.1';
var port = '8888';

var server = restify.createServer({
    name: 'test',
    version: '0.0.1'
});

// 使用插件
server.use(restify.pre.userAgentConnection());          // work around for curl  
server.use(restify.plugins.acceptParser(server.acceptable));
server.use(restify.plugins.queryParser());
server.use(restify.plugins.bodyParser());

server.listen(port, addr, function() {
    console.log("server %s is listening on port <%s>", server.name, server.url);
});

運行node app.js，本機的8888端口就開啟了一個使用restify API的服務器，因為沒有增加任何接口，所以無從訪問。

  • use部分使用的是restify內置的功能插件，當前引入的是用來解析參數，更具體更豐富的插件功能看這里
  • createServer的參數當然不只這兩個，具體可以參考這里

下面即將進入業務邏輯的開發，先假設業務為兩個部分：使用MongoDB管理用戶數據、使用redis管理會話中的Cookie。

二、使用mongoose訪問MongoDB

mongoose對于一個pythoner來說，使用起來并不是很順手，因為它跟mongoengine很是不同，后者使用Documentation來定義數據模型，而它用的是Schema和Model，至于具體怎么個弄法，還是看這里。

我們的示例呢，簡單地繼續，創建文件mongo.js，代碼如下：

var mongoose = require('mongoose');
var Schema = mongoose.Schema;

// 使用node的Promise替換mongoose的Promise,否則會報錯
mongoose.Promise = global.Promise;

// 可配置項
var host = '127.0.0.1';
var port = '27017';
var dbName = 'test';

var dbUri = `${host}:${port}/${dbName}`;
var dbConnection = mongoose.createConnection(dbUri);
dbConnection.on('error', (err) => {
    console.log('connect mongodb failed: ' + err);
    process.exit();
});

var dbSchemas = {
    // 定義user的Schema
    // 包括身份證號碼、姓名、性別、手機等
    userSchema: {
        idno: {type: String, require: true, unique: true},
        name: {type: String, require: true},
        gender: {type: Number, require: true},
        phone: {type: String},
        created: {type: Date, default: Date.now}
    }
};

// 定義UserModel
class UserModel {
    constructor(connection, schema) {
        this.name = 'user';
        this.schema = new Schema(schema);
        this.model = connection.model(`userModel`, this.schema, this.name);
    }

    // 封裝查詢
    findByIdno(idno) {
        return new Promise((resolve, reject) => {
            this.model.findOne({'idno': {$eq: idno}}, (err, record) => {
                if (err) {
                    reject(err);
                } else {
                    resolve(record);
                }
            });
        });
    }

    // 封裝插入or更新
    insertOrUpdateByIdno(data) {
        return new Promise((resolve, reject) => {
            this.model.findOne({'idno': {$eq: data.idno}}, (err, record) => {
                if (err) {
                    reject(err);
                } else {
                    if (record == undefined) {
                        // 插入
                        var instance = new this.model(data);
                        instance.save((err) => {
                            if (err) {
                                reject(err);
                            } else {
                                resovle(data);
                            }
                        });
                    } else {
                        // 更新
                        this.model.findOneAndUpdate({'idno': {$eq: data.idno}}, data, {new: true, upsert: true}, (err, res) => {
                            if (err) {
                                reject(err);
                            } else {
                                resolve(res);
                            }
                        });
                    }
                }
            });
        });
    }
}

var user = new UserModel(dbConnection, dbSchemas.userSchema);

exports.user = user;

上面代碼中使用到了ES6的諸多特性，包括Promise機制、Class以及“箭頭”函數等，做的工作則有：

  1. 建立與MongoDB的連接dbConnection
  2. 使用Node的Promise來替換mongoose的Promise（被棄用）
  3. 聲明user的數據結構userSchema
  4. 構造UserModel的類
  5. 在UserModel中封裝了對MongoDB的查詢(findOne)、插入(save)、更新(findOneAndUpdate)操作
  6. 實例化UserModel對象，并export以供調用

三、使用redis訪問Redis

Redis相比較MongoDB而言，速度更快，因為存儲在內存中嘛（可持久化），因而比MongoDB更適合用來管理Session。
Redis的使用也更簡單，不論是寫代碼還是在redis-cli中敲命令，支持7種數據類型的讀寫（之前寫的5種是因為我也是看的二手資料，現改過），每種數據類型的命令都不同，具體的還是看一下原味的redis數據類型介紹，直接看一手訊息以免入坑，然后代碼交互的話可以參考一下node-redis.

這邊示例繼續，創建redisClient.js，代碼如下：

var redis = require('redis');

// 可配置項
var host = '127.0.0.1';
var port = 6379;

var client = redis.createClient(port, host, {});

client.on('ready', (res) => {
    console.log('redis ready: ' + res);
});

client.on('error', (err) => {
    console.log('connect redis error: ' + err);
    process.exit(2);
});

// 假設cookie為哈希，token為string
class Session {
    constructor(client) {
        this.client = client;
    }

    // 設置/更新Cookie以及設置/重設有效期，默認10分鐘。
    updateCookie(uuid, cookie, t) {
        t = t ? t: 600;    // 默認10分鐘
        return new Promise((resolve, reject) => {
            let key = uuid + ':cookie';
            this.client.hmset(key, cookie, (err, res1) => {
                if (err) {
                    console.log('redis hmset error: ' + err);
                    reject(err);
                } else {
                    // 設置有效期
                    this.client.expire(key, t, (err, res2) => {
                        if (err) {
                            console.log('erdis hmset expire error: ' + err);
                            reject(err);
                        } else {
                            resolve(res2 === 1);
                        }
                    });
                }
            });
        });
    }

    // 查詢Cookie
    getCookie(uuid) {
        return new Promise((resolve, reject) => {
            let key = uuid + ':cookie';
            this.client.hgetall(key, (err, record) => {
                if (err) {
                    console.log('redis hgetall error: ' + err);
                } else {
                    resolve(record);
                }
            });
        });
    }

    // 設置or更新token，同樣設置有效期，默認10分鐘
    updateToken(uuid, token, t) {
        t = t ? t : 600;
        return new Promise((resolve, reject) => {
            let key = uuid + ':token';
            this.client.set(key, token, (err, res1) => {
                if (err) {
                    console.log('redis set error: ' + err);
                    reject(err);
                } else {
                    this.client.expire(key, t, (err, res2) => {
                        if (err) {
                            console.log('redis set expire error: ' + err);
                            reject(err);
                        } else {
                            resolve(res2 === 1);
                        }
                    });
                }
            });
        });
    }

    getToken(uuid) {
        return new Promise((resolve, reject) => {
            let key = uuid + ':token';
            this.client.get(key, (err, record) => {
                if (err) {
                    cosole.log('redis get error: ' + err);
                    reject(err);
                } else {
                    resolve(record);
                }
            });
        });
    }

    delUuid(uuid) {
        this.client.del(uuid + ':cookie');
        this.client.del(uuid + ':token');
    }
}

var session = new Session(client);

module.exports =  {
    session: session
};

上面完成的工作包括：

  1. 建立redis的client
  2. 定義Session的model
  3. 封裝hash和string兩種數據類型（Cookie和Token）的讀寫以及刪除
  4. 實例化Session并export以供調用（這里的export操作采用了另一種形式）

四、設計并實現api接口

現在數據模型的定義已經完成，就可以開始進行業務邏輯的實現。
根據model的定義，我們知道已實現的數據庫操作包括user、token、cookie的更新（包含創建）和查詢，由于后兩者都是redis的操作，我們就實現user和cookie的操作好了。
在app.js中，server.use代碼塊下方、server.listen上方區域添加如下代碼：

var route = require('./route');

// api route
server.post('/user/update', route.updateUser);
server.get('/user/get', route.getUser);

server.post('/cookie/update', route.updateCookie);
server.get('/cookie/get', route.getCookie);

可以看到引用了一個route.js文件，目前還沒有該文件，需要新建route.js來實現業務邏輯，代碼如下：

var user = require('./mongo').user;
var session = require('./redisClient').session; 

// 創建/更新user
// post的數據通過req.body傳遞
// 此處約定使用json格式，bodyParser可解析
exports.updateUser = function(req, res) {
    // 此處省略數據合法性的檢查
    let data = {
        idno: req.body.idno,
        name: req.body.name,
        gender: req.body.gender,
        phone: req.body.phone
    };

    // 設置response為utf-8編碼
    res.charSet('utf-8');   
    // 設置返回數據格式為json
    res.setHeader('Content-Type', 'application/json');
    user.insertOrUpdateByIdno(data)
        .then(function(record) {
            res.send({code: 0, msg: '創建/更新user成功', result: record});
        }, function(err) {
            console.log(err);
            res.send({code: 1, msg: '創建/更新user失敗', result: {}});
        });
};

// 查詢user
// get的參數直接在url中，queryParser可解析
exports.getUser = function(req, res) {
    let idno = req.query.idno;
    // 設置response為utf-8編碼
    res.charSet('utf-8');   
    // 設置返回數據格式為json
    res.setHeader('Content-Type', 'application/json');
    user.findByIdno(idno)
        .then(function(record) {
            res.send({code: 0, msg: 'user查詢成功', result: record});
        }, function(err) {
            console.log(err);
            res.send({code: 1, msg: 'user查詢失敗', result: {}});
        });
};

// 設置/更新Cookie
// post提交的數據，有uuid為更新，沒uuid為新建
exports.updateCookie = function(req, res) {
    let uuid = req.body.uuid ? req.body.uuid : genUuid();
    let cookie = req.body;
    delete cookie.uuid;        // 不論有沒有都是true
    res.charSet('utf-8');
    res.setHeader('Content-Type', 'application/json');
    session.updateCookie(uuid, cookie)
        .then(function(r) {
            res.send({code: 0, msg: '更新/新建Cookie成功', 
                result: {uuid: uuid, data: cookie}});
        }, function(e) {
            console.log(e);
            res.send({code: 1, msg: '更新/新建Cookie成功', result: {}});
        });
};

// 根據uuid查詢Cookie
exports.getCookie = function(req, res) {
    let uuid = req.query.uuid;
    res.charSet('utf-8');
    res.setHeader('Content-Type', 'application/json');
    session.getCookie(uuid)
        .then(function(record) {
            res.send({code: 0, msg: '獲取Cookie成功', result: record});
        }, function(err) {
            console.log(err);
            res.send({code: 1, msg: '獲取Cookie失敗', result: {}});
        });
};

function genUuid() {
    return Math.random().toString() + Math.random().toString();
}

五、接口測試

在MongoDB和Redis數據庫都運行起來的情況下，運行node app.js啟動服務器，然后使用Postman來模擬http請求。

  1. 向接口"/user/update"發送post請求
updateUser.png

ps：你可能注意到了，這里存儲的是格林威治時間。

  1. 通過接口"/user/get"查詢上述記錄
getUser.png
  1. 查看此時MongoDB的情況
MongoDB.png
  1. 向接口"/cookie/update"發送post請求
updateCookie.png
  1. 通過接口"cookie/get"查詢上述記錄
getCookie.png
  1. 此時Redis數據庫內
redis.png

六、代碼repo

本文中所有代碼均在此restify_mongoose_redis_sample

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容