如何观察阵列变化?


106

在Javascript中,当使用基于推,弹出,移位或基于索引的分配修改数组时,是否有一种通知方式?我想要可以触发事件的东西。

我知道watch()SpiderMonkey 的功能,但是只有在将整个变量设置为其他变量时才能使用。

Answers:


169

有一些选择...

1.覆盖推送方法

走快速而肮脏的路线,您可以覆盖push()数组1的方法:

Object.defineProperty(myArray, "push", {
  enumerable: false, // hide from for...in
  configurable: false, // prevent further meddling...
  writable: false, // see above ^
  value: function () {
    for (var i = 0, n = this.length, l = arguments.length; i < l; i++, n++) {          
      RaiseMyEvent(this, n, this[n] = arguments[i]); // assign/raise your event
    }
    return n;
  }
});

1或者,如果要定位所有数组,则可以覆盖Array.prototype.push()。但是要小心;您环境中的其他代码可能不喜欢或期望这种修改。不过,如果所有内容听起来都很吸引人,请替换myArrayArray.prototype

现在,这只是一种方法,并且有很多方法可以更改数组内容。我们可能需要更全面的信息...

2.创建一个自定义的可观察数组

您可以创建自己的可观察数组,而不是覆盖方法。此特定实现拷贝的阵列到一个新的数组状物体并提供定制push()pop()shift()unshift()slice(),和splice()的方法以及定制索引访问器(条件是数组大小仅通过上述方法或一种修饰的length属性)。

function ObservableArray(items) {
  var _self = this,
    _array = [],
    _handlers = {
      itemadded: [],
      itemremoved: [],
      itemset: []
    };

  function defineIndexProperty(index) {
    if (!(index in _self)) {
      Object.defineProperty(_self, index, {
        configurable: true,
        enumerable: true,
        get: function() {
          return _array[index];
        },
        set: function(v) {
          _array[index] = v;
          raiseEvent({
            type: "itemset",
            index: index,
            item: v
          });
        }
      });
    }
  }

  function raiseEvent(event) {
    _handlers[event.type].forEach(function(h) {
      h.call(_self, event);
    });
  }

  Object.defineProperty(_self, "addEventListener", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function(eventName, handler) {
      eventName = ("" + eventName).toLowerCase();
      if (!(eventName in _handlers)) throw new Error("Invalid event name.");
      if (typeof handler !== "function") throw new Error("Invalid handler.");
      _handlers[eventName].push(handler);
    }
  });

  Object.defineProperty(_self, "removeEventListener", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function(eventName, handler) {
      eventName = ("" + eventName).toLowerCase();
      if (!(eventName in _handlers)) throw new Error("Invalid event name.");
      if (typeof handler !== "function") throw new Error("Invalid handler.");
      var h = _handlers[eventName];
      var ln = h.length;
      while (--ln >= 0) {
        if (h[ln] === handler) {
          h.splice(ln, 1);
        }
      }
    }
  });

  Object.defineProperty(_self, "push", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function() {
      var index;
      for (var i = 0, ln = arguments.length; i < ln; i++) {
        index = _array.length;
        _array.push(arguments[i]);
        defineIndexProperty(index);
        raiseEvent({
          type: "itemadded",
          index: index,
          item: arguments[i]
        });
      }
      return _array.length;
    }
  });

  Object.defineProperty(_self, "pop", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function() {
      if (_array.length > -1) {
        var index = _array.length - 1,
          item = _array.pop();
        delete _self[index];
        raiseEvent({
          type: "itemremoved",
          index: index,
          item: item
        });
        return item;
      }
    }
  });

  Object.defineProperty(_self, "unshift", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function() {
      for (var i = 0, ln = arguments.length; i < ln; i++) {
        _array.splice(i, 0, arguments[i]);
        defineIndexProperty(_array.length - 1);
        raiseEvent({
          type: "itemadded",
          index: i,
          item: arguments[i]
        });
      }
      for (; i < _array.length; i++) {
        raiseEvent({
          type: "itemset",
          index: i,
          item: _array[i]
        });
      }
      return _array.length;
    }
  });

  Object.defineProperty(_self, "shift", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function() {
      if (_array.length > -1) {
        var item = _array.shift();
        delete _self[_array.length];
        raiseEvent({
          type: "itemremoved",
          index: 0,
          item: item
        });
        return item;
      }
    }
  });

  Object.defineProperty(_self, "splice", {
    configurable: false,
    enumerable: false,
    writable: false,
    value: function(index, howMany /*, element1, element2, ... */ ) {
      var removed = [],
          item,
          pos;

      index = index == null ? 0 : index < 0 ? _array.length + index : index;

      howMany = howMany == null ? _array.length - index : howMany > 0 ? howMany : 0;

      while (howMany--) {
        item = _array.splice(index, 1)[0];
        removed.push(item);
        delete _self[_array.length];
        raiseEvent({
          type: "itemremoved",
          index: index + removed.length - 1,
          item: item
        });
      }

      for (var i = 2, ln = arguments.length; i < ln; i++) {
        _array.splice(index, 0, arguments[i]);
        defineIndexProperty(_array.length - 1);
        raiseEvent({
          type: "itemadded",
          index: index,
          item: arguments[i]
        });
        index++;
      }

      return removed;
    }
  });

  Object.defineProperty(_self, "length", {
    configurable: false,
    enumerable: false,
    get: function() {
      return _array.length;
    },
    set: function(value) {
      var n = Number(value);
      var length = _array.length;
      if (n % 1 === 0 && n >= 0) {        
        if (n < length) {
          _self.splice(n);
        } else if (n > length) {
          _self.push.apply(_self, new Array(n - length));
        }
      } else {
        throw new RangeError("Invalid array length");
      }
      _array.length = n;
      return value;
    }
  });

  Object.getOwnPropertyNames(Array.prototype).forEach(function(name) {
    if (!(name in _self)) {
      Object.defineProperty(_self, name, {
        configurable: false,
        enumerable: false,
        writable: false,
        value: Array.prototype[name]
      });
    }
  });

  if (items instanceof Array) {
    _self.push.apply(_self, items);
  }
}

