JavaScript defineProperty如何實現屬性劫持

Posted on by

前言

defineProperty是vue實現數據劫持的核心，本文一點點的說明defineProperty怎麼實現屬性劫持的。

其實我們一般的操作對象屬性的方式，增加或者修改屬性，均可以使用Object.defineProperty。

let obj = {};
// 尋常操作：增加/修改 新屬性
obj.a = 1;
// 等同於：
Object.defineProperty(o, "a", {
  value: 1,
  writable: true,
  configurable: true,
  enumerable: true
});

當然尋常的例子，我們是不會這麼玩的，太囉嗦瞭。

但defineProperty可以更精確地添加或修改對象的屬性。

描述符

先說個專有名詞：描述符。

其實就是defineProperty的第三個參數，是個對象。這個對象的有以下屬性：

  • configurable 屬性：能不能修改描述符，就是能不能再次修改描述符的其他屬性
  • enumerable 屬性：能不能枚舉該屬性，就是 a 屬性能不能被 for 到
  • writable 屬性：能不能修改屬性值，就是能不能這樣修改obj.a = 1
  • value 屬性：該屬性的值
  • get 屬性：是個函數，當訪問該屬性的時候，函數自動調用，函數返回值就是該屬性的值
  • set 屬性：是個函數，當修改該屬性的時候，函數自動調用，函數有且隻有一個參數，賦值的新值

註意！！！

  • 描述符裡的value屬性 writable屬性 與 get屬性 set屬性是互斥的關系，隻能存在一個
  • 另外的屬性默認值都是false，不想false的話，記得配置哈，不細說（主要我也不怎麼用）。

細說get 和 set

  • get 屬性：是個函數，當訪問該屬性的時候，函數自動調用，函數返回值就是該屬性的值
  • set 屬性：是個函數，當修改該屬性的時候，函數自動調用，函數有且隻有一個參數，賦值的新值

默念三遍，背誦。

寫個get 和 set 的例子輔助理解。

這個例子必須掌握，弄懂之後基本就掌握瞭數據劫持的精髓瞭

let obj = {};

let value = 1;
Object.defineProperty(obj, "b", {
  get() {
    console.log("讀取b屬性", value);
    return value;
  },
  set(newValue) {
    console.log("設置b屬性", newValue);
    value = newValue;
  }
});
// 觸發get函數，get的返回值就是屬性值
// 1
console.log(obj.b);
// 觸發set函數，value的值變成瞭2，註意！！！，此時內存裡，屬性值並沒有改變
obj.b = 2;
// 但是，想要讀取屬性值的時候，就必然會觸發get函數，屬性值也自然就改變瞭，這個思想真的很贊
console.log(obj.b);

這裡有個坑：get裡是不能有讀取的操作，不然一直死循環，所以使用到get set的地方，總需要借助一個變量

所以，這裡，變量value的值就是屬性的值，如果想要修改屬性，修改 value 的值即可。

這個例子弄懂瞭，get，set 的精髓，我覺得也就差不多瞭。

劫持對象的某個屬性

有瞭剛剛例子的基礎，試著寫寫劫持對象的任意一個屬性。

function observeKey(obj, key) {
  let value = obj[key];
  Object.defineProperty(obj, key, {
    get() {
      console.log("讀取屬性", value);
      return value;
    },
    set(newValue) {
      console.log("設置屬性", newValue);
      value = newValue;
    }
  });
}
let obj = { a: 1 };
observeKey(obj, "a");
// 讀取a，觸發get函數
console.log(obj.a);
// 設置a，觸發set函數
obj.a = 1;

劫持對象的所有屬性

再試試劫持對象的所有屬性

其實就是遍歷：

function observeObj(obj) {
  for (let key in obj) {
    // 直接使用 obj.hasOwnProperty會提示不規范
    if (Object.prototype.hasOwnProperty.call(obj, key)) {
      observeKey(obj, key);
    }
  }
  return obj;
}
function observeKey(obj, key) {
  let value = obj[key];
  Object.defineProperty(obj, key, {
    get() {
      console.log("讀取屬性", value);
      return value;
    },
    set(newValue) {
      console.log("設置屬性", newValue);
      value = newValue;
    }
  });
}

let obj = { a: 1, b: 2 };
observeObj(obj);
console.log(obj);
// 讀取a，觸發get函數
console.log(obj.a);
// 設置a，觸發set函數
obj.a = 1;

