Copia profunda en JavaScript con estructuradoClone

La plataforma ahora incluye structuredClone(), una función integrada para realizar copias profundas.

Durante mucho tiempo, tuviste que recurrir a soluciones alternativas y bibliotecas para crear una copia profunda de un valor de JavaScript. La plataforma ahora incluye structuredClone(), una función integrada para realizar copias profundas.

Browser Support

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

Source

Copias superficiales

Copiar un valor en JavaScript casi siempre es superficial, en lugar de profundo. Esto significa que los cambios en los valores anidados en profundidad serán visibles tanto en la copia como en el original.

Una forma de crear una copia superficial en JavaScript es usar el operador de propagación de objetos ...:

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

const myShallowCopy = {...myOriginal};

Agregar o cambiar una propiedad directamente en la copia superficial solo afectará a la copia, no al original:

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

Sin embargo, agregar o cambiar una propiedad con un nivel de anidamiento profundo afecta tanto a la copia como al original:

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

La expresión {...myOriginal} itera sobre las propiedades (enumerables) de myOriginal con el operador de propagación. Usa el nombre y el valor de la propiedad, y los asigna uno por uno a un objeto vacío recién creado. Por lo tanto, el objeto resultante es idéntico en forma, pero con su propia copia de la lista de propiedades y valores. Los valores también se copian, pero el valor de JavaScript maneja los llamados valores primitivos de manera diferente a los valores no primitivos. Para citar a MDN:

En JavaScript, un primitivo (valor primitivo, tipo de datos primitivo) son datos que no son un objeto y no tienen métodos. Existen siete tipos de datos primitivos: string, number, bigint, boolean, undefined, symbol y null.

MDN — Primitivo

Los valores no primitivos se manejan como referencias, lo que significa que el acto de copiar el valor es, en realidad, solo copiar una referencia al mismo objeto subyacente, lo que genera el comportamiento de copia superficial.

Copias profundas

Lo opuesto a una copia superficial es una copia profunda. Un algoritmo de copia profunda también copia las propiedades de un objeto una por una, pero se invoca a sí mismo de forma recurrente cuando encuentra una referencia a otro objeto, lo que también crea una copia de ese objeto. Esto puede ser muy importante para garantizar que dos fragmentos de código no compartan un objeto de forma accidental y manipulen el estado del otro sin saberlo.

Antes, no había una forma sencilla ni agradable de crear una copia profunda de un valor en JavaScript. Muchas personas dependían de bibliotecas de terceros, como la función de LodashcloneDeep(). Podría decirse que la solución más común para este problema era un truco basado en JSON:

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

De hecho, esta solución alternativa era tan popular que V8 optimizó de forma agresiva JSON.parse() y, específicamente, el patrón anterior para que fuera lo más rápido posible. Y, si bien es rápido, tiene algunas deficiencias y trampas:

  • Estructuras de datos recursivas: JSON.stringify() arrojará un error cuando le proporciones una estructura de datos recursiva. Esto puede suceder con bastante facilidad cuando se trabaja con listas o árboles vinculados.
  • Tipos integrados: JSON.stringify() arrojará un error si el valor contiene otros elementos integrados de JS, como Map, Set, Date, RegExp o ArrayBuffer.
  • Funciones: JSON.stringify() descartará las funciones de forma silenciosa.

Clonación estructurada

La plataforma ya necesitaba la capacidad de crear copias profundas de valores de JavaScript en un par de lugares: almacenar un valor de JS en IndexedDB requiere algún tipo de serialización para que se pueda almacenar en el disco y, luego, deserializar para restablecer el valor de JS. Del mismo modo, enviar mensajes a un WebWorker a través de postMessage() requiere transferir un valor de JS de un dominio de JS a otro. El algoritmo que se usa para esto se llama “clonación estructurada” y, hasta hace poco, no era de fácil acceso para los desarrolladores.

Eso cambió. Se modificó la especificación de HTML para exponer una función llamada structuredClone() que ejecuta exactamente ese algoritmo como un medio para que los desarrolladores creen fácilmente copias profundas de valores de JavaScript.

const myDeepCopy = structuredClone(myOriginal);

Eso es todo. Esa es toda la API. Si quieres profundizar en los detalles, consulta el artículo de MDN.

Funciones y limitaciones

La clonación estructurada aborda muchas (aunque no todas) las deficiencias de la técnica JSON.stringify(). La clonación estructurada puede controlar estructuras de datos cíclicas, admite muchos tipos de datos integrados y, por lo general, es más sólida y, a menudo, más rápida.

Sin embargo, aún tiene algunas limitaciones que pueden tomarte por sorpresa:

  • Prototipos: Si usas structuredClone() con una instancia de clase, obtendrás un objeto simple como valor que se muestra, ya que la clonación estructurada descarta la cadena de prototipos del objeto.
  • Funciones: Si tu objeto contiene funciones, structuredClone() arrojará una excepción DataCloneError.
  • No clonables: Algunos valores no se pueden clonar de forma estructurada, sobre todo Error y los nodos del DOM. Esto provocará que structuredClone() arroje un error.

Si alguna de estas limitaciones es un obstáculo para tu caso de uso, las bibliotecas como Lodash aún proporcionan implementaciones personalizadas de otros algoritmos de clonación profunda que pueden o no adaptarse a tu caso de uso.

Rendimiento

Si bien no realicé una nueva comparación de microcomparativas, hice una a principios de 2018, antes de que se expusiera structuredClone(). En ese momento, JSON.parse() era la opción más rápida para objetos muy pequeños. Espero que eso no cambie. Las técnicas que se basaban en la clonación estructurada eran (significativamente) más rápidas para los objetos más grandes. Teniendo en cuenta que el nuevo structuredClone() no tiene la sobrecarga de abusar de otras APIs y es más sólido que JSON.parse(), te recomiendo que lo uses como enfoque predeterminado para crear copias profundas.

Conclusión

Si necesitas crear una copia profunda de un valor en JS, tal vez porque usas estructuras de datos inmutables o quieres asegurarte de que una función pueda manipular un objeto sin afectar el original, ya no necesitas recurrir a soluciones alternativas ni bibliotecas. El ecosistema de JS ahora tiene structuredClone(). ¡Viva!