(function testing() {

  var x = new ObservableArray(["a", "b", "c", "d"]);

  console.log("original array: %o", x.slice());

  x.addEventListener("itemadded", function(e) {
    console.log("Added %o at index %d.", e.item, e.index);
  });

  x.addEventListener("itemset", function(e) {
    console.log("Set index %d to %o.", e.index, e.item);
  });

  x.addEventListener("itemremoved", function(e) {
    console.log("Removed %o at index %d.", e.item, e.index);
  });
 
  console.log("popping and unshifting...");
  x.unshift(x.pop());

  console.log("updated array: %o", x.slice());

  console.log("reversing array...");
  console.log("updated array: %o", x.reverse().slice());

  console.log("splicing...");
  x.splice(1, 2, "x");
  console.log("setting index 2...");
  x[2] = "foo";

  console.log("setting length to 10...");
  x.length = 10;
  console.log("updated array: %o", x.slice());

  console.log("setting length to 2...");
  x.length = 2;

  console.log("extracting first element via shift()");
  x.shift();

  console.log("updated array: %o", x.slice());

})();

请参阅以供参考。Object.defineProperty()

这使我们更加接近,但仍不是防弹措施……这使我们能够:

3.代理

代理提供了另一种解决方案...允许您拦截方法调用,访问器等。最重要的是,您甚至不需要提供明确的属性名称就可以执行此操作...这将允许您测试任意的,基于索引的访问/分配。您甚至可以拦截属性删除。代理可以有效地让您决定允许更改之前检查更改...除了在事后处理更改之外。

这是一个简化的示例:

(function() {

  if (!("Proxy" in window)) {
    console.warn("Your browser doesn't support Proxies.");
    return;
  }

  // our backing array
  var array = ["a", "b", "c", "d"];

  // a proxy for our array
  var proxy = new Proxy(array, {
    apply: function(target, thisArg, argumentsList) {
      return thisArg[target].apply(this, argumentList);
    },
    deleteProperty: function(target, property) {
      console.log("Deleted %s", property);
      return true;
    },
    set: function(target, property, value, receiver) {      
      target[property] = value;
      console.log("Set %s to %o", property, value);
      return true;
    }
  });

  console.log("Set a specific index..");
  proxy[0] = "x";

  console.log("Add via push()...");
  proxy.push("z");

  console.log("Add/remove via splice()...");
  proxy.splice(1, 3, "y");

  console.log("Current state of array: %o", array);

})();


谢谢!这适用于常规数组方法。关于如何为“ arr [2] =“ foo”之类的事件引发事件的任何想法吗?
Sridatta Thatipamala 2011年

4
我想您可以set(index)在Array的原型中实现一种方法,并执行类似反精神的说法
Pablo Fernandez

8
子类化Array会更好。修改Array的原型通常不是一个好主意。
韦恩

1
这里的答案很出色。ObservableArray的类非常好。+1
dooburt

1
“'_array.length === 0 &&删除_self [index];” -您能解释一下这句话吗?
splintor

23