劫持對象的所有屬性 – 包括對象類型的屬性值

上面的有個缺陷，就是當屬性值也是對象的時候，不能劫持屬性值，如{a:1,c:{b:1}}

簡單，遞歸，補上就行。

function observeObj(obj) {
  // 加上參數限制，必須是對象才有劫持，也是遞歸的終止條件
  if (typeof obj !== "object" || obj == null) {
    return;
  }
  for (let key in obj) {
    // 直接使用 obj.hasOwnProperty會提示不規范
    if (Object.prototype.hasOwnProperty.call(obj, key)) {
      observeKey(obj, key);
      // 這裡劫持該屬性的屬性值，如果不是對象直接返回，不影響
      observeObj(obj[key]);
    }
  }
  return obj;
}
function observeKey(obj, key) {
  let value = obj[key];
  Object.defineProperty(obj, key, {
    get() {
      console.log("讀取屬性", value);
      return value;
    },
    set(newValue) {
      console.log("設置屬性", newValue);
      value = newValue;
    }
  });
}

let obj = { a: 1, b: 2, c: { name: "c" } };
observeObj(obj);
console.log(obj);
// 讀取a，觸發get函數
console.log(obj.a);
// 設置a，觸發set函數
obj.a = 1;
// 觸發set函數
obj.c.name = "d";

註意，observeObj這個函數，不能劫持對象的新增屬性，隻能劫持對象已有的屬性。

defineProperty的缺陷

  • 不能監測對象增加屬性
  • 不能監測對象刪除屬性
  • 不能劫持數組的修改

當然數組的修改可以通過別的方式監測到的，其是通過劫持改變數組方法實現的。

以上缺陷，也是vue裡面為啥有$set/$delete以及對數組隻能使用特定方法才能檢測到。

let obj = { a: 1, b: [1, 2] };
observeObj(obj);
// 新增屬性
obj.c = 3;
// 不會觸發get函數
console.log(obj.c);
// 不會觸發set函數
obj.b.push(3);

defineProperty還可以掛載屬性

其實就是訪問options.data.name 可以簡寫成 options.name，專業話術，將data上的屬性掛載到options上

相當於，用defineProperty，在options上增加新屬性：

// 先掛載單個屬性
// options.data相當於source options相當於target
function proxyKey(target, source, key) {
  Object.defineProperty(target, key, {
    // 這裡的source[key]相當於變量value，所以說最簡單的那個例子是核心
    get() {
      return source[key];
    },
    set(newValue) {
      if (newValue === source[key]) {
        return;
      }
      source[key] = newValue;
    }
  });
}
// 遍歷屬性，掛載下
function proxyObj(target, source) {
  for (let key in source) {
    // 直接使用 obj.hasOwnProperty會提示不規范
    if (Object.prototype.hasOwnProperty.call(source, key)) {
      proxyKey(target, source, key);
    }
  }
}
let options = {
  data: { name: 1 }
};
proxyObj(options, options.data);
// 1
console.log(options.name);

話說，vue的屬性劫持和掛載屬性，核心原理差不多就是上面這些。

defineProperty還能寫日志

比如 obj 有個屬性，此屬性值經常變化，想要記錄其所有變化的值，以此可以形成日志。

let obj = { a: 1 };

let log = [obj.a];

let value = obj.a;
Object.defineProperty(obj, "a", {
  get() {
    return value;
  },
  set(newValue) {
    if (newValue === value) {
      return;
    }
    value = newValue;
    log.push(newValue);
  }
});

obj.a = 2;
obj.a = 3;
obj.a = 4;
// [1,2,3,4]
console.log(log);

通用的可以抽離出一個類，專門記錄某個值的變化

class Archiver {
  constructor() {
    let value = null;
    this.archive = [];
    Object.defineProperty(this, "a", {
      get() {
        return value;
      },
      set(newValue) {
        if (newValue === value) {
          return;
        }
        value = newValue;
        this.archive.push(newValue);
      }
    });
  }
}
let archiver = new Archiver();
archiver.a = 1;
archiver.a = 2;
// [1,2]
console.log(archiver.archive);

引用

MDN的defineProperty

總結

到此這篇關於JavaScript defineProperty如何實現屬性劫持的文章就介紹到這瞭,更多相關defineProperty屬性劫持內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：