Mongoose輕鬆搞定MongoDB，不要回調！

時間 2019-12-18

標籤 mongoose 輕鬆搞定 mongodb 不要欄目 MongoDB 简体版

原文原文鏈接

MEAN開發棧中使用MongoDB的時候，與之配對的ORM最好的選擇就是Mongoose了。本文就和你們一塊兒探討一下如何使用Mongoose來實現MongoDB的增刪改查。javascript

爲了能使文中的例子更加生動，咱們會實現一個對於用戶的增刪改查的RESTful API。html

Mongoose簡介

mongoose是一個nodejs下，專門基於no-sql數據庫mongodb的ORM框架。咱們可使用mongoose輕鬆實現對於mongodb的操做。要是用mongoose首先要在項目中添加這個框架：java

$ npm install mongoose --save

注意，這裏假設你已經安裝了MongoDB。若是尚未，那麼請參考這裏下載，參考這裏安裝，並建立第一個數據庫。node

在項目中引用mongoose：web

var mongoose = require('mongoose');

鏈接到已有數據庫：sql

var url = 'mongodb://localhost/yourappdatabase';
mongoose.createConnection(url);

鏈接到數據庫後就要處理裏面的數據了。mongodb

定義一個Model

在處理增刪改查之前，咱們先看看mongoose的Model。這些Model就表明了MongoDB庫裏面的Document（MongoDB術語，至關於Sql數據庫的表），之後的增刪改查都要經過這個Model實現。數據庫

mongoose的Schema是用來定義document的屬性的。Schema中也能夠定義Methods。npm

首先定義一個model：json

var mongoose = require('mongoose');

var Schema = mongoose.Schema;

var userSchema = new Schema({
    name: String,
    username: { type: String, required: true, unique: true },
    password: { type: String, required: true },
    admin: Boolean,
    location: String,
    meta: {
    age: Number,
    website: String
    },
    created_at: Date,
    updated_at: Date
});

var User = mongoose.model('User', userSchema);

module.exports = User;

首先使用Schema定義一個userSchema，做爲以後model裏包含的字段和字段的類型使用。若是schema裏包含了其餘的對象，那麼就把這個對象定義在meta屬性內。

在mongoose的Schema裏給字段指定類型時可用的類型有：

String
Number
Date
Buffer
Boolean
Mixed
ObjectId
Array

以後用mongoose.model類建立Model。咱們還能夠在這裏作更多，好比定義一個給用戶密碼加密的方法（稍後講到）。

自定義方法

var mongoose = require('mongoose');

var Schema = mongoose.Schema;

var userSchema = new Schema({
    name: String,
    username: { type: String, required: true, unique: true },
    password: { type: String, required: true },
    admin: Boolean,
    location: String,
    meta: {
    age: Number,
    website: String
    },
    created_at: Date,
    updated_at: Date
});

// 在Schema裏添加自定義方法
userSchema.methods.capitalizeName = function () {
    this.name = this.name.toUpperCase();
    return this.name;
};

var User = mongoose.model('User', userSchema);

module.exports = User;

使用舉例

下面就看看咱們自定義的model和方法如何使用：

