繁体   English   中英

Ember.Object实例中的必需属性(构造函数args)

[英]Required properties (constructor args) in Ember.Object instances

在Ember中,假设我有一个名为FoodStuff的对象,它有一些属性:

export default Ember.Object.extend({
    name: null,     // REQUIRED: 'Slice of Apple Pie'
    calories: null, // OPTIONAL: int: eg. 250
    category: null, // REQUIRED: 'Pastry'
    rating: null    // OPTIONAL: int: 1-5
});

如何在Ember中编写“构造函数”,要求在实例化时提供“名称”和“类别”属性?

Angular似乎用相当简单的语法来解决这个问题:

.factory('User', function (Organisation) {

  /**
   * Constructor, with class name
   */
  function User(firstName, lastName, role, organisation) {
    // Public properties, assigned to the instance ('this')
    this.firstName = firstName;
    ...

具有JavaScript类的Angular模型对象

Ember有类似的东西吗? 目前我的所有类都在顶部看到,有一堆初始为null的属性,调用者可能正确设置也可能没有 在构建时(我正在使用ember-cli )我希望通过ember build阶段将构造函数需求的更改捕获到下游。

据我所知,在Ember中没有本地方法可以做到这一点。 但没有什么是不可能的! 你可以调整Ember来处理这个案子。 只需添加初始化程序:

/initialsizers/extend-ember.js

import Ember from 'ember';

export function initialize() {

  Ember.Object.reopen({

    /**
     * @prop {Array} - array of required properties
     */
    requiredAttrs: [],

    /**
     * Validates existance of required properties
     *
     * @param {String} attr - attribute name
     * @param {*} value - value of the property
     * @throws {Error} in case when required property is not set
     */
    _validateExistance(attr, value) {
      if (this.requiredAttrs.contains(attr) && typeof value === "undefined") {
        throw new Error("Attribute " + attr + " can't be empty!");
      }
    },

    /**
     * Sets value of a property and validates existance of required properties
     *
     * @override 
     */
    set(key, value) {
      this._validateExistance(key, value);
      return this._super(key, value);
    }

  });

  Ember.Object.reopenClass({

    /**
     * Creates object instance and validates existance of required properties
     *
     * @override
     */
    create(attrs) {
      let obj = this._super(attrs);
      if (attrs) {
        obj.requiredAttrs.forEach((key) => {
          obj._validateExistance(key, attrs[key]);
        });
      }
      return obj;
    }

  });

}

export default {
  name: 'extend-ember',
  initialize: initialize
};

然后,您可以在任何类上使用requiredAttrs属性来定义所需的属性。 如果您尝试创建具有空必需属性的实例,或者尝试将空值设置为required属性,则会抛出异常。

let MyModel = Ember.Object.extend({
  prop1: null,
  prop2: null,
  requiredAttrs: ['prop2']
});

let ChildModel = MyModel.extend({
  prop3: null,
  requiredAttrs: ['prop2', 'prop3']
});

// throws exception
let obj1 = MyModel.create({
  prop1: 'val1'
});

// no exception
let obj2 = MyModel.create({
  prop2: 'val2'
});

// throws exception
obj2.set('prop2', undefined);

// throws exception
let obj3 = ChildModel.create({
  prop3: 'val3'
});

// no exception
let obj4 = ChildModel.create({
  prop2: 'val2',
  prop3: 'val3'
});

它也适用于DS.ModelDS.Model其他Ember实体,因为它们都扩展了Ember.Object

要进行实例化时间(运行时)检查,您需要覆盖init方法:

init() {
    this._super();
    Ember.assert('Name cannot be empty', name);
    // ...
}

为了让他们在建设时被抓住,我不确定这样做的好方法。 您可以使用某种工具向Javascript(Typescript和Flow想到)添加静态类型,这可能会在实例化这些对象时强制执行这些属性。 您也可以编写一个自定义工具(如ESLint插件)来检查它,但这可能比它的价值更难。 您最好使用运行时解决方案和体面的测试覆盖率。


这是一个拥有自己的create()方法的例子。

SomeClass.reopenClass({
    create(name, category, calories = null, rating = null) {
        // Validate your properties
        Ember.assert('Name cannot be empty', name);
        // ...

        // Create the object
        var obj = this._super({ name, category, calories, rating });

        // Do any other setup/validation

        // Return the object
        return obj;
    }
});

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM