bearcat 对 javaScript model 的统一抽象

作者：倪震洋

bearcat model

model 代表着系统中的一些数据，也就是一些javaScript对象，对这些数据还可以有操作，比如校验、数据处理、序列化、持久化等 。所有的这些操作，在 bearcat model，统一的抽象成 constraint 和 filter。（在即将更新的 bearcat-dao 0.2 版本里面还可以看到 model 在数据库 O/R mapping 里面的抽象） 

一个简单的 model 可以是这样的： 

var SimpleModel = function() {
    this.$mid = "simpleModel";
    this.num1 = 0;
}

module.exports = SimpleModel;

就是一个简单javaScript对象，然后通过一个 $mid 属性来指明该model的唯一id，通过这个id，我们可以通过 bearcat.getModel 方法来获取这个 model 实例 

var simpleModel = bearcat.getModel('simpleModel');

获取实例之后我们可以对这个model进行简单的 set/get 操作 

simpleModel.$set('num1', 10);
var num1 = simpleModel.$get('num1'); // num1 === 10

也可以对model进行pack操作 

simpleModel.$pack({
    'num1': 5
});
num1 = simpleModel.$get('num1'); // num1 === 5

对model属性，还可以通过定义来添加约束、配置，比如添加type的约束 

this.num2 = "$type:Number";

这个之后，num2 属性则必须是 Number 类型，添加其它类型则会返回一个 Error 对象 

var r = simpleModel.$set('num2', 'aaa');
if (r) {
    console.log(r.stack);
}

你也可以对属性添加 default 值 

this.num3 = "$type:Number;default:20";

var num3 = simpleModel.$get('num3'); // num3 === 20

model filter

对于model的数据处理、校验其实都可以抽象为对model的 before filter 与 after filter 

比如你可以添加一个 checkNum 的 before filter，来对 num 属性进行校验 

var FilterModel = function() {
    this.$mid = "filterModel";
    this.num = 0;
}

FilterModel.prototype.checkNum = function(key, value) {
    if (typeof value !== 'number') {
        return new Error('num must be number');
    }

    if (value > 10) {
        return new Error('num must be small than 10');
    }
}

module.exports = FilterModel;

var filterModel = bearcat.getModel('filterModel');
var r = filterModel.$before('checkNum').$set('num', 5); // ok

r = filterModel.$before('checkNum').$set('num', 'aaa'); // error with the checkNum validation, r is the Error object
if(r) {
    console.log(r.stack);
}

r = filterModel.$before('checkNum').$set('num', 20);
if (r) {
    console.log(r.stack);
}

这里通过 $before api 来指定了 before filter

num 属性就限定必须是Number类型，且值要 <=10 

对于after filer，可以添加一个数据处理的方法，用于对数据的后期处理，比如序列化、加密 

var FilterModel = function() {
    this.$mid = "filterModel";
    this.num = 0;
}

FilterModel.prototype.checkNum = function(key, value) {
    if (typeof value !== 'number') {
        return new Error('num must be number');
    }

    if (value > 10) {
        return new Error('num must be small than 10');
    }
}

FilterModel.prototype.transformNum = function() {
    this.num = 12345;
}

module.exports = FilterModel;

var filterModel = bearcat.getModel('modelId');
filterModel.$after('transformNum').$set('num', 3); // set num to 10, with the after filter transformNum
var num = filterModel.$get('num'); // the num is now 12345

num 值经过after filter的 transformNum 方法之后就变成了 12345

model constraint

约束描述了对model里的属性的规范、要求。然而，由于javaScript本身的动态性，属性在定义的时候是没有类型的，也就更不必提定义属性的约束了。开发者要实现约束，就必须实现一个validate方法，然后在需要约束的地方调用该方法来限定属性的约束。这个validate方法的粒度、复用性就成为了问题，而且属性的约束只有被validate方法调用到了才知道是怎样约束的，也不便于后期的维护。 

描述总是优于硬编码，这是 bearcat constraint 设计的一个原则。

