【sequelizejs实战】sequelizejs -DataTypes 添加OBJECTID类型

为什么80%的码农都做不了架构师？>>>   

#sequelizejs -DataTypes 添加OBJECTID类型

##概述

在数据库的主键的编码上，sequelizejs支持自增和uuid等方式，但这些主键的定义都各有优缺点，在使用过MongoDB之后，十分欣赏mongoDB的ObjectId生成的方式，以此作为主键对于分布式的应用更加友好，因此将sequelizejs 拓展，进行支持objectID。

##引入BSON

在项目中引入BSON，建议在sequelizejs目录中进行安装。

npm install BSON -save

BSON 安装后会即时编译。因此需要提前安装编译所需的环境。

##拓展DataTypes

在data-type.js中添加代码：

/**
 * A column storing a OBJECTID univeral identifier.
 * @property OBJECTID
 */
var OBJECTID = function() {
  if (!(this instanceof OBJECTID)) return new OBJECTID();
  ABSTRACT.apply(this, arguments);
};
util.inherits(OBJECTID, ABSTRACT);

OBJECTID.prototype.key = OBJECTID.key = 'OBJECTID';

【更新2016-2-14】

最新版本更新,后在此处设置toSql方法,继续添加如下代码：

OBJECTID.prototype.toSql = function() {
  return 'VARCHAR(24) BINARY';
};

设置模块接口：

module.exports = {
   ....
  OBJECTID:OBJECTID,
  ....
};

设置数据类型默认值

在utils.js中引入Bson模块：

  var Bson=require('bson');

在utils.js中修改toDefaultValue方法：

  if (typeof value === 'function') {
      var tmp = value();
      if (tmp instanceof DataTypes.ABSTRACT) {
        return tmp.toSql();
      } else {
        return tmp;
      }
    } else if (value instanceof DataTypes.UUIDV1) {
      return uuid.v1();
    } else if (value instanceof DataTypes.UUIDV4) {
      return uuid.v4();
    } else if (value instanceof DataTypes.NOW) {
      return Utils.now();
    } else if (value instanceof DataTypes.OBJECTID) {
      return Bson.ObjectID().toString();
    } else {
      return value;
    }

同时将OBJECTID作为默认值时候不设置数据库的默认值，更改utils.js的defaultValueSchemable方法：

  /**
   * Determine if the default value provided exists and can be described
   * in a db schema using the DEFAULT directive.
   *
   * @param  {*} value Any default value.
   * @return {boolean} yes / no.
   */
  defaultValueSchemable: function(value) {
    if (typeof value === 'undefined') { return false; }

    // TODO this will be schemable when all supported db
    // have been normalized for this case
    if (value instanceof DataTypes.NOW) { return false; }

    if (value instanceof DataTypes.UUIDV1 ||
      value instanceof DataTypes.UUIDV4||
      value instanceof DataTypes.OBJECTID) { return false; }

    if (lodash.isFunction(value)) {
      return false;
    }

    return true;
  },

在model.js中更新model定义时的refreshAttributes方法，约776行的 *definition.defaultValue === DataTypes.UUIDV4 * 后添加或条件：

  ||definition.defaultValue === DataTypes.OBJECTID 

【更新2016-2-14】

最新版本更新后不在model.js中进行设置refreshAttributes，更改为在sequelize.js中进行设置， 在Sequelize.prototype.normalizeAttribute 方法内更改为：

if (attribute.hasOwnProperty('defaultValue')) {
    if (typeof attribute.defaultValue === 'function' && (
        attribute.defaultValue === DataTypes.NOW ||
        attribute.defaultValue === DataTypes.UUIDV1 ||
        attribute.defaultValue === DataTypes.UUIDV4 ||
        attribute.defaultValue === DataTypes.OBJECTID
    )) {
      attribute.defaultValue = new attribute.defaultValue();
    }

mysql中添加OBJECTID的默认类型

在 lib/dialects/mysql.js中的UUID.prototype.toSql的定义后添加：

UUID.prototype.toSql = function() {
  return 'CHAR(36) BINARY';
};

var OBJECTID = function() {
  if (!(this instanceof OBJECTID)) return new OBJECTID();
  BaseTypes.OBJECTID.apply(this, arguments);
};
util.inherits(OBJECTID, BaseTypes.OBJECTID);

OBJECTID.prototype.toSql = function() {
  return 'VARCHAR(24) BINARY';
};

修改module.exports为：

module.exports = {
  UUID: UUID,
  OBJECTID:OBJECTID
};

【更新2016-2-14】

最新版本更新后无需设置toSql方法，无需以上设置。但需要设置默认的对应的数据类型。 在lib/dialects/mysql/data-type.js 的23行左右添加：

BaseTypes.OBJECTID.types.mysql = ['VAR_STRING'];

同时在lib/dialects/mssql/data-type.js、lib/dialects/sqlite/data-type.js中进行相应的设置，可应用于mssql和sqlite中。

##使用

定义的数据模型的时候，指定type为DataTypes.STRING，设置defaultValue为DataTypes.OBJECTID,插入数据库时候会将默认值生成OBJECTID格式的字符串；

module.exports = function(sequelize, DataTypes) {
  var User = sequelize.define("User", {
    id:{
      type: DataTypes.OBJECTID,
      defaultValue: DataTypes.OBJECTID,
      primaryKey: true, // 定义主键
      comment: "OBJECTID主键"
    },
    name: {
    	type:DataTypes.STRING, //字符串，默认长度 255,
      comment: "用户姓名"
    },
    account: {
      type:DataTypes.STRING,
       validate: {
        isEmail: {
          msg: "用户账号必须是邮箱！"
        },
      },
      comment: "用户账号，使用邮箱注册"
    },
    pwd: {
      type:DataTypes.STRING,
      comment: "用户密码，使用MD5"
    }
  );

  return User;
};

转载于:https://my.oschina.net/xqx/blog/403943