HOWTO · Angular

AngularJS の angular.copy で値をコピーする方法

このチュートリアルでは、AngularJS の angular.copy を使って値をディープコピーする方法と、コピーするタイミングを説明します。

このページの内容

angular.copy は、値(一般にはオブジェクトや配列)をコピーする AngularJS API です。ネストされたオブジェクトへの参照が共有されないため、コピーを編集しても元の値は変わりません。このガイドでは、2種類の呼び出し方とフォーム状態の扱い方を説明します。対象は AngularJS です。現在の Angular には、この AngularJS API はありません。

angular.copy のディープコピーの動作を理解する

シャローコピーでは、新しい外側のオブジェクトが作られても、ネストされたオブジェクトへの参照は共有されたままになることがあります。ディープコピーはネストされたデータも再帰的にコピーするため、コピー側のネストされたプロパティを変更しても、コピー元の同じプロパティは変わりません。特定の物理メモリ配置が保証されるという意味ではなく、オブジェクトの状態が独立していると考えてください。

たとえば、source.profile がオブジェクトなら、copy = angular.copy(source) の後に copy.profile.name を変更しても、source.profile.name は変わりません。フォームやエディターで、リセット用の基準データを別に残しながら作業用データを編集したい場合に便利です。

宛先を指定せずにコピーする

引数を1つだけ指定して angular.copy(source) を呼び出すと、新しいコピーが作成されて返されます。たとえば、戻り値を var savedForm = angular.copy($scope.form); のように保存します。元の値はコピー元として残り、savedForm は後で比較したりリセットしたりするためのスナップショットとして使えます。

次の実行可能な JavaScript の参考例では、ネストされた状態を独立してコピーする必要性を示します。JavaScript の structuredClone を使っており、AngularJS は使っていません。そのため、出力が示すのは参照の振る舞いだけであり、angular.copy のテストではありません。

次の JavaScript 参考例を実行してください。

このセクションのコードと表示されるラベルや出力は英語のままです。

const source = { profile: { name: "Mina" } };
const copy = structuredClone(source);
copy.profile.name = "Lee";
console.log(source.profile.name);
console.log(copy.profile.name);
Mina
Lee

既存の宛先にコピーする

アプリケーション内の別の部分が宛先オブジェクトの同一性を保つ必要がある場合は、angular.copy(source, destination) を使います。AngularJS はコピー元のデータを宛先にコピーし、その宛先を返します。スコープのプロパティなど、別の処理がすでに宛先オブジェクトへの参照を保持している場合に便利です。たとえば、angular.copy($scope.form, savedForm) は、savedForm への参照を保ったまま、現在のフォームの内容で保存済みオブジェクトを更新します。

2つの呼び出し方は用途が異なります。引数が1つなら保存するための新しい値が得られ、引数が2つならすでに保持しているオブジェクトが更新されます。他のコードが既存の宛先への参照に依存している場合は、新しく返されたオブジェクトを代入しないでください。

フォーム状態をリセットして保存する

フォームの初期化時にスナップショットを作成します。var savedForm = angular.copy($scope.form); のようにします。既存のフォームオブジェクトを保ったまま入力欄をリセットするには、angular.copy(savedForm, $scope.form) を使います。ユーザーの現在の編集内容で保存済みの基準データを更新するには、angular.copy($scope.form, savedForm) を使います。常に第1引数がコピー元、第2引数が宛先です。順序を逆にすると、コピーの方向も逆になります。

図には名前の入力欄とリセット・保存ボタンがあり、フォームとメンバーの値も表示されています。これらの値は、例で意図している状態の関係を把握するのに役立ちますが、AngularJS の実行結果ではありません。

リセットボタンと保存ボタンのある名前入力欄、および表示されたフォームとメンバーの値

制限事項とサポート対象外の値

同じオブジェクトを両方の引数に指定しないでください。angular.copy(value, value) はサポートされていない自己コピーの呼び出しです。2引数の形式では、別の宛先を渡してください。また、宛先を指定する形式はオブジェクトを変更します。その宛先への参照を保持しているコードからは、更新後の内容が見えます。

提供されたタスク資料には AngularJS の実行結果も、信頼できる API リファレンスも含まれていません。そのため、この記事ではあらゆる JavaScript の値やフレームワーク管理下のオブジェクトでの動作を一般化しません。特殊な値のコピーに依存する前に、アプリケーションで使っているバージョンの AngularJS のドキュメントを確認してください。上記の実行可能な参考例は JavaScript のデモであり、AngularJS の呼び出しが実行された証拠ではありません。