La plate-forme est désormais fournie avec structuredClone(), une fonction intégrée pour la copie profonde.
Pendant très longtemps, vous deviez recourir à des solutions de contournement et à des bibliothèques pour créer une copie complète d'une valeur JavaScript. La plate-forme est désormais fournie avec structuredClone(), une fonction intégrée pour la copie profonde.
Copies superficielles
En JavaScript, la copie d'une valeur est presque toujours superficielle, par opposition à une copie profonde. Cela signifie que les modifications apportées aux valeurs profondément imbriquées seront visibles dans la copie ainsi que dans l'original.
Une façon de créer une copie superficielle en JavaScript à l'aide de l'opérateur de décomposition d'objet ... :
const myOriginal = {
someProp: "with a string value",
anotherProp: {
withAnotherProp: 1,
andAnotherProp: true
}
};
const myShallowCopy = {...myOriginal};
L'ajout ou la modification d'une propriété directement sur la copie superficielle n'affectera que la copie, pas l'original :
myShallowCopy.aNewProp = "a new value";
console.log(myOriginal.aNewProp)
// ^ logs `undefined`
Toutefois, l'ajout ou la modification d'une propriété profondément imbriquée affecte à la fois la copie et l'original :
myShallowCopy.anotherProp.aNewProp = "a new value";
console.log(myOriginal.anotherProp.aNewProp)
// ^ logs `a new value`
L'expression {...myOriginal} effectue une itération sur les propriétés (énumérables) de myOriginal à l'aide de l'opérateur Spread. Il utilise le nom et la valeur de la propriété, et les attribue un par un à un objet vide nouvellement créé. Par conséquent, l'objet obtenu est identique en termes de forme, mais il possède sa propre copie de la liste des propriétés et des valeurs. Les valeurs sont également copiées, mais les valeurs dites primitives sont gérées différemment par la valeur JavaScript que les valeurs non primitives. Pour citer MDN :
En JavaScript, une primitive (valeur primitive, type de données primitif) est une donnée qui n'est pas un objet et qui ne comporte aucune méthode. Il existe sept types de données primitifs : string, number, bigint, boolean, undefined, symbol et null.
MDN — Primitive
Les valeurs non primitives sont traitées comme des références, ce qui signifie que la copie de la valeur ne fait que copier une référence au même objet sous-jacent, ce qui entraîne un comportement de copie superficielle.
Copies profondes
L'opposé d'une copie superficielle est une copie approfondie. Un algorithme de copie profonde copie également les propriétés d'un objet une par une, mais s'appelle de manière récursive lorsqu'il trouve une référence à un autre objet, créant ainsi une copie de cet objet. Cela peut être très important pour s'assurer que deux morceaux de code ne partagent pas accidentellement un objet et ne manipulent pas l'état de l'autre sans le savoir.
Auparavant, il n'existait aucun moyen simple ou efficace de créer une copie complète d'une valeur en JavaScript. De nombreuses personnes s'appuyaient sur des bibliothèques tierces telles que la fonction cloneDeep() de Lodash. La solution la plus courante à ce problème était sans doute une astuce basée sur JSON :
const myDeepCopy = JSON.parse(JSON.stringify(myOriginal));
En fait, cette solution était si populaire que V8 a optimisé de manière agressive JSON.parse() et spécifiquement le modèle ci-dessus pour le rendre aussi rapide que possible. Bien qu'elle soit rapide, elle présente quelques inconvénients et pièges :
- Structures de données récursives :
JSON.stringify()génère une erreur lorsque vous lui transmettez une structure de données récursive. Cela peut se produire assez facilement lorsque vous travaillez avec des listes ou des arbres liés. - Types intégrés :
JSON.stringify()génère une erreur si la valeur contient d'autres éléments intégrés JS tels queMap,Set,Date,RegExpouArrayBuffer. - Fonctions :
JSON.stringify()supprime les fonctions sans avertissement.
Clonage structuré
La plate-forme avait déjà besoin de pouvoir créer des copies profondes de valeurs JavaScript à plusieurs endroits : le stockage d'une valeur JS dans IndexedDB nécessite une forme de sérialisation afin qu'elle puisse être stockée sur le disque, puis désérialisée pour restaurer la valeur JS. De même, l'envoi de messages à un WebWorker via postMessage() nécessite le transfert d'une valeur JS d'un domaine JS à un autre. L'algorithme utilisé pour cela s'appelle "Structured Clone" et, jusqu'à récemment, il n'était pas facilement accessible aux développeurs.
Ce n'est plus le cas ! La spécification HTML a été modifiée pour exposer une fonction appelée structuredClone() qui exécute exactement cet algorithme, afin de permettre aux développeurs de créer facilement des copies profondes de valeurs JavaScript.
const myDeepCopy = structuredClone(myOriginal);
Et voilà ! C'est tout pour l'API. Pour en savoir plus, consultez l'article MDN.
Fonctionnalités et limites
Le clonage structuré résout de nombreux inconvénients (mais pas tous) de la technique JSON.stringify(). Le clonage structuré peut gérer les structures de données cycliques, accepte de nombreux types de données intégrés, et est généralement plus robuste et souvent plus rapide.
Toutefois, il présente encore certaines limites qui pourraient vous surprendre :
- Prototypes : si vous utilisez
structuredClone()avec une instance de classe, vous obtiendrez un objet brut comme valeur de retour, car le clonage structuré supprime la chaîne de prototypes de l'objet. - Fonctions : si votre objet contient des fonctions,
structuredClone()génère une exceptionDataCloneError. - Éléments non clonables : certaines valeurs ne sont pas clonables de manière structurée, notamment
Erroret les nœuds DOM. Cela entraînera l'affichage d'une erreur parstructuredClone().
Si l'une de ces limites est rédhibitoire pour votre cas d'utilisation, des bibliothèques comme Lodash fournissent toujours des implémentations personnalisées d'autres algorithmes de clonage profond qui peuvent ou non convenir à votre cas d'utilisation.
Performances
Bien que je n'aie pas effectué de nouvelle comparaison de micro-benchmark, j'en ai fait une début 2018, avant que structuredClone() ne soit exposé. À l'époque, JSON.parse() était l'option la plus rapide pour les très petits objets. Je m'attends à ce que cela reste inchangé. Les techniques basées sur le clonage structuré étaient (nettement) plus rapides pour les objets plus volumineux. Étant donné que la nouvelle méthode structuredClone() n'entraîne pas de surcharge liée à l'utilisation abusive d'autres API et qu'elle est plus robuste que JSON.parse(), je vous recommande d'en faire votre approche par défaut pour créer des copies profondes.
Conclusion
Si vous devez créer une copie profonde d'une valeur en JS (par exemple, parce que vous utilisez des structures de données immuables ou que vous souhaitez vous assurer qu'une fonction peut manipuler un objet sans affecter l'original), vous n'avez plus besoin de recourir à des solutions de contournement ou à des bibliothèques. L'écosystème JS dispose désormais de structuredClone(). Hourra !