通俗易懂的JS之Proxy

kongsam發表於2021-05-21
JS

與掘金文章同步，地址：https://juejin.cn/post/6964398933229436935

什麼是代理模式

引入一個現實生活中的案例

我們作為使用者需要去如何評估一個房子的好壞、如何辦理住房手續等一些列繁瑣的事物嗎？顯然，使用者肯定不願意這樣做。使用者最關心的是結果，使用者對房子提出需求以及提供對等價值的金錢就可以獲得滿意的房子，這就是結果。

那麼誰為使用者去解決一系列繁瑣的買房過程呢？當然就是“房屋中介”了！房屋中介的作用就是在房地產開發經營與消費的供求市場中，為交易物體提供評估、交易、代理、諮詢等服務及善後服務的機構。

結合案例理解代理模式的定義

代理模式為其他物件提供一種代理以控制對這個物件的訪問。在某些情況下，一個物件不適合或者不能直接引用另一個物件，而代理物件可以在客戶端和目標物件之間起到中介的作用。

結合上邊的現實生活中的案例來理解這一段話，代理模式就是為其他使用者提供一種代理，不讓使用者知道買房的過程，而使用者應該關心的是如何獲得滿意的結果。代理所需要做的事情就是完成這一買房的過程。

什麼是Proxy

Proxy用於修改某些操作的預設行為，在目標物件前架設一個“攔截”層，外界對該物件的訪問都必須先通過這一層攔截，因此提供了一種機制可以對外界的訪問進行過濾和改寫。——《ES6標準入門》- 第12章

Proxy支援的攔截操作有get(target, propKey, receiver)和set(target, propKey, value, receiver)，對於可以設定但沒有設定攔截的操作，則直接落在目標物件上，按照原先的方式產生結果。

  1. get例項方法：攔截物件屬性的讀取；
  2. set例項方法：攔截物件屬性的設定。

get(target, propKey, receiver)

定義一個person物件

var person = {
    name: "kongsam",
    age: 21,
    hobbies: [
        "看動漫",
        "騎行",
        "玩遊戲"
    ]
}

現在例項化一個Proxy物件，來攔截外界對person的操作

var proxy = new Proxy(person, {
    get: function (target, property) {
          // 列印target和property，檢視裡面到底是什麼。
          console.log("target = ", target);
          console.log("property = ", property);
          // 判斷外界訪問的物件屬性是否存在於目標物件中。
          if (property in target) {
                return target[property];
          } else {
                // 如果外界訪問的物件屬性不存在與目標物件中，丟擲異常。
                throw new ReferenceError('Property "' + property + '" 不存在。');
          }
    },
});

當我proxy.name時，由於person物件已經被該代理物件給代理了，並且該代理物件為person物件設定了一層攔截，就是所謂的攔截層，所以每當我通過該代理物件訪問person中存在的屬性時，都會呼叫get函式，因為get函式是攔截物件屬性的讀取的。

get: function (target, property) 中的兩個引數target和property分別接收到的資訊如圖所示

image.png

上面說到，通過該代理物件訪問person中存在的屬性時，如果訪問不存在的屬性，會發生什麼？

image.png

我又是做了什麼樣的工作，才導致訪問不存在的屬性時，它會丟擲異常呢？

因為外界對該物件的訪問都必須先通過一層攔截，而攔截的過程中提供了一種機制可以對外界的訪問進行過濾和改寫。

// 判斷外界訪問的物件屬性是否存在於目標物件中。
if (property in target) {
    return target[property];
} else {
    // 如果外界訪問的物件屬性不存在與目標物件中，丟擲異常。
    throw new ReferenceError('Property "' + property + '" 不存在。');
}

這裡的if語句判斷實際上就是我設定的一個機制，即對外界的訪問進行過濾和改寫。如果沒有這種機制，訪問不存在的屬性只會返回undefined。

image.png

set(target, propKey, value, receiver)

有get就有對應的set，依舊是上面的person物件，這時我有個新需求，即修改age屬性時，值不能超過150且是整數。

新增proxy物件中的set方法

var proxy = new Proxy(person, {
    set: function (target, property, value) {
          // 列印target、property和value，檢視裡面到底是什麼。
          console.log("target = ", target);
          console.log("property = ", property);
          console.log("value = ", value);
          if (property === "age") {
                if (!Number.isInteger(value)) {
                  throw new TypeError("age的值不是整數！");
                }
                if (value > 150) {
                  throw new RangeError("age的值不能大於150！");
                }
          }
    },
});

當我執行proxy.age = 100時，set的三個引數分別接收到的資訊如下圖所示

image.png

set方法的作用是用於攔截某個屬性的賦值操作，那麼我如果對age的賦值操作不滿足我剛剛提出的新需求，會發生什麼？

image.png

很明顯，會丟擲異常。

總結

Proxy 就是一個攔截層，你給出要代理的物件，外界訪問這個物件不是直接訪問他的，而是訪問這個Proxy的例項物件的。我們可以通過Proxy為外界訪問進行過濾和改寫，如賦值時需滿足某些條件。

代理物件中還有許多的方法，如has、deleteProperty、ownKeys、getOwnPropertyDescriptor、defineProperty等等。這些都是用於攔截的方法，針對於不同的情況而出現的。

相關文章