Sequelize 使用

sequelize.png

说起ORM，Object Relational Mapping，有Hibernate，JPA等成熟的Java框架。 Sequelize是JS端的hibernate，可以和十分著名的Express js server一起使用，完成server端到数据库的CRUD等等操作。

Promise based, Sequelize和Hibernate最大的区别在于，它的调用基于bluebird的异步调用引擎，我们知道，在Javascript的世界里，很多调用是通过Callback函数来完成的而并非是顺序执行的，使用Sequelize，我们也要注意这一点。

从模型说起

Promise要把Javascript Object转换成数据库的一行，首先，它需要知道数据库表结构，当然，Sequelize主要是支持Postgres, Mysql之类的关系型数据库。

npm install -g sequelize-auto
sequelize-auto -h 127.0.0.1 -d ocsp -u root -x 123 -p 3306 ---dialect mysql -o "./server/models/"

sequelize-auto是一个帮助我们快速生成表结构的工具，上面给出了一个通过连接mysql生成数据库表结构代码的例子。

/* jshint indent: 2 */
"use strict";
module.exports = function(sequelize, DataTypes) {
  return sequelize.define('STREAM_EVENT', {
    id: {
      type: DataTypes.INTEGER(16),
      allowNull: false,
      primaryKey: true,
      autoIncrement: true
    },
    name: {
      type: DataTypes.STRING,
      allowNull: false
   }, {
    createdAt: false,
    updatedAt: false,
    tableName: 'STREAM_EVENT'
  });
};

首先生成的代码没有使用"use strict";，如果是需要运行在严格模式下，需要自己添加。其次，createdAt和updateAt要写成false，默认true需要数据库表里面有这两个字段。

错误处理

Javascript Promise的错误处理有让人迷糊的地方。

p.then(onFulfilled, onRejected);

p.then(function(value) {
   // fulfillment
  }, function(reason) {
  // rejection
});

p.catch(onRejected);

p.catch(function(reason) {
   // 拒绝
});

首先是ES6里面Promise的then提供两个参数，分别是success和error的两个callback函数，另外，Promise提供catch方法，用来处理error的情况，所以从某种角度上说，第二个callback函数的作用和catch是一样的。

Tips: 在这里，我们推荐使用catch函数，因为catch返回的还是一个Promise，这对于Promise chain的调用很有好处，例如官方给出了以下例子。可以看出，catch后面还有then。

Warning：在最新版本的Angular里面，已经彻底删除了Promise的success和error方法，因为对Promise chain的传递有影响，一般then(function(item){})这里面的item，要再次解析，例如包装在item.data里面，而在success中则直接是data的值，这对于Promise chain有混淆，所以success被废弃了，这里不推荐使用。

var p1 = new Promise(function(resolve, reject) {
  resolve('Success');
});

p1.then(function(value) {
  console.log(value); // "成功!"
  throw 'oh, no!';
}).catch(function(e) {
  console.log(e); // "oh, no!"
}).then(function(){
  console.log('after a catch the chain is restored');
}, function () {
  console.log('Not fired due to the catch');
});

// 以下行为与上述相同
p1.then(function(value) {
  console.log(value); // "成功!"
  return Promise.reject('oh, no!');
}).catch(function(e) {
  console.log(e); // "oh, no!"
}).then(function(){
  console.log('after a catch the chain is restored');
}, function () {
  console.log('Not fired due to the catch');
});

使用事务

sequelize的事务处理非常强大。以下给出一个transaction使用的例子，注意在transaction里面使用的return函数来返回promise的方式，用来保证sequelize执行同步。

sequelize.transaction(function(t) {
    return EventDef.find({where: {id: req.params.id}, transaction: t}).then(function (event) {
      let result = event.dataValues;
      if(result.status === status){
        return sequelize.Promise.reject();
      }
      if(result.owner !== username){
        return sequelize.Promise.reject();
      }
      result.status = status;
      return EventDef.update(result, {where: {id: req.params.id}, transaction: t});
    });
  }).then(function(){
    res.send({success: true});
  }).catch(function (e) {
    console.log(e);
    res.status(500).send(trans.databaseError);
  });

使用关联关系

Sequelize中使用include hook可以方便的进行表关联。

let EventDef = require('../model/STREAM_EVENT')(sequelize, Sequelize);
let CEP = require('../model/STREAM_EVENT_CEP')(sequelize, Sequelize);
EventDef.hasOne(CEP, {foreignKey:'event_id', targetKey:'id'});

EventDef.find({
      where:{
        id: req.params.id
      },
      include: {
        model: CEP
      }
    }).then(function(event){
      res.send(event);
    }, function(){
      res.status(500).send(trans.databaseError);
    });

Warning： 一般我们使用sequelize都是在express router里面，注意的是在一个router里面，只能有一个response，由于sequelize是异步的，注意是否进行了多次返回。

router.put('/:id', function(req, res){
  let event = req.body.event;
  EventDef.find({attributes: ["owner"], where: {id: event.id}}).then((owner)=> {
     res.send({success: true});
  });
  //res.send()，这里不能出现，注意

小结

Sequelize是一个非常优秀的ORM工具，了解Promise的运行机制，注意它的异步性，就能利用好它做数据库操作了。