プラットフォームに、ディープコピー用の組み込み関数である structuredClone() が搭載されました。
長い間、JavaScript 値のディープコピーを作成するには、回避策やライブラリを使用する必要がありました。プラットフォームに、ディープコピー用の組み込み関数 structuredClone() が追加されました。
シャローコピー
JavaScript で値をコピーする場合、ほとんどはシャロー コピーであり、ディープ コピーではありません。つまり、深くネストされた値の変更は、コピーと元の値の両方に反映されます。
JavaScript でオブジェクト スプレッド演算子 ... を使用してシャローコピーを作成する方法の 1 つ:
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 の(列挙可能な)プロパティを反復処理します。プロパティの名前と値を使用して、新しく作成された空のオブジェクトに 1 つずつ割り当てます。そのため、結果のオブジェクトは形状が同じですが、プロパティと値のリストの独自のコピーが含まれます。値もコピーされますが、いわゆるプリミティブ値は、非プリミティブ値とは異なる方法で JavaScript 値によって処理されます。MDN から引用します。
JavaScript において、プリミティブ(プリミティブ値、プリミティブ データ型)とは、オブジェクトではなく、メソッドを持たないデータのことです。プリミティブ データ型には、文字列、数値、bigint、ブール値、未定義、シンボル、null の 7 つがあります。
MDN - プリミティブ
プリミティブ以外の値は参照として扱われます。つまり、値をコピーする行為は、実際には同じ基盤となるオブジェクトへの参照をコピーするだけであり、シャローコピーの動作になります。
ディープコピー
シャローコピーの反対はディープコピーです。ディープコピー アルゴリズムもオブジェクトのプロパティを 1 つずつコピーしますが、別のオブジェクトへの参照が見つかると、自身を再帰的に呼び出して、そのオブジェクトのコピーも作成します。これは、2 つのコードが誤ってオブジェクトを共有し、互いの状態を意図せず操作しないようにするために非常に重要です。
これまで、JavaScript で値のディープコピーを作成する簡単で優れた方法はありませんでした。多くのデベロッパーは、Lodash の cloneDeep() 関数などのサードパーティ ライブラリに依存していました。この問題に対する最も一般的な解決策は、JSON ベースのハックでした。
const myDeepCopy = JSON.parse(JSON.stringify(myOriginal));
実際、これは非常に一般的な回避策であったため、V8 は JSON.parse() を積極的に最適化し、特に上記のパターンを可能な限り高速化しました。この方法は迅速ですが、いくつかの欠点と落とし穴があります。
- 再帰的なデータ構造:
JSON.stringify()は、再帰的なデータ構造が渡されるとスローします。これは、リンクされたリストやツリーを扱う場合に簡単に発生する可能性があります。 - 組み込み型: 値に
Map、Set、Date、RegExp、ArrayBufferなどの他の JS 組み込み型が含まれている場合、JSON.stringify()はスローされます。 - 関数:
JSON.stringify()は関数を暗黙的に破棄します。
構造化クローン作成
プラットフォームでは、すでにいくつかの場所で JavaScript 値のディープコピーを作成する機能が必要でした。IndexedDB に JS 値を保存するには、ディスクに保存して後でデシリアライズして JS 値を復元できるように、何らかの形式のシリアル化が必要です。同様に、postMessage() を介して WebWorker にメッセージを送信するには、JS 値をある JS レルムから別の JS レルムに転送する必要があります。このために使用されるアルゴリズムは「構造化クローン」と呼ばれ、最近までデベロッパーが簡単にアクセスできませんでした。
このたび、この点も変更されました。HTML 仕様が修正され、デベロッパーが JavaScript 値のディープコピーを簡単に作成できるように、そのアルゴリズムを実行する structuredClone() という関数が公開されました。
const myDeepCopy = structuredClone(myOriginal);
これで完了です。これが API のすべてです。詳細については、MDN の記事をご覧ください。
機能と制限事項
構造化クローン作成は、JSON.stringify() 手法の欠点の多く(すべてではありません)に対処します。構造化クローンは、循環データ構造を処理でき、多くの組み込みデータ型をサポートしています。一般的に、より堅牢で、多くの場合、より高速です。
ただし、いくつかの制限があるため、注意が必要です。
- プロトタイプ: クラス インスタンスで
structuredClone()を使用すると、戻り値としてプレーン オブジェクトが返されます。これは、構造化クローン作成によってオブジェクトのプロトタイプ チェーンが破棄されるためです。 - 関数: オブジェクトに関数が含まれている場合、
structuredClone()はDataCloneError例外をスローします。 - クローン不可: 一部の値は構造化クローン可能ではありません。特に
Errorと DOM ノードはクローンできません。これにより、structuredClone()がスローされます。
これらの制限がユースケースに合わない場合は、Lodash などのライブラリで、ユースケースに合う可能性のある他のディープ クローニング アルゴリズムのカスタム実装が提供されています。
パフォーマンス
新しいマイクロベンチマークの比較は行っていませんが、structuredClone() が公開される前の 2018 年初頭に比較を行いました。当時、JSON.parse() は非常に小さなオブジェクトに対して最速のオプションでした。今後もこの状況は変わらないと予想されます。構造化クローンに依存する手法は、大きなオブジェクトに対して(大幅に)高速でした。新しい structuredClone() は、他の API を不正使用するオーバーヘッドがなく、JSON.parse() よりも堅牢であることを考えると、ディープコピーを作成する際のデフォルトのアプローチにすることをおすすめします。
まとめ
JS で値のディープコピーを作成する必要がある場合(不変のデータ構造を使用しているため、または関数が元のオブジェクトに影響を与えずにオブジェクトを操作できるようにするため)、回避策やライブラリを使用する必要はなくなりました。JS エコシステムには structuredClone() があります。やったー。