Proxy

Das Proxy-Objekt erlaubt es Ihnen, ein Objekt zu erstellen, das anstelle des Originalobjekts verwendet werden kann, jedoch 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.

Sie erstellen einen Proxy mit zwei Parametern:

• target: das Originalobjekt, das Sie proxyen möchten
• handler: ein Objekt, das definiert, welche Operationen abgefangen werden und wie abgefangene Operationen neu definiert werden.

Zum Beispiel erstellt 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 abfängt, auf Eigenschaften im Ziel zuzugreifen.

Handler-Funktionen werden manchmal Traps genannt, vermutlich weil sie Aufrufe des Zielobjekts abfangen. Der Trap in handler2 oben definiert alle Zugriffsmethoden auf Eigenschaften neu:

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

Proxies werden häufig mit dem Reflect-Objekt verwendet, das einige Methoden mit denselben Namen wie die Proxy-Traps bietet. Die Reflect-Methoden bieten die reflektierenden Semantiken für die Ausführung 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 immer noch über die internen Objektmethoden mit dem Objekt — sie "de-proxifiert" den Proxy nicht, wenn sie auf einem Proxy aufgerufen wird. Wenn Sie Reflect-Methoden innerhalb eines Proxy-Traps verwenden und der Reflect-Methodenaufruf erneut vom Trap abgefangen wird, kann es zu einer endlosen Rekursion 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 vergleichbar mit dem Konzept der Traps in Betriebssystemen.)

target

Objekt, das durch den Proxy virtualisiert wird. Es wird oft als Speicher-Backend für den Proxy verwendet. Invarianten (Semantiken, die unverändert bleiben) in Bezug auf die Nicht-Erweiterbarkeit oder nicht-konfigurierbare Eigenschaften eines Objekts werden am Ziel überprüft.

invariants

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

Objekte sind Sammlungen von Eigenschaften. Die Sprache bietet jedoch keine Mechanismen, um die in einem Objekt gespeicherten Daten direkt zu manipulieren – stattdessen definiert das Objekt einige interne Methoden, die spezifizieren, wie damit interagiert werden kann. Zum Beispiel, wenn Sie obj.x lesen, erwarten Sie möglicherweise, dass Folgendes passiert:

• Die Eigenschaft x wird die Prototype-Kette entlang gesucht, bis sie gefunden wird.
• Wenn x eine Daten-Eigenschaft ist, wird der value-Attribut des Eigenschaftsdeskriptors zurückgegeben.
• Wenn x eine Accessor-Eigenschaft ist, wird der Getter aufgerufen und der Rückgabewert des Getters zurückgegeben.

Es gibt nichts besonderes an diesem Prozess in der Sprache — es liegt daran, dass gewöhnliche Objekte standardmäßig eine interne [[Get]]-Methode haben, die mit diesem Verhalten definiert ist. Die obj.x-Syntax für Eigenschaftszugriff 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.

Ein weiteres Beispiel: Arrays unterscheiden sich von normalen Objekten, weil sie eine magische length-Eigenschaft haben, die, wenn sie modifiziert wird, automatisch leere Plätze zuweist oder Elemente aus dem Array entfernt. Ebenso ändert das Hinzufügen von Array-Elementen automatisch die length-Eigenschaft. Dies liegt daran, dass Arrays eine [[DefineOwnProperty]]-Methode haben, die weiß, length zu aktualisieren, wenn ein Integer-Index geschrieben wird, oder die Inhaltsdes Arrays zu ändern, wenn length geschrieben wird. Solche Objekte, deren interne Methoden von den Implementierungen gewöhnlicher Objekte abweichen, werden exotische Objekte genannt. Proxy erlaubt es 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 letztlich auf den Aufruf einer dieser internen Methoden hinauslaufen und dass sie alle über Proxies anpassbar sind. Das bedeutet, dass fast kein Verhalten (außer einigen kritischen Invarianten) in der Sprache garantiert ist – alles wird durch das 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 von [[Delete]] und [[HasProperty]] des Objekts ab. Ein delete obj.x kann Dinge in die Konsole protokollieren, einen globalen Zustand ändern oder sogar eine neue Eigenschaft definieren, anstatt die bestehende 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 wenig mehr tun als die internen Methoden aufzurufen, abgesehen von einigen Eingabenormalisierungen/-validierungen. Auf jeder Seite eines Traps listen wir verschiedene typische Situationen auf, in denen der Trap aufgerufen wird, aber diese internen Methoden werden an vielen Stellen aufgerufen. Zum Beispiel lesen und schreiben Array-Methoden über diese internen Methoden in das Array, daher würden Methoden wie push() auch get()- und set()-Traps aufrufen.

