Proxy

Das Proxy-Objekt erlaubt es, ein Objekt zu erstellen, das anstelle des Originalobjekts verwendet werden kann, aber grundlegende Object-Operationen wie das Abrufen, Setzen und Definieren von Eigenschaften neu definieren kann. Proxy-Objekte werden häufig verwendet, um Zugriffe auf Eigenschaften zu protokollieren, Eingaben zu validieren, zu formatieren oder zu bereinigen usw.

Ein Proxy wird mit zwei Parametern erstellt:

• target: das ursprüngliche Objekt, das Sie proxen möchten
• handler: ein Objekt, das definiert, welche Operationen abgefangen werden und wie die abgefangenen Operationen neu definiert werden.

Zum Beispiel erzeugt dieser Code einen Proxy für das target-Objekt.

const target = {
  message1: "hello",
  message2: "everyone",
};

const handler1 = {};

const proxy1 = new Proxy(target, handler1);

Da der Handler leer ist, verhält sich dieser Proxy genauso wie das ursprüngliche Ziel:

console.log(proxy1.message1); // hello
console.log(proxy1.message2); // everyone

Um den Proxy anzupassen, definieren wir Funktionen auf dem Handler-Objekt:

const target = {
  message1: "hello",
  message2: "everyone",
};

const handler2 = {
  get(target, prop, receiver) {
    return "world";
  },
};

const proxy2 = new Proxy(target, handler2);

Hier haben wir eine Implementierung des get()-Handlers bereitgestellt, der Versuche, Eigenschaften im Ziel aufzurufen, abfängt.

Handler-Funktionen werden manchmal als Traps bezeichnet, vermutlich weil sie Aufrufe an das Zielobjekt abfangen. Die Trap in handler2 oben definiert alle Eigenschaftenzugriffe neu:

console.log(proxy2.message1); // world
console.log(proxy2.message2); // world

Proxies werden häufig mit dem Reflect-Objekt verwendet, welches einige Methoden mit denselben Namen wie die Proxy-Traps bereitstellt. Die Reflect-Methoden bieten die Reflexionssemantik für das Aufrufen der entsprechenden internen Objektmethoden. Zum Beispiel können wir Reflect.get aufrufen, wenn wir das Verhalten des Objekts nicht neu definieren möchten:

const target = {
  message1: "hello",
  message2: "everyone",
};

const handler3 = {
  get(target, prop, receiver) {
    if (prop === "message2") {
      return "world";
    }
    return Reflect.get(...arguments);
  },
};

const proxy3 = new Proxy(target, handler3);

console.log(proxy3.message1); // hello
console.log(proxy3.message2); // world

Die Reflect-Methode interagiert weiterhin über die internen Objektmethoden mit dem Objekt — sie "de-proxifiziert" den Proxy nicht, wenn sie auf einem Proxy aufgerufen wird. Wenn Sie Reflect-Methoden innerhalb einer Proxy-Trap verwenden und der Reflect-Methodenaufruf erneut durch die Trap abgefangen wird, kann es zu einer Endlosschleife kommen.

Die folgenden Begriffe werden verwendet, wenn über die Funktionalität von Proxies gesprochen wird.

handler

Das Objekt, das als zweites Argument an den Proxy-Konstruktor übergeben wird. Es enthält die Traps, die das Verhalten des Proxys definieren.

trap

Die Funktion, die das Verhalten für die entsprechende interne Objektmethode definiert. (Dies ist analog zum Konzept der Traps in Betriebssystemen.)

target

Objekt, das der Proxy virtualisiert. Es wird oft als Speicher-Backend für den Proxy verwendet. Invarianten (Semantiken, die unverändert bleiben) bezüglich der Nicht-Erweiterbarkeit oder der nicht-konfigurierbaren Eigenschaften des Objekts werden gegen das Ziel überprüft.

invariants

Semantiken, die bei der Implementierung benutzerdefinierter Operationen unverändert bleiben. Wenn die Implementierung von Traps die Invarianten eines Handlers verletzt, wird ein TypeError ausgelöst.

Objekte sind Sammlungen von Eigenschaften. Die Sprache bietet allerdings keine Mechanismen, um die im Objekt gespeicherten Daten direkt zu manipulieren - stattdessen definiert das Objekt einige interne Methoden, die festlegen, wie mit ihm interagiert werden kann. Zum Beispiel können Sie beim Lesen von obj.x erwarten, dass Folgendes passiert:

