Глубокое копирование в JavaScript с помощью structuredClone

Теперь на платформе есть встроенная функция structuredClone() для глубокого копирования.

Долгое время для создания глубокой копии значения JavaScript приходилось прибегать к обходным путям и библиотекам. Теперь на платформе есть встроенная функция structuredClone() для глубокого копирования.

Browser Support

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

Source

Поверхностные копии

Копирование значения в JavaScript почти всегда является поверхностным, а не глубоким. Это означает, что изменения глубоко вложенных значений будут видны как в копии, так и в оригинале.

Один из способов создать поверхностную копию в JavaScript с помощью оператора расширения объекта ...:

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

const myShallowCopy = {...myOriginal};

Добавление или изменение свойства непосредственно в поверхностной копии повлияет только на копию, а не на оригинал:

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

Однако добавление или изменение глубоко вложенного свойства влияет и на копию, и на оригинал:

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

Выражение {...myOriginal} перебирает (перечисляемые) свойства myOriginal с помощью оператора расширения. Он использует имя и значение свойства и по одному присваивает их только что созданному пустому объекту. В результате получается объект, идентичный по форме, но с собственной копией списка свойств и значений. Значения также копируются, но так называемые примитивные значения обрабатываются JavaScript иначе, чем непримитивные. Вот что говорится в MDN:

В JavaScript примитив (примитивное значение, примитивный тип данных) – это данные, которые не являются объектом и не имеют методов. Существует семь примитивных типов данных: string, number, bigint, boolean, undefined, symbol и null.

MDN — Primitive

Непримитивные значения обрабатываются как ссылки. Это означает, что при копировании значения копируется только ссылка на тот же базовый объект, что приводит к поверхностному копированию.

Глубокие копии

Противоположностью поверхностной копии является полная копия. Алгоритм полного копирования также копирует свойства объекта одно за другим, но рекурсивно вызывает сам себя, когда находит ссылку на другой объект, создавая также копию этого объекта. Это может быть очень важно, чтобы два фрагмента кода случайно не использовали один и тот же объект и не манипулировали состоянием друг друга.

Раньше в JavaScript не было простого и удобного способа создать глубокую копию значения. Многие разработчики использовали сторонние библиотеки, например функцию cloneDeep() из Lodash. Пожалуй, самым распространенным решением этой проблемы был хак на основе JSON:

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

На самом деле этот обходной путь был настолько популярен, что V8 агрессивно оптимизировал JSON.parse() и, в частности, приведенный выше шаблон, чтобы сделать его как можно быстрее. Однако у этого быстрого способа есть несколько недостатков и подводных камней:

  • Рекурсивные структуры данных. Если вы передадите JSON.stringify() рекурсивную структуру данных, произойдет ошибка. Это может легко произойти при работе со связанными списками или деревьями.
  • Встроенные типы. JSON.stringify() выдаст ошибку, если значение содержит другие встроенные типы JS, такие как Map, Set, Date, RegExp или ArrayBuffer.
  • Функции. JSON.stringify() удаляет функции без уведомления.

Структурированное клонирование

Платформе уже требовалась возможность создавать глубокие копии значений JavaScript в нескольких местах: для хранения значения JS в IndexedDB требуется некоторая форма сериализации, чтобы его можно было сохранить на диске, а затем десериализовать для восстановления значения JS. Аналогично, отправка сообщений в WebWorker через postMessage() требует передачи значения JS из одной области JS в другую. Алгоритм, который используется для этого, называется Structured Clone. До недавнего времени он был недоступен разработчикам.

Теперь все изменилось. В спецификацию HTML была добавлена функция structuredClone(), которая выполняет именно этот алгоритм, чтобы разработчики могли легко создавать глубокие копии значений JavaScript.

const myDeepCopy = structuredClone(myOriginal);

Вот и всё! Вот и весь API. Подробную информацию вы найдете в статье MDN.

Функции и ограничения

Структурированное клонирование устраняет многие (хотя и не все) недостатки метода JSON.stringify(). Структурированное клонирование может обрабатывать циклические структуры данных, поддерживает множество встроенных типов данных и, как правило, более надежно и часто быстрее.

Однако у него есть некоторые ограничения, о которых стоит знать:

  • Прототипы. Если вы используете structuredClone() с экземпляром класса, то в качестве возвращаемого значения получите простой объект, поскольку структурированное клонирование отбрасывает цепочку прототипов объекта.
  • Функции. Если объект содержит функции, structuredClone() выдаст исключение DataCloneError.
  • Неподдерживаемые объекты. Некоторые значения не поддерживают структурированное клонирование, в частности Error и узлы DOM. Это приведет к ошибке structuredClone().

Если какое-либо из этих ограничений критично для вашего случая, библиотеки, такие как Lodash, по-прежнему предоставляют пользовательские реализации других алгоритмов глубокого клонирования, которые могут подойти или не подойти для вашего случая.

Эффективность

Я не проводил новое сравнение микротестов, но сделал это в начале 2018 года, до того как был представлен structuredClone(). Тогда JSON.parse() был самым быстрым вариантом для очень маленьких объектов. Думаю, что так будет и дальше. Методы, основанные на структурированном клонировании, были (значительно) быстрее для более крупных объектов. Учитывая, что новый structuredClone() не требует злоупотребления другими API и более надежен, чем JSON.parse(), я рекомендую вам сделать его подходом по умолчанию для создания глубоких копий.

Заключение

Если вам нужно создать глубокую копию значения в JS (например, потому что вы используете неизменяемые структуры данных или хотите, чтобы функция могла манипулировать объектом, не затрагивая оригинал), вам больше не нужно искать обходные пути или библиотеки. В экосистеме JS теперь есть structuredClone(). Ура!