通过阅读这里的所有答案,我组装了一个不需要任何外部库的简化解决方案。

它还更好地说明了该方法的总体思路:

function processQ() {
   // ... this will be called on each .push
}

var myEventsQ = [];
myEventsQ.push = function() { Array.prototype.push.apply(this, arguments);  processQ();};

这是个好主意,但是您不认为如果我想在图表js数据数组中实现此功能,并且我有50个图表,这意味着50个数组,每个数组都会每秒更新->想象一下一天结束时,“ myEventsQ”数组会出现!我认为何时需要不时转移它
Yahya

2
您不了解解决方案。myEventsQ是数组(您的50个数组之一)。此代码段不会更改数组的大小,也不会添加任何其他数组,而只会更改现有数组的原型。
Sych

1
嗯,我知道,但应该提供更多解释!
Yahya

3
push返回length数组的。因此,您可以获得 Array.prototype.push.apply变量返回的值,然后从自定义push函数返回它。
adiga

12

我发现以下似乎可以完成此任务的地方:https : //github.com/mennovanslooten/Observable-Arrays

Observable-Arrays扩展了下划线,可以按以下方式使用:(从该页面开始)

// For example, take any array:
var a = ['zero', 'one', 'two', 'trhee'];

// Add a generic observer function to that array:
_.observe(a, function() {
    alert('something happened');
});

13
这很棒,但是有一个重要的警告:当像这样修改数组时arr[2] = "foo",更改通知是异步的。由于JS没有提供任何方式来监视此类更改,因此该库依赖于每250毫秒运行一次的超时,并检查该数组是否发生了更改-因此直到下一个下一个都不会收到更改通知超时运行的时间。但是,其他更改(例如)push()会立即(同步)通知。
peterflynn

6
另外,如果阵列很大,我想250个间隔会影响您的网站性能。
托马什Zato -恢复莫妮卡

刚刚使用过它,就像魅力一样。对于我们的基于节点的朋友,我将这种咒语与诺言结合使用。(注释中的格式很痛苦...)_ = require('lodash'); require(“下划线观察”)(); 承诺= require(“ bluebird”); 返回新的Promise(函数(解决,拒绝){return _.observe(queue,'delete',function(){if( .isEmpty(queue)){return resolve(action);}});});
Leif 2013年

5

我使用以下代码来监听对数组的更改。

/* @arr array you want to listen to
   @callback function that will be called on any change inside array
 */
function listenChangesinArray(arr,callback){
     // Add more methods here if you want to listen to them
    ['pop','push','reverse','shift','unshift','splice','sort'].forEach((m)=>{
        arr[m] = function(){
                     var res = Array.prototype[m].apply(arr, arguments);  // call normal behaviour
                     callback.apply(arr, arguments);  // finally call the callback supplied
                     return res;
                 }
    });
}

希望这是有用的:)


5

@canon最受推崇的Override push方法解决方案在我的情况下有一些不便之处:

  • 它使push属性描述符有所不同(writable并且configurable应设置true而不是false),这会在以后导致异常。

  • push()使用多个参数(例如myArray.push("a", "b"))调用一次时,它将多次引发事件,在我看来,这是不必要的,而且对性能不利。

因此,这是我能找到的最佳解决方案,它可以解决先前的问题,并且我认为更清晰/更简单/更容易理解。

Object.defineProperty(myArray, "push", {
    configurable: true,
    enumerable: false,
    writable: true, // Previous values based on Object.getOwnPropertyDescriptor(Array.prototype, "push")
    value: function (...args)
    {
        let result = Array.prototype.push.apply(this, args); // Original push() implementation based on https://github.com/vuejs/vue/blob/f2b476d4f4f685d84b4957e6c805740597945cde/src/core/observer/array.js and https://github.com/vuejs/vue/blob/daed1e73557d57df244ad8d46c9afff7208c9a2d/src/core/util/lang.js

        RaiseMyEvent();

        return result; // Original push() implementation
    }
});

请查看我的消息来源的注释以及有关如何实现除推之外的其他变异功能的提示:“ pop”,“ shift”,“ unshift”,“ splice”,“ sort”,“ reverse”。


@canon我确实有可用的代理,但是我不能使用它们,因为该数组是在外部修改的,而且我想不出任何方法来强制外部调用者(除了在我无法控制的情况下不时更改)使用代理。
cprcrack

@canon,顺便说一句,您的评论使我做出了错误的假设,那就是我使用的是散布运算符,而实际上却不是。因此,不,我根本没有利用传播操作员。我正在使用的rest参数具有相似的...语法,并且可以使用arguments关键字轻松替换。
cprcrack