• Die Eigenschaft x wird in der Prototypkette nach oben gesucht, bis sie gefunden wird.
• Wenn x eine Dateneigenschaft ist, wird das value-Attribut des Eigenschaftsdeskriptors zurückgegeben.
• Wenn x eine Accessor-Eigenschaft ist, wird der Getter aufgerufen und der Rückgabewert des Getters zurückgegeben.

An diesem Prozess ist in der Sprache nichts Besonderes - es liegt einfach daran, dass gewöhnliche Objekte standardmäßig eine [[Get]]-interne Methode haben, die mit diesem Verhalten definiert ist. Die Syntax für den Zugriff auf die Eigenschaft obj.x ruft einfach die [[Get]]-Methode auf dem Objekt auf, und das Objekt verwendet seine eigene Implementierung der internen Methode, um zu bestimmen, was zurückgegeben werden soll.

Als weiteres Beispiel unterscheiden sich Arrays von normalen Objekten, weil sie eine magische length-Eigenschaft haben, die beim Ändern automatisch leere Slots zuweist oder Elemente aus dem Array entfernt. Ähnlich ändert das Hinzufügen von Array-Elementen automatisch die length-Eigenschaft. Dies liegt daran, dass Arrays eine [[DefineOwnProperty]]-interne Methode haben, die weiß, dass length aktualisiert werden soll, wenn ein ganzzahliger Index geschrieben wird, oder dass die Array-Inhalte aktualisiert werden, wenn length geschrieben wird. Solche Objekte, deren interne Methoden andere Implementierungen als gewöhnliche Objekte haben, werden exotische Objekte genannt. Proxy ermöglicht Entwicklern, ihre eigenen exotischen Objekte mit voller Kapazität zu definieren.

Alle Objekte haben die folgenden internen Methoden:

Funktionsobjekte haben auch die folgenden internen Methoden:

Es ist wichtig zu verstehen, dass alle Interaktionen mit einem Objekt letztendlich auf den Aufruf einer dieser internen Methoden hinauslaufen und dass sie alle durch Proxies anpassbar sind. Dies bedeutet, dass fast kein Verhalten (außer bestimmten kritischen Invarianten) in der Sprache garantiert ist - alles wird vom Objekt selbst definiert. Wenn Sie delete obj.x ausführen, gibt es keine Garantie, dass "x" in obj anschließend false zurückgibt — es hängt von den Implementierungen des Objekts von [[Delete]] und [[HasProperty]] ab. Ein delete obj.x kann Dinge in der Konsole protokollieren, einen globalen Zustand ändern oder sogar eine neue Eigenschaft definieren, anstatt die vorhandene zu löschen, obwohl diese Semantiken in Ihrem eigenen Code vermieden werden sollten.

Alle internen Methoden werden von der Sprache selbst aufgerufen und sind im JavaScript-Code nicht direkt zugänglich. Der Reflect-Namensraum bietet Methoden, die nicht viel mehr tun als die internen Methoden aufzurufen, außer einer gewissen Eingabevereinheitlichung/-validierung. Auf jeder Trap-Seite listen wir mehrere typische Situationen auf, in denen die Trap aufgerufen wird, aber diese internen Methoden werden in vielen Bereichen aufgerufen. Zum Beispiel lesen und schreiben Array-Methoden durch diese internen Methoden, sodass Methoden wie push() auch die get()- und set()-Traps aufrufen würden.

Die meisten der internen Methoden sind darin, was sie tun, eindeutig. Die einzigen beiden, die möglicherweise verwirrend sind, sind [[Set]] und [[DefineOwnProperty]]. Für normale Objekte ruft erstere Setter auf; letztere nicht. (Und [[Set]] ruft [[DefineOwnProperty]] intern auf, wenn keine vorhandene Eigenschaft vorhanden ist oder die Eigenschaft eine Dateneigenschaft ist.) Obwohl Sie wissen mögen, dass die Syntax obj.x = 1 [[Set]] verwendet und Object.defineProperty() [[DefineOwnProperty]] verwendet, ist nicht sofort ersichtlich, welche Semantiken andere eingebaute Methoden und Syntaxen verwenden. Beispielsweise verwenden Klassenfelder die [[DefineOwnProperty]]-Semantik, weshalb definierte Setter in der Oberklasse nicht aufgerufen werden, wenn ein Feld in der abgeleiteten Klasse deklariert wird.

Proxy()

Erstellt ein neues Proxy-Objekt.

Proxy.revocable()

