Deep-copying in JavaScript utilizzando structuredClone

La piattaforma ora include structuredClone(), una funzione integrata per la copia completa.

Per molto tempo, per creare una copia completa di un valore JavaScript è stato necessario ricorrere a soluzioni alternative e librerie. La piattaforma ora include structuredClone(), una funzione integrata per la copia profonda.

Browser Support

  • Chrome: 98.
  • Edge: 98.
  • Firefox: 94.
  • Safari: 15.4.

Source

Copie superficiali

La copia di un valore in JavaScript è quasi sempre superficiale, anziché profonda. Ciò significa che le modifiche ai valori nidificati in profondità saranno visibili sia nella copia sia nell'originale.

Un modo per creare una copia superficiale in JavaScript utilizzando l'operatore di espansione degli oggetti ...:

const myOriginal = {
  someProp: "with a string value",
  anotherProp: {
    withAnotherProp: 1,
    andAnotherProp: true
  }
};

const myShallowCopy = {...myOriginal};

L'aggiunta o la modifica di una proprietà direttamente nella copia superficiale influirà solo sulla copia, non sull'originale:

myShallowCopy.aNewProp = "a new value";
console.log(myOriginal.aNewProp)
// ^ logs `undefined`

Tuttavia, l'aggiunta o la modifica di una proprietà con nidificazione profonda influisce sia sulla copia sia sull'originale:

myShallowCopy.anotherProp.aNewProp = "a new value";
console.log(myOriginal.anotherProp.aNewProp) 
// ^ logs `a new value`

L'espressione {...myOriginal} esegue l'iterazione sulle proprietà (enumerabili) di myOriginal utilizzando l'operatore spread. Utilizza il nome e il valore della proprietà e li assegna uno alla volta a un oggetto vuoto appena creato. Di conseguenza, l'oggetto risultante ha una forma identica, ma con una propria copia dell'elenco di proprietà e valori. Anche i valori vengono copiati, ma i cosiddetti valori primitivi vengono gestiti in modo diverso dal valore JavaScript rispetto ai valori non primitivi. Per citare MDN:

In JavaScript, una primitiva (valore primitivo, tipo di dati primitivi) è un dato che non è un oggetto e non ha metodi. Esistono sette tipi di dati primitivi: string, number, bigint, boolean, undefined, symbol e null.

MDN — Primitive

I valori non primitivi vengono gestiti come riferimenti, il che significa che l'atto di copiare il valore consiste semplicemente nel copiare un riferimento allo stesso oggetto sottostante, con il conseguente comportamento di copia superficiale.

Copie complete

L'opposto di una copia superficiale è una copia profonda. Un algoritmo di copia completa copia anche le proprietà di un oggetto una per una, ma si richiama in modo ricorsivo quando trova un riferimento a un altro oggetto, creando anche una copia di quell'oggetto. Questo può essere molto importante per assicurarsi che due parti di codice non condividano accidentalmente un oggetto e manipolino inconsapevolmente lo stato l'una dell'altra.

In passato non esisteva un modo semplice o efficace per creare una copia completa di un valore in JavaScript. Molte persone si affidavano a librerie di terze parti come la funzione cloneDeep() di Lodash. Probabilmente la soluzione più comune a questo problema è stata un hack basato su JSON:

const myDeepCopy = JSON.parse(JSON.stringify(myOriginal));

In effetti, questa soluzione alternativa era così popolare che V8 ha ottimizzato in modo aggressivo JSON.parse() e in particolare il pattern sopra riportato per renderlo il più veloce possibile. Sebbene sia veloce, presenta un paio di svantaggi e insidie:

  • Strutture di dati ricorsive: JSON.stringify() genera un errore quando gli viene fornita una struttura di dati ricorsiva. Questo può accadere facilmente quando si lavora con elenchi o alberi collegati.
  • Tipi integrati: JSON.stringify() genererà un errore se il valore contiene altri elementi JS integrati come Map, Set, Date, RegExp o ArrayBuffer.
  • Funzioni: JSON.stringify() ignora le funzioni senza avvisi.

Clonazione strutturata

La piattaforma aveva già bisogno della possibilità di creare copie complete dei valori JavaScript in un paio di punti: la memorizzazione di un valore JS in IndexedDB richiede una qualche forma di serializzazione in modo che possa essere memorizzato su disco e successivamente deserializzato per ripristinare il valore JS. Analogamente, l'invio di messaggi a un WebWorker tramite postMessage() richiede il trasferimento di un valore JS da un realm JS a un altro. L'algoritmo utilizzato per questa operazione è chiamato "Structured Clone" e, fino a poco tempo fa, non era facilmente accessibile agli sviluppatori.

Ora le cose sono cambiate. La specifica HTML è stata modificata per esporre una funzione chiamata structuredClone() che esegue esattamente questo algoritmo per consentire agli sviluppatori di creare facilmente copie complete dei valori JavaScript.

const myDeepCopy = structuredClone(myOriginal);

È tutto! Questa è l'intera API. Se vuoi approfondire i dettagli, consulta l'articolo di MDN.

Funzionalità e limitazioni

La clonazione strutturata risolve molte (anche se non tutte) le carenze della tecnica JSON.stringify(). La clonazione strutturata può gestire strutture di dati cicliche, supporta molti tipi di dati integrati ed è generalmente più solida e spesso più veloce.

Tuttavia, presenta ancora alcune limitazioni che potrebbero coglierti di sorpresa:

  • Prototipi: se utilizzi structuredClone() con un'istanza di classe, riceverai un oggetto semplice come valore restituito, poiché la clonazione strutturata ignora la catena di prototipi dell'oggetto.
  • Funzioni: se l'oggetto contiene funzioni, structuredClone() genera un'eccezione DataCloneError.
  • Non clonabili: alcuni valori non sono clonabili in modo strutturato, in particolare Error e i nodi DOM. Questo causerà l'attivazione di structuredClone().

Se una di queste limitazioni è un ostacolo per il tuo caso d'uso, librerie come Lodash forniscono comunque implementazioni personalizzate di altri algoritmi di clonazione profonda che potrebbero o meno essere adatti al tuo caso d'uso.

Prestazioni

Anche se non ho eseguito un nuovo confronto di micro-benchmark, ne ho fatto uno all'inizio del 2018, prima che structuredClone() venisse esposto. All'epoca, JSON.parse() era l'opzione più veloce per oggetti molto piccoli. Mi aspetto che rimanga invariato. Le tecniche che si basavano sulla clonazione strutturata erano (significativamente) più veloci per gli oggetti più grandi. Considerando che il nuovo structuredClone() non comporta l'overhead dell'abuso di altre API ed è più robusto di JSON.parse(), ti consiglio di utilizzarlo come approccio predefinito per la creazione di copie complete.

Conclusione

Se devi creare una copia completa di un valore in JS, ad esempio perché utilizzi strutture di dati immutabili o vuoi assicurarti che una funzione possa manipolare un oggetto senza influire sull'originale, non devi più ricorrere a soluzioni alternative o librerie. L'ecosistema JS ora ha structuredClone(). Urrà.