Die meisten internen Methoden sind in dem, was sie tun, unkompliziert. Die einzigen beiden, die möglicherweise verwirrend sein könnten, sind [[Set]] und [[DefineOwnProperty]]. Für normale Objekte ruft erstere Setter auf; letztere nicht. (Und [[Set]] ruft [[DefineOwnProperty]] intern auf, wenn keine vorhandene Eigenschaft existiert oder die Eigenschaft eine Dateneigenschaft ist.) Auch wenn Sie wissen, dass die obj.x = 1-Syntax [[Set]] verwendet und Object.defineProperty() [[DefineOwnProperty]] verwendet, ist nicht sofort ersichtlich, welche Semantiken andere eingebaute Methoden und Syntaxen verwenden. Zum Beispiel verwenden Klassenfelder die [[DefineOwnProperty]]-Semantik, weshalb Setter, die in der Superklasse definiert sind, 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 Eigenschaftenname nicht im Objekt vorhanden ist. Es wird der get()-Handler verwendet.

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, auf das unser Proxy alle darauf angewendeten Operationen weiterleiten wird.

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 während dieses "No-op" für einfache JavaScript-Objekte funktioniert, es nicht für native Objekte wie DOM-Elemente, Map-Objekte oder alles, das interne Slots hat, funktioniert. Siehe keine private Eigenschaftsweiterleitung für weitere Informationen.

Ein Proxy ist immer noch ein anderes Objekt mit einer anderen Identität — es ist ein Proxy, der zwischen dem umschlossenen Objekt und der Außenwelt arbeitet. Daher hat der Proxy keinen direkten Zugriff auf die privaten Eigenschaften des Originalobjekts.

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

Der Grund dafür ist, dass, wenn der get-Trap des Proxys aufgerufen wird, der this-Wert der proxy ist anstelle des Originals secret, sodass #secret nicht zugänglich ist. Um dies zu beheben, verwenden Sie das Original 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 Originalobjekt 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 interne Slots genannt werden, die vom JavaScript-Code nicht zugänglich sind. Zum Beispiel haben Map-Objekte einen internen Slot namens [[MapData]], der die Schlüssel-Wert-Paare der Map speichert. Daher können Sie nicht trivialerweise 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 beschriebenen "this-Wiederherstellungs"-Proxy verwenden, um dies zu umgehen.

Mit einem Proxy können Sie den übergebenen Wert für ein Objekt einfach 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 bei einem Element setzen, wird das Attribut beim 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 auf view.selected setzen, wird das 'aria-selected'-Attribut des Elements auf true gesetzt. Wenn wir dann ein anderes Element auf view.selected setzen, wird das 'aria-selected'-Attribut dieses Elements auf true gesetzt und das vorherige Element's 'aria-selected'-Attribut wird 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-Proxyobjekt 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 ein vollständiges Beispiel für eine traps-Liste zu erstellen, werden wir, zu didaktischen Zwecken, versuchen, ein nicht-natives Objekt zu proxifizieren, das sich besonders für diese Art von Operation eignet: das docCookies-globale Objekt, das durch ein einfaches Cookie-Framework erstellt wurde.

/*
  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 Vortrag von Brendan Eich auf der JSConf (2014)