app.post('/new', function (req, res) {
    var newGuy = new User({
        name: req.body.name,
        username: req.body.username,
        password: req.body.password // 千萬別用這種密碼
    });

    newGuy.capitalizeName(function (err, name) {
        if (err) {
            res.send({error: err});
            return;
        }

        console.log(`name is ${name}`);
    });

    newGuy.save(function (err) {
        if (err) {
            res.send({error: err});
        } else {
            res.send({message: 'done', user: newGuy});
        }

這是在一個Http POST請求裏獲取用戶的name, username, password三個值。以後使用User來建立一個新的用戶newGuy，調用方法newGuy.capitalizeName，注意這個犯法裏有回調。最後使用save方法保存用戶數據。因爲在定義User這個model的時候指定username是惟一的，因此屢次插入操做只會保存一條數據用戶名相同的數據。

在保存之前調用的方法

咱們在model裏也定義了created_at等關於時間的屬性，這樣就知道何時doc被建立。咱們使用Schema的pre方法來保證保存之前能夠調用執行一段特定的代碼。

// 保存之前執行的代碼
userSchema.pre('save', function (next) {
    var currentDate = new Date();
    this.updated_at = currentDate;

    if (!this.created_at) {
        this.created_at = currentDate;
    }

    next();
});

如今每次save都會執行這段代碼，給model的created_at和updated_at設定時間。這也是一個hash密碼的地方。畢竟直接保存明文密碼太不該該了。

Create

用前面定義好的model：User而後new一個新的變量。調用內置的save方法就會建立一個新的user。

// create a new user
var newUser = User({
  name: 'Peter Quill',
  username: 'starlord55',
  password: 'password',
  admin: true
});

// save the user
newUser.save(function(err) {
  if (err) throw err;

  console.log('User created!');
});

讀取

讀取就是根據必定的條件把數據庫裏的user讀出來。由這個條件能夠決定咱們是讀一個，幾個仍是所有user。

讀取所有

app.get('/all', function (req, res) {
    User.find({}, function (err, users) {
        if (err) {
            res.send({message: 'error'});
            return;
        }

        res.send({message: 'done', data: users});
    });
});

請求結果：

{
    "message": "done",
    "data": [
        {
            "_id": "576bfe34137a575cf8c854cc",
            "name": "sue",
            "age": 26,
            "status": "A"
        },
        {
            "_id": "576df2960f0a5baabce7bc16",
            "name": "JACK",
            "username": "uncle_charlie",
            "password": "123456",
            "__v": 0
        }
    ]
}

查找一個

app.get('/some/:name', function (req, res) {
    var name = req.params.name;
    User.find({name: name.toUpperCase()}, function (err, user) {
        if (err) {
            res.send({message: 'error'});
            return;
        }

        res.send({message: 'done', data: user});
    });
});

使用User的name屬性的惟一約束查找一個user。由於用戶的name在數據庫中是大寫的，要匹配到用戶須要把傳過來的參數所有大寫以後使用。

用ID查找

app.get('/some/:name/:id', function (req, res) {
    var name = req.params.name;
    var userId = req.params.id;

    if (name === 'none') {
        User.findById(userId, function (err, user) {
            if (err) {
                res.send({message: 'error'});
                return;
            }

            res.send({message: 'done', data: user});
        });
    } else {
        // 略
    } 
});

查詢特定user

除了下面給出的方法之外，你能夠可使用MongoDB自己的查詢方法。

app.get('/find', function (req, res) {
    var lastDay = new Date();
    lastDay.setDate(lastDay.getDate() - 1);

    User.find({admin: false}).where('created_at').gt(lastDay).exec(function (err, users) {
        if (err) {
            res.send({message: 'error'});
            return;
        }

        res.send({message: 'done', data: users});
    });
});

找到昨天添加的非admin用戶。

更新

咱們接下來找幾個用戶出來，修改他們的某些屬性並再次存入數據庫。

app.post('/update/:name', function (req, res) {
    var name = req.params.name.toUpperCase();
    User.find({ name: name.toUpperCase() }, function (err, user) {
        if (err) {
            res.send({ message: 'error' });
            return;
        }

        var aUser = user[0];
        // 更改屬性
        // 若是是admin的所有撤銷，不是admin則指定爲admin
        aUser.admin = req.body.admin;

        // 定位爲Beijing
        aUser.location = req.body.location;

        // save
        aUser.save(function (err, data) {
            if (err) {
                res.send({ message: 'error' });
                return;
            }

            console.log(`done ${data}`);
            res.send({message: 'done', data: aUser});
        });
    });
});

查找並更新

User.findOneAndUpdate({name: name}, {username: 'mr_charlie'}, function (err, user) {
    if (err) {
        res.send({ message: 'error' });
        return;
    }

    res.send({message: 'done', data: user});
});

還可使用一個相似的方法findByIdAndUpdate，各位能夠在這裏查看詳細的介紹。

刪除

獲取一個用戶，而後刪除。

app.get('/delete/:name', function (req, res) {
    var un = req.params.name.toUpperCase();
    User.find({name: un}, function (err, user) {
        if (err) {
            res.send({ message: 'error'});
            return;
        }

        if (user.length <= 0) {
            res.send({ message: 'error', 'data': 'no such user'});
            return;
        }

        user[0].remove(function(err, data) {
            if (err) {
                res.send({ message: 'error' });
                return;
            }

            console.log(`data to remove ${data}`);
            res.send({messge: 'done', data: data});
        });
    });
});

用戶名會在get的路徑中傳入：http://localhost:4100/delete/sue。以後使用這個用戶名找到用戶名稱爲SUE的所有用戶（這時是個數組），若是這個用戶數組大於0，則刪除數組中的第一個model。最後，把刪除的用戶數據經過RESTful API發送出去。

相似的方法還有：findOneAndRemove、findByIdAndRemove。

// find the user with id 4
User.findOneAndRemove({ username: 'starlord55' }, function(err) {
  if (err) throw err;

  // we have deleted the user
  console.log('User deleted!');
});

// find the user with id 4
User.findByIdAndRemove(4, function(err) {
  if (err) throw err;

  // we have deleted the user
  console.log('User deleted!');
});

處理回調

前部分的內容都是關於如何使用mongoose處理數據的經常使用的增刪改查的方法。在其中涉及到了不少的回調。好比查找以後更新這一部分，首先要查找，在回調中得知成功以後調用更新，更新回調顯示成功以後把數據發回客戶端。在以上步驟中任意一步出錯則發送錯誤數據。

User.find({ name: name.toUpperCase() }, function (err, user) {
    // 1. 查找之後的回調
    if (err) {
        res.send({ message: 'error' });
        return;
    }
    
    // 修改數據

    // save
    aUser.save(function (err, data) {
        // 更新的回調
        if (err) {
            res.send({ message: 'error' });
            return;
        }
        // 更新成功
        console.log(`done ${data}`);
        res.send({ message: 'done', data: aUser });
    });
});

查找並更新的兩個回調。

下面就來說解如何消除回調。這樣的神器叫作bluebird。bluebird使用了一種叫作Promise的工具，能夠經過then方法依次的分解回調的代碼。

安裝bluebird。

npm install bluebird

在引入的mongoose裏設置這個bluebird。

app.post('/asyncupdate/:name', function (req, res) {
    var name = req.params.name.toUpperCase();
    User.find({ name: name.toUpperCase() }).exec().then(function (users) {
        if (users.length <= 0) {
            throw new Error('no such user');
        }

        var aUser = users[0];
        // 更改屬性
        // 若是是admin的所有撤銷，不是admin則指定爲admin
        aUser.admin = req.body.admin;

        // 定位爲Beijing
        aUser.location = req.body.location;

        return aUser.save();
    }).then(function (user) {
        console.log('updated user: ' + user.name);
        res.send({message: 'done', data: user});
    }).catch(function (err) {
        console.log('err ' + err);
        res.send({ message: 'error' });
    });
});

和上面的使用回調的查找-更新比較一下，使用Promise之後代碼不只容易讀，並且之後也會更加容易維護。固然，Promise能作的絕對不只是這樣寫。有興趣的同窗能夠到bluebird官網查看他們的文檔。