Erstellt ein widerrufbares Proxy-Objekt.

In diesem Beispiel wird die Zahl 37 als Standardwert zurückgegeben, wenn der Name der Eigenschaft nicht im Objekt enthalten ist. Es verwendet den get()-Handler.

const handler = {
  get(obj, prop) {
    return prop in obj ? obj[prop] : 37;
  },
};

const p = new Proxy({}, handler);
p.a = 1;
p.b = undefined;

console.log(p.a, p.b); // 1, undefined

console.log("c" in p, p.c); // false, 37

In diesem Beispiel verwenden wir ein natives JavaScript-Objekt, an das unser Proxy alle darauf angewendeten Operationen weiterleitet.

const target = {};
const p = new Proxy(target, {});

p.a = 37; // Operation forwarded to the target

console.log(target.a); // 37 (The operation has been properly forwarded!)

Beachten Sie, dass dieser "No-op" für einfache JavaScript-Objekte funktioniert, nicht jedoch für native Objekte wie DOM-Elemente, Map-Objekte oder irgendetwas, das interne Slots hat. Weitere Informationen finden Sie unter Keine Weiterleitung von privaten Feldern.

Ein Proxy ist dennoch ein anderes Objekt mit einer unterschiedlichen Identität — es ist ein Proxy, der zwischen dem umhüllten Objekt und der Außenwelt steht. Daher hat der Proxy keinen direkten Zugriff auf die privaten Elemente des ursprünglichen Objekts.

class Secret {
  #secret;
  constructor(secret) {
    this.#secret = secret;
  }
  get secret() {
    return this.#secret.replace(/\d+/, "[REDACTED]");
  }
}

const aSecret = new Secret("123456");
console.log(aSecret.secret); // [REDACTED]
// Looks like a no-op forwarding...
const proxy = new Proxy(aSecret, {});
console.log(proxy.secret); // TypeError: Cannot read private member #secret from an object whose class did not declare it

Dies liegt daran, dass beim Aufruf der get-Trap des Proxys der this-Wert der proxy anstelle des ursprünglichen secret ist, sodass #secret nicht zugänglich ist. Um dies zu beheben, verwenden Sie das ursprüngliche secret als this:

const proxy = new Proxy(aSecret, {
  get(target, prop, receiver) {
    // By default, it looks like Reflect.get(target, prop, receiver)
    // which has a different value of `this`
    return target[prop];
  },
});
console.log(proxy.secret);

Für Methoden bedeutet dies, dass Sie den this-Wert der Methode auch auf das ursprüngliche Objekt umleiten müssen:

class Secret {
  #x = 1;
  x() {
    return this.#x;
  }
}

const aSecret = new Secret();
const proxy = new Proxy(aSecret, {
  get(target, prop, receiver) {
    const value = target[prop];
    if (value instanceof Function) {
      return function (...args) {
        return value.apply(this === receiver ? target : this, args);
      };
    }
    return value;
  },
});
console.log(proxy.x());

Einige native JavaScript-Objekte haben Eigenschaften, die als interne Slots bezeichnet werden und auf die nicht von JavaScript-Code aus zugegriffen werden kann. Beispielsweise haben Map-Objekte einen internen Slot namens [[MapData]], in dem die Schlüssel-Werte-Paare der Map gespeichert sind. Daher können Sie nicht ohne Weiteres einen Weiterleitungsproxy für eine Map erstellen:

const proxy = new Proxy(new Map(), {});
console.log(proxy.size); // TypeError: get size method called on incompatible Proxy

Sie müssen den oben illustrierten "this-wiederherstellenden" Proxy verwenden, um dies zu umgehen.

Mit einem Proxy können Sie den übergebenen Wert für ein Objekt leicht validieren. Dieses Beispiel verwendet den set()-Handler.

const validator = {
  set(obj, prop, value) {
    if (prop === "age") {
      if (!Number.isInteger(value)) {
        throw new TypeError("The age is not an integer");
      }
      if (value > 200) {
        throw new RangeError("The age seems invalid");
      }
    }

    // The default behavior to store the value
    obj[prop] = value;

    // Indicate success
    return true;
  },
};

const person = new Proxy({}, validator);

person.age = 100;
console.log(person.age); // 100
person.age = "young"; // Throws an exception
person.age = 300; // Throws an exception

In diesem Beispiel verwenden wir Proxy, um ein Attribut von zwei verschiedenen Elementen umzuschalten: Wenn wir das Attribut an einem Element setzen, wird das Attribut am anderen Element entfernt.