通过对属性进行一定的描述来进行规范，这里的描述就是约束，而约束是可以相互组合、叠加的、也可以带有参数来更好的复用 

同样的，定义一个约束，就像定义一个对象 

notNullConstraint.js 

var Util = require('util');

var NotNullConstraint = function() {
    this.$cid = "myNotNull";
    this.message = "%s must be not null for value %s";
}

NotNullConstraint.prototype.validate = function(key, value) {
    var message = this.message;
    if (value === null || typeof value === 'undefined') {
        return new Error(Util.format(message, key, value));
    }
}

module.exports = NotNullConstraint;

我们这里定义了一个 notNull 的约束，通过 $cid 属性定义了id 为 myNotNull，在该对象里，我们实现了 validate 接口，该接口以model属性的key、value做为参数 

要在model里面使用这个约束也非常简单，只需要在需要添加约束的属性value里面，加入这个约束的id即可 

var ConstaintModel = function() {
    this.$mid = "constaintModel";
    this.num1 = "$myNotNull";    
}

module.exports = ConstaintModel;

这个model，我们有一个num1属性，该属性的约束是 myNotNull 

var constaintModel = bearcat.getModel('constaintModel');
var r = constaintModel.$set("num1"); // the Error object
if(r) {
    console.log(r.stack);
}

然后我们拿到model，往 num1 属性 set 一个值，就触发了 myNotNull 这个约束 

这样，约束可以自由的添加到需要的model属性里面，约束的触发完全由 bearcat 来管理

constraint 组合

约束是可以通过组合成为high level约束的，也即高阶约束 

通过约束的组合可以带来如下好处：

• 避免对简单约束的重复定义、组合、使用
• 把简单约束抽象成基础约束来进行复用

比如，我们可以定义下面的这个组合约束 

sizeConstraint.js 

var SizeConstraint = function() {
    this.$cid = "mySize";
    this.$constraint = "$myNotNull";
    this.message = "key %s value %s length over max %d";
    this.max = null;
}

SizeConstraint.prototype.validate = function(key, value) {
    var message = this.message;
    var maxLen = this.max;
    if (maxLen === null) {
        return;
    }

    if (value && value.length > maxLen) {
        return new Error(Util.format(message, key, value, maxLen));
    }
}

module.exports = SizeConstraint;

通过 this.constraint="myNotNull"; 属性，我们添加了 myNotNull 这个基础约束进来，当该约束触发的时候，首先会触发基础约束也即 myNotNull，然后触发自己的 validate 接口所定义的约束 

当然，这个例子的基础约束就一个，也可以添加其它基础约束，只需要依次添加约束id，并且以 ; 分隔即可 

this.$constraint = "$myNotNull;myType"

要使用这个约束，简单的把 mySize 添加到需要约束的model属性即可 

constraintModel.js 

var ConstaintModel = function() {
    this.$mid = "constaintModel";
    this.num = "$mySize";
}

module.exports = ConstaintModel;

r = constaintModel.$set("num2"); // the Error object
if (r) {
    console.log(r.stack);
}

constraint 参数

约束可以带有参数，这样就可以把约束进行函数似的抽象，更好的复用 

比如，上面的 mySize 约束例子中，mySize 约束其实是带了一个参数 max 

var ConstaintModel = function() {
    this.$mid = "constaintModel";
    this.num1 = "$myNotNull";
    this.num2 = "$mySize";
    this.value = "$mySize(max=5)";
}

module.exports = ConstaintModel;

因此，我们可以在model属性列中，除了添加 mySize 约束外，还可以指定 约束参数 max 的值，比如 max = 5，限定 value 属性的长度不能大于5 

constaintModel.$set("value", "aaa"); // ok

var value = constaintModel.$get("value");
console.log(value);

r = constaintModel.$set("value", "aaaaaa"); // the Error object

if (r) {
    console.log(r.stack);
}

更多关于 bearcat model 请参见官方文档 bearcat model

网易云产品免费体验馆，无套路试用，零成本体验云计算价值。  

本文来自网易实践者社区，经作者倪震洋授权发布