Die Plattform enthält jetzt structuredClone(), eine integrierte Funktion für Deep Copying.
Lange Zeit mussten Sie auf Behelfslösungen und Bibliotheken zurückgreifen, um eine tiefe Kopie eines JavaScript-Werts zu erstellen. Die Plattform enthält jetzt structuredClone(), eine integrierte Funktion für Deepcopy.
Flache Kopien
Das Kopieren eines Werts in JavaScript ist fast immer flach, im Gegensatz zu tief. Das bedeutet, dass Änderungen an tief verschachtelten Werten sowohl in der Kopie als auch im Original sichtbar sind.
Eine Möglichkeit, eine flache Kopie in JavaScript zu erstellen, ist die Verwendung des Object-Spread-Operators ...:
const myOriginal = {
someProp: "with a string value",
anotherProp: {
withAnotherProp: 1,
andAnotherProp: true
}
};
const myShallowCopy = {...myOriginal};
Wenn Sie ein Attribut direkt in der flachen Kopie hinzufügen oder ändern, wirkt sich das nur auf die Kopie aus, nicht auf das Original:
myShallowCopy.aNewProp = "a new value";
console.log(myOriginal.aNewProp)
// ^ logs `undefined`
Wenn Sie jedoch eine tief verschachtelte Property hinzufügen oder ändern, wirkt sich das sowohl auf die Kopie als auch auf das Original aus:
myShallowCopy.anotherProp.aNewProp = "a new value";
console.log(myOriginal.anotherProp.aNewProp)
// ^ logs `a new value`
Der Ausdruck {...myOriginal} iteriert mit dem Spread-Operator über die (aufzählbaren) Eigenschaften von myOriginal. Dabei werden der Name und der Wert des Attributs verwendet und nacheinander einem neu erstellten, leeren Objekt zugewiesen. Das resultierende Objekt hat also dieselbe Form, aber eine eigene Kopie der Liste der Attribute und Werte. Die Werte werden ebenfalls kopiert, aber sogenannte primitive Werte werden von der JavaScript-Engine anders behandelt als nicht primitive Werte. Zitat von MDN:
In JavaScript ist ein primitiver Wert (primitiver Datentyp) ein Datentyp, der kein Objekt ist und keine Methoden hat. Es gibt sieben primitive Datentypen: String, Number, BigInt, Boolean, Undefined, Symbol und Null.
MDN – Primitive
Nicht primitive Werte werden als Referenzen behandelt. Das bedeutet, dass beim Kopieren des Werts eigentlich nur eine Referenz auf dasselbe zugrunde liegende Objekt kopiert wird, was zu einer flachen Kopie führt.
Deep Copies
Das Gegenteil einer oberflächlichen Kopie ist eine tiefe Kopie. Ein Deep-Copy-Algorithmus kopiert ebenfalls die Eigenschaften eines Objekts nacheinander, ruft sich jedoch rekursiv auf, wenn er einen Verweis auf ein anderes Objekt findet, und erstellt auch eine Kopie dieses Objekts. Das kann sehr wichtig sein, um sicherzustellen, dass zwei Codeabschnitte nicht versehentlich ein Objekt gemeinsam nutzen und unwissentlich den Status des jeweils anderen manipulieren.
Bisher gab es keine einfache oder gute Möglichkeit, eine tiefe Kopie eines Werts in JavaScript zu erstellen. Viele Nutzer haben sich auf Drittanbieterbibliotheken wie die cloneDeep()-Funktion von Lodash verlassen. Die wohl gängigste Lösung für dieses Problem war ein JSON-basierter Hack:
const myDeepCopy = JSON.parse(JSON.stringify(myOriginal));
Tatsächlich war diese Problemumgehung so beliebt, dass V8 JSON.parse() und insbesondere das obige Muster aggressiv optimiert hat, um es so schnell wie möglich zu machen. Diese Methode ist zwar schnell, hat aber auch einige Nachteile und Fallstricke:
- Rekursive Datenstrukturen:
JSON.stringify()löst einen Fehler aus, wenn eine rekursive Datenstruktur übergeben wird. Das kann bei der Arbeit mit verknüpften Listen oder Bäumen leicht passieren. - Integrierte Typen:
JSON.stringify()löst einen Fehler aus, wenn der Wert andere integrierte JS-Typen wieMap,Set,Date,RegExpoderArrayBufferenthält. - Funktionen:
JSON.stringify()verwirft Funktionen ohne Meldung.
Strukturiertes Klonen
Die Plattform benötigte bereits an einigen Stellen die Möglichkeit, tiefe Kopien von JavaScript-Werten zu erstellen: Das Speichern eines JS-Werts in IndexedDB erfordert eine Form der Serialisierung, damit er auf der Festplatte gespeichert und später deserialisiert werden kann, um den JS-Wert wiederherzustellen. Ähnlich verhält es sich beim Senden von Nachrichten an einen WebWorker über postMessage(). Hier muss ein JS-Wert von einem JS-Bereich in einen anderen übertragen werden. Der dafür verwendete Algorithmus heißt „Structured Clone“ und war bis vor Kurzem für Entwickler nicht leicht zugänglich.
Das hat sich jetzt geändert. Die HTML-Spezifikation wurde geändert, um eine Funktion namens structuredClone() bereitzustellen, die genau diesen Algorithmus ausführt. So können Entwickler ganz einfach tiefe Kopien von JavaScript-Werten erstellen.
const myDeepCopy = structuredClone(myOriginal);
Geschafft! Das ist die gesamte API. Weitere Informationen finden Sie im MDN-Artikel.
Funktionen und Einschränkungen
Das strukturierte Klonen behebt viele (wenn auch nicht alle) Mängel der JSON.stringify()-Technik. Strukturiertes Klonen kann zyklische Datenstrukturen verarbeiten, unterstützt viele integrierte Datentypen und ist im Allgemeinen robuster und oft schneller.
Es gibt jedoch einige Einschränkungen, die Sie überraschen könnten:
- Prototypen: Wenn Sie
structuredClone()mit einer Klasseninstanz verwenden, erhalten Sie ein einfaches Objekt als Rückgabewert, da beim strukturierten Klonen die Prototypkette des Objekts verworfen wird. - Funktionen: Wenn Ihr Objekt Funktionen enthält, löst
structuredClone()eineDataCloneError-Ausnahme aus. - Nicht klonbare Werte: Einige Werte sind nicht strukturiert klonbar, insbesondere
Errorund DOM-Knoten. Dadurch wirdstructuredClone()ausgelöst.
Wenn eine dieser Einschränkungen für Ihren Anwendungsfall ein Ausschlusskriterium ist, bieten Bibliotheken wie Lodash weiterhin benutzerdefinierte Implementierungen anderer Deep-Cloning-Algorithmen, die für Ihren Anwendungsfall geeignet sein können oder auch nicht.
Leistung
Ich habe zwar keinen neuen Mikro-Benchmark-Vergleich durchgeführt, aber Anfang 2018 einen Vergleich angestellt, bevor structuredClone() verfügbar war. Damals war JSON.parse() die schnellste Option für sehr kleine Objekte. Ich gehe davon aus, dass das so bleibt. Techniken, die auf strukturiertem Klonen basieren, waren bei größeren Objekten (deutlich) schneller. Da die neue structuredClone()-Methode ohne den Mehraufwand des Missbrauchs anderer APIs auskommt und robuster als JSON.parse() ist, empfehlen wir, sie als Standardmethode zum Erstellen von Deep Copies zu verwenden.
Fazit
Wenn Sie in JS eine tiefe Kopie eines Werts erstellen müssen, weil Sie unveränderliche Datenstrukturen verwenden oder sicherstellen möchten, dass eine Funktion ein Objekt bearbeiten kann, ohne das Original zu beeinflussen, müssen Sie nicht mehr auf Problemumgehungen oder Bibliotheken zurückgreifen. Das JS-Ökosystem hat jetzt structuredClone(). Hurra!