Wir erstellen ein view-Objekt, das ein Proxy für ein Objekt mit einer selected-Eigenschaft ist. Der Proxy-Handler definiert den set()-Handler.

Wenn wir ein HTML-Element view.selected zuweisen, wird das 'aria-selected'-Attribut des Elements auf true gesetzt. Wenn wir dann ein anderes Element view.selected zuweisen, wird das 'aria-selected'-Attribut dieses Elements auf true gesetzt und das 'aria-selected'-Attribut des vorherigen Elements automatisch auf false gesetzt.

const view = new Proxy(
  {
    selected: null,
  },
  {
    set(obj, prop, newVal) {
      const oldVal = obj[prop];

      if (prop === "selected") {
        if (oldVal) {
          oldVal.setAttribute("aria-selected", "false");
        }
        if (newVal) {
          newVal.setAttribute("aria-selected", "true");
        }
      }

      // The default behavior to store the value
      obj[prop] = newVal;

      // Indicate success
      return true;
    },
  },
);

const item1 = document.getElementById("item-1");
const item2 = document.getElementById("item-2");

// select item1:
view.selected = item1;

console.log(`item1: ${item1.getAttribute("aria-selected")}`);
// item1: true

// selecting item2 de-selects item1:
view.selected = item2;

console.log(`item1: ${item1.getAttribute("aria-selected")}`);
// item1: false

console.log(`item2: ${item2.getAttribute("aria-selected")}`);
// item2: true

Das products-Proxy-Objekt bewertet den übergebenen Wert und konvertiert ihn bei Bedarf in ein Array. Das Objekt unterstützt auch eine zusätzliche Eigenschaft namens latestBrowser sowohl als Getter als auch als Setter.

const products = new Proxy(
  {
    browsers: ["Firefox", "Chrome"],
  },
  {
    get(obj, prop) {
      // An extra property
      if (prop === "latestBrowser") {
        return obj.browsers[obj.browsers.length - 1];
      }

      // The default behavior to return the value
      return obj[prop];
    },
    set(obj, prop, value) {
      // An extra property
      if (prop === "latestBrowser") {
        obj.browsers.push(value);
        return true;
      }

      // Convert the value if it is not an array
      if (typeof value === "string") {
        value = [value];
      }

      // The default behavior to store the value
      obj[prop] = value;

      // Indicate success
      return true;
    },
  },
);

console.log(products.browsers);
//  ['Firefox', 'Chrome']

products.browsers = "Safari";
//  pass a string (by mistake)

console.log(products.browsers);
//  ['Safari'] <- no problem, the value is an array

products.latestBrowser = "Edge";

console.log(products.browsers);
//  ['Safari', 'Edge']

console.log(products.latestBrowser);
//  'Edge'

Um nun aus didaktischen Gründen ein vollständiges Beispiel für eine traps-Liste zu erstellen, werden wir versuchen, ein nicht-natives Objekt zu proxifizieren, das sich besonders für diesen Operationstyp eignet: das docCookies-globale Objekt, das von einem einfachen Cookie-Framework erstellt wird.

/*
  const docCookies = ... get the "docCookies" object here:
  https://reference.codeproject.com/dom/document/cookie/simple_document.cookie_framework
*/

const docCookies = new Proxy(docCookies, {
  get(target, key) {
    return target[key] ?? target.getItem(key) ?? undefined;
  },
  set(target, key, value) {
    if (key in target) {
      return false;
    }
    return target.setItem(key, value);
  },
  deleteProperty(target, key) {
    if (!(key in target)) {
      return false;
    }
    return target.removeItem(key);
  },
  ownKeys(target) {
    return target.keys();
  },
  has(target, key) {
    return key in target || target.hasItem(key);
  },
  defineProperty(target, key, descriptor) {
    if (descriptor && "value" in descriptor) {
      target.setItem(key, descriptor.value);
    }
    return target;
  },
  getOwnPropertyDescriptor(target, key) {
    const value = target.getItem(key);
    return value
      ? {
          value,
          writable: true,
          enumerable: true,
          configurable: false,
        }
      : undefined;
  },
});

/* Cookies test */

console.log((docCookies.myCookie1 = "First value"));
console.log(docCookies.getItem("myCookie1"));

docCookies.setItem("myCookie1", "Changed value");
console.log(docCookies.myCookie1);

• Proxies are awesome Präsentation von Brendan Eich auf der JSConf (2014)