0
if (!Array.prototype.forEach)
{
    Object.defineProperty(Array.prototype, 'forEach',
    {
        enumerable: false,
        value: function(callback)
        {
            for(var index = 0; index != this.length; index++) { callback(this[index], index, this); }
        }
    });
}

if(Object.observe)
{
    Object.defineProperty(Array.prototype, 'Observe',
    {
        set: function(callback)
        {
            Object.observe(this, function(changes)
            {
                changes.forEach(function(change)
                {
                    if(change.type == 'update') { callback(); }
                });
            });
        }
    });
}
else
{
    Object.defineProperties(Array.prototype,
    { 
        onchange: { enumerable: false, writable: true, value: function() { } },
        Observe:
        {
            set: function(callback)
            {
                Object.defineProperty(this, 'onchange', { enumerable: false, writable: true, value: callback }); 
            }
        }
    });

    var names = ['push', 'pop', 'reverse', 'shift', 'unshift'];
    names.forEach(function(name)
    {
        if(!(name in Array.prototype)) { return; }
        var pointer = Array.prototype[name];
        Array.prototype[name] = function()
        {
            pointer.apply(this, arguments); 
            this.onchange();
        }
    });
}

var a = [1, 2, 3];
a.Observe = function() { console.log("Array changed!"); };
a.push(8);

1
看起来Object.observe()Array.observe()已从规格中撤回。支持已从Chrome撤消。:/
canon 2016年

0

不知道这是否涵盖了所有内容,但是我使用了类似的方法(尤其是在调试时)来检测数组何时添加了元素:

var array = [1,2,3,4];
array = new Proxy(array, {
    set: function(target, key, value) {
        if (Number.isInteger(Number(key)) || key === 'length') {
            debugger; //or other code
        }
        target[key] = value;
        return true;
    }
});


-1

我摆弄,想出了这个。想法是该对象定义了所有Array.prototype方法,但在单独的数组对象上执行它们。这样就可以观察诸如shift(),pop()等方法。尽管诸如concat()之类的某些方法不会返回OArray对象。如果使用访问器,则重载这些方法将使该对象不可观察。为了实现后者,在给定容量内为每个索引定义了访问器。

性能明智...与纯Array对象相比,OArray的速度大约慢10-25倍。对于能力范围为1-100的差异,差异为1x-3x。

class OArray {
    constructor(capacity, observer) {

        var Obj = {};
        var Ref = []; // reference object to hold values and apply array methods

        if (!observer) observer = function noop() {};

        var propertyDescriptors = Object.getOwnPropertyDescriptors(Array.prototype);

        Object.keys(propertyDescriptors).forEach(function(property) {
            // the property will be binded to Obj, but applied on Ref!

            var descriptor = propertyDescriptors[property];
            var attributes = {
                configurable: descriptor.configurable,
                enumerable: descriptor.enumerable,
                writable: descriptor.writable,
                value: function() {
                    observer.call({});
                    return descriptor.value.apply(Ref, arguments);
                }
            };
            // exception to length
            if (property === 'length') {
                delete attributes.value;
                delete attributes.writable;
                attributes.get = function() {
                    return Ref.length
                };
                attributes.set = function(length) {
                    Ref.length = length;
                };
            }

            Object.defineProperty(Obj, property, attributes);
        });

        var indexerProperties = {};
        for (var k = 0; k < capacity; k++) {

            indexerProperties[k] = {
                configurable: true,
                get: (function() {
                    var _i = k;
                    return function() {
                        return Ref[_i];
                    }
                })(),
                set: (function() {
                    var _i = k;
                    return function(value) {
                        Ref[_i] = value;
                        observer.call({});
                        return true;
                    }
                })()
            };
        }
        Object.defineProperties(Obj, indexerProperties);

        return Obj;
    }
}

尽管它适用于现有元素,但是当添加具有array [new_index] = value的元素时不起作用。只有代理才能做到这一点。
MPM

-5

我不建议您扩展本机原型。相反,您可以使用诸如new-list之类的库。https://github.com/azer/new-list

它创建了一个本机JavaScript数组,并允许您订阅任何更改。它分批更新并给您最终的差异;

List = require('new-list')
todo = List('Buy milk', 'Take shower')

todo.pop()
todo.push('Cook Dinner')
todo.splice(0, 1, 'Buy Milk And Bread')

todo.subscribe(function(update){ // or todo.subscribe.once

  update.add
  // => { 0: 'Buy Milk And Bread', 1: 'Cook Dinner' }

  update.remove
  // => [0, 1]

})
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.