スプレッドシートプロトタイプの例を使用したマルチレベルの元に戻す/やり直し機能の実装

はじめに

[取り消し]および[やり直し]ボタンを使用すると、ユーザーアクションをキャンセルして返すことができ、リストで実行されたすべてのアクションのリストを表示できます。これらは、ワードプロセッサや開発環境、グラフィックおよびCADエディター、システムなどのアプリケーションの事実上の標準ですサウンドとビデオの編集と編集。 それらはユーザーにとても馴染みがあるので、後者は自分の存在を与えられたものとして認識します。 しかし、開発者の観点から見ると、取り消しの存在の要件は、プロジェクトのアーキテクチャ全体に影響する要因の1つであり、開発プロジェクトのごく初期の段階で決定されます。



オープンソースには、元に戻す/やり直し機能を実際に実装する方法に関するかなりの情報があります。 E.ガンマらによる古典的な本「オブジェクト指向プログラミングの方法。 「デザインパターン」では、この目的に対する「チーム」パターンの適合性について簡単に説明しています。インターネットに関する主題に関する多くの一般情報がありますが、十分に完全で十分に開発された実装例を見つけることができませんでした。 この記事では、このギャップを埋めようとし、著者の経験に基づいて、元に戻す/やり直しをサポートするアプリケーションアーキテクチャの詳細な例を示します。これは、他のプロジェクトの基盤として使用できます。

記事のコード例はJava言語で提供されていますが、Java固有のものはなく、ここで紹介するすべてのアイデアはオブジェクト指向言語に適しています（著者自身がDelphiで実装しました）。

さまざまなニーズとアプリケーションのタイプには、さまざまな「元に戻すモデル」が存在することに注意してください。線形-厳密に逆の順序で操作をキャンセルする場合、および非線形-実行したアクションの履歴から任意の操作をキャンセルする場合 データモデルへの同期された変更 、つまり異なるスレッドでのデータモデルの内部状態の同時変更が許可されていないシステムでの線形Undoの実装について説明します。 可能なundoモデルの分類は、たとえばWikipediaの記事で提供されています 。

当然、アプリケーションはビュー（View）からのデータモデル（Model）の分離を実装し、Undo機能はそのクラスの1つのundo（）およびredo（）メソッドの形式でデータモデルレベルで実装されると仮定します。

実例

説明のための例として、この記事では、スプレッドシートをプロトタイピングするアプリケーションのデータモデル（MS Excel / LibreOffice Calcのスタイル）について検討します。 値とサイズを変更できるセル、行と列-交換するセルで構成されるシート（簡単にするために1つのみ）があり、これらのアクションはすべてキャンセルされます。 ソースコードと関連する単体テストはhttps://github.com/inponomarev/undoredoで入手でき、Mavenを使用してコンパイルおよび実行できます。

この例の主なエンティティは次のとおりです。

1. worksheet-クラスWorksheet 、
2. 行と列- 行と列クラス（ AxisElementクラスの子孫）、
3. cells-クラスCell 。

結果の単純なデータモデルは、次の図のクラス図に示されています。



スプレッドシートの実装の詳細については説明しませんが、ソースコード設計の基本原則について簡単に説明します。 スプレッドシートシートは、境界が画面をはるかに超えるデータの2次元配列としてユーザーに表示されますが、データモデルに2次元配列を使用することは、メモリ消費量または一般的な操作の速度の観点から正当化されません。 たとえば、MS Excelの以前のバージョンで65536列と行が許可されていた場合、32ビットシステムでは65536 ² （つまり40億セル）にメモリを割り当てることは技術的に不可能です。

解決策は、ツリーとハッシュテーブルに基づく辞書を使用して、変更された値のみを保存し、辞書にない値をデフォルト値に置き換えることです。

RowおよびColumnのインスタンスを格納するには、 Worksheetクラスの辞書TreeMap <Integer、Row> rowsおよびTreeMap <Integer、Column> columnを使用します 。 Cellインスタンスを保存するには、 RowクラスのHashMap <Column、Cell> cells辞書を使用します。 このハッシュテーブルの値はCellオブジェクトへの参照であり、キーは列オブジェクトです。 このデータストレージへのアプローチにより、 ワークシートのコンテンツで実際に必要なすべての操作に使用される速度とメモリの最適なバランスを見つけることができます。

モデルルートクラスとキャンセル可能なメソッド

この例のWorksheetクラスは中心です。1）他のすべてのビジネスロジックオブジェクトの操作は、この特定のクラスのインスタンスの取得から始まります。2）他のクラスのインスタンスは、 Worksheetオブジェクトのコンテキストでのみ機能します。3） save（...）メソッドを介して静的メソッドload（...）は、ストリームに保存し、ストリームからシステム全体の状態を復元します。 このクラスをモデルのルートクラスと呼びます。 原則として、Model-View-Controllerアーキテクチャでアプリケーションを開発する場合、モデルのルートクラスが何であるかを判断するのに困難はありません。 Undo / Redoの機能に固有のメソッドが提供されるのは彼です。

モデルの状態を変えるメソッドを特定するのも難しくないはずです。 これらは、呼び出し結果を元に戻す必要があるメソッドです。 この例では、次のとおりです。

• setCellValue（int row、int col、String value） -セル値を設定します（簡単にするために、セルは文字列値のみを受け入れると信じています！）、
• insertValues（int top、int left、String [] [] value）-2次元配列の値（たとえば、クリップボードから取得）をセルに貼り付けます。
• setRowHeight（int row、int height） 、 setColWidth（int col、int width） -行の高さと列の幅を設定し、
• insertColumnLeft（int colNum） 、 insertRowAbove（int rowNum） -列と行を挿入し、
• deleteColumn（int colNum） 、 deleteRow（int rowNum） -列と行を削除し、
• moveColumn（int from、int to） 、 moveRow（int from、int to） -列と行をコンテンツとともに移動し、最終的な列/行のコンテンツを置き換えます。

もちろん、実際のアプリケーションでは、さらに多くの可能性があります。 これらはそれぞれ、対応するチームのクラス（後で説明します）と一致する必要があり、メソッドは特別な方法で書き換える必要があります。

スタックの取り消しとやり直し

線形Undoモデルでは、ドキュメントに対して実行されたアクションのシーケンスを保持するような方法で操作がキャンセルされます。 たとえば、最初に列がドキュメントに追加され、次に幅が変更された場合、これらの操作のキャンセルは逆の順序でのみ可能であり、返されるのは直接です。 したがって、キャンセルして復元する操作を格納するには、モデルのルートクラスの一部であるリンクリストで2つのスタックを使用するのが自然です。 モデルの状態を変更するメソッドが呼び出されると、Redoスタックがリセットされ、Undoスタックが次の値で補充されます。 Undoコマンドを実行すると、Undoスタックから値が取得され、Redoスタックにプッシュされます。 やり直しコマンドの実行は、もしあれば、再び値を元に戻すスタックに戻す必要があります（図を参照）。



これらのスタックの内容は、 Commandクラスの子孫オブジェクトです。これについては後で説明します。 以下は、Undo / Redoの機能へのアクセスを提供するビジネスロジックのルートクラスのパブリックメソッドのリストです。

• undo（） -モデルの状態を変更するメソッドを呼び出し、それをRedoスタックに転送することにより実行されたアクションを取り消します。
  
  

  Command cmd = undoStack.pop(); cmd.undo(); redoStack.push(cmd); 

  
  繰り返される呼び出しはそれぞれ、Undoスタックが使い果たされるまでチェーン内の変更をロールバックし、スタックが使い果たされた後、メソッドの繰り返し呼び出しは何もしません。
  
• redo（） -元に戻す呼び出しによってキャンセルされたアクションを返し、元に戻すスタックに戻します。 繰り返される呼び出しは、Redoスタックが使い果たされるまでUndoによって取り消された操作をロールオーバーします。その後、redo（）の呼び出しは無視されます。 モデルの状態を変更するメソッドを呼び出すと、Redoスタック全体がリセットされます。
• getUndoStack（） 、 getRedoStack（） -ユーザーがキャンセルまたは再試行できる操作のリストを作成できるように、スタック全体を返します。
• isUndoActive（） 、 setUndoActive（ブール値）-Undoメカニズムを無効にできます（デフォルトで有効）。 1）ドキュメントの状態を非常に大きく変更する場合のパフォーマンスの向上とメモリ消費の削減2）Undo / Redo機能が利用できないインターフェイスを介して外部アプリケーションからドキュメントを操作する必要があります。

チームパターン

モデルの状態を変更するメソッドは、さまざまなパラメーターを持ち、通常はモデルのさまざまなクラスで定義できます。 パラメータとメソッドのターゲットオブジェクトに関する情報を完全にカプセル化することで、「すべてを1つの櫛の下で櫛形にする」ことができ、設計パターンを「チーム」にすることができます。 このパターンの非自明性は、一部のエンティティが通常、オブジェクト指向コードでクラスを記述するという事実にあります。 ここでは、クラスは本質ではなく、モデルの状態を変更するメソッドによって実行されるアクションを記述し、メソッド自体からこの特権を「取得」します。

各コマンドのクラスは、基本抽象クラスCommandから継承します。 コマンド自体には、 execute 、 undo 、およびgetDescriptionの 3つの抽象メソッドのみがあります。これらのパラメーターはありません（重要です！）。 これにより、実行またはキャンセルされた操作について「何も知らない」ルートクラスのundo（）およびredo（）メソッドを使用してコマンドを実行およびキャンセルできます。 getDescription（）メソッドは、アクションのテキスト説明を返す必要があります。この説明は、キャンセルするアクションのリストでユーザーが利用できます。



Commandクラスの継承者は、その抽象メソッドの実装に加えて、コマンド起動パラメーターに関する情報と、既に実行されたコマンドをキャンセルし、実行されたコマンドのテキスト説明を表示するために必要な情報を含む任意の数の追加フィールドを含むことができます。 この場合、 execute（）メソッドには、通常、モデルの状態を変更するメソッドに含まれるコードが含まれている必要がありますが、メソッドコードの代わりにこのコードはコマンドクラスのフィールドを使用する必要があります。 チームは、以前の方法と同じ方法で、モデルオブジェクトの内部状態を操作します。 したがって、チームはモデルオブジェクトの非表示（プライベート）フィールドにアクセスできる必要があります。 Javaでは、対応するモデルクラスにコマンドの子孫クラスをネストする場合に便利です。 たとえば、アプリケーションでは、 SetSizeコマンドは AxisElementモデルクラスにネストされ、残りのコマンドはWorksheetにネストされています 。

undo（）メソッドは、 execute（）メソッドを呼び出した結果を取り消すことができるはずです。 これに必要なすべての情報は、チームクラスのフィールドに保存する必要があります。 undo（）メソッドが呼び出された時点で、ビジネスロジックオブジェクトの状態は、対応するexecute（）メソッドの実行直後の状態と常に同じになることを理解すれば、問題は単純化されます。 その後、ユーザーが他の操作を実行した場合、現在のコマンドの取り消し（）を行う前に、その後に呼び出されたすべてのコマンドに対して取り消し（）を実行する必要があります。 実際には、この原則を理解すると、 undo（）メソッドの記述が非常に容易になり、コマンドに保存される情報量が削減されます。

セルの値を設定するコマンドの実装を検討してください。

  final class SetCellValue extends Command { private final int row; private final int col; private String val; public SetCellValue(int row, int col, String newValue) { this.row = row; this.col = col; this.val = newValue; } @Override public String getDescription() { return (" "); } private void changeVal() { String oldValue = getCellValue(row, col); Row r = rows.get(row); Column c = columns.get(col); //....   cell  row  col... cell.setValue(val); //.... val = oldValue; } @Override public void execute() { changeVal(); } @Override public void undo() { changeVal(); } } 

ご覧のとおり、このクラスには、セルのアドレスとその値を保存するための変数があります。 また、メモリを節約するために、値を保存する変数は1つだけです。execute（）メソッドがまだ実行されていない場合は新しい変数、 execute（）メソッドが既に実行されている場合は古い変数です。 つまり、 execute（）およびundo（）メソッドが順番に実行されるという事実がここで使用されます。 getDescription（）メソッドはクラス変数を使用して、コマンドのより詳細な説明を提供できます。

メソッドテンプレートのキャンセル

コマンドはキャンセル可能なメソッドでどのように使用されますか？ 通常、そのようなメソッドがパラメーターを考慮してモデルでいくつかのアクションを実行する場合、それらすべてを元に戻すシステムでは、厳密に次の3つの操作を実行する必要があります。

1. 対応するコマンドのインスタンスを作成します（ コマンドの子孫クラス）。
2. メソッドパラメータと場合によっては追加情報でコマンドフィールドを初期化します。
3. ルートオブジェクトのexecute（Command cmd）メソッドを実行し、新しく作成および初期化されたコマンドをパラメーターとして渡します。

この例では、 setCellValueメソッドの実装は次のようになります。

 public void setCellValue(int row, int col, String value) { Command cmd = new SetCellValue(row, col, value); execute(cmd); } 

他のすべてのキャンセル可能なメソッドは似ています。

ルートクラスのexecute（Command cmd）メソッドはコマンドアクションを実行し、REDOスタックをダンプし、コマンドを元に戻すスタックにプッシュします。

  undoStack.push(cmd); redoStack.clear(); cmd.execute(); 

この瞬間から、チームはキャンセル/繰り返されるアクションのチェーンの一部になります。 上記のように、ルートクラスでundo（）メソッドを呼び出すと、Undoスタックの最上部にあるコマンドのundo（）メソッドが呼び出され、Redoスタックに転送されます。 次に、ルートクラスのredo（）メソッドを呼び出すと、Redoスタックの最上部でコマンドのexecute（）メソッドが実行され、Undoスタックにプッシュされます。

コマンドクラスの再利用

そのため、通常は1つのメソッドを記述する必要があるタスクの場合、元に戻す機能を備えたシステムでは、クラス全体を作成する必要があります。これにより、コードの量とそのサポートの複雑さについて正当な恐れが生じます。実際のプロジェクトでは、キャンセルされたメソッドの数は数十になります。

実際、コマンドクラスは、その汎用性と複数のキャンセルされたメソッドに1つのコマンドクラスを使用しているため、大幅に小さくなります。 たとえば、実際には、 SetCellValueクラスのメインコードは、変数の1つの値を変更するすべてのメソッドに使用できます。 フィールドを追加するか、クラスをパラメーター化することで、コマンドクラスをより汎用的にすることができます。

たとえば、テーブルの行と列の両方を削除するために使用されるユニバーサル削除コマンドを考えます。

  final class Delete<T extends AxisElement> extends Command { private final int num; private final T deleted; private final TreeMap<Integer, T> map; Delete(TreeMap<Integer, T> map, int num) { this.num = num; this.map = map; deleted = map.get(num); } @Override public String getDescription() { return String.format(" %s %d", map == columns ? "" : "", num); } @Override public void execute() { internalDelete(map, num); } @Override public void undo() { internalInsert(map, num); map.put(num, deleted); } } private static <T extends AxisElement> void internalDelete(TreeMap<Integer, T> map, int num) { //... //      num //      > num     //... } private static <T extends AxisElement> void internalInsert(TreeMap<Integer, T> map, int num) { //... //     >= num     //... } } 

deleteColumnおよびdeleteRowメソッドでの使用は次のとおりです。

  public void deleteColumn(int colNum) { Command cmd = new Delete<Column>(columns, colNum); execute(cmd); } public void deleteRow(int rowNum) { Command cmd = new Delete<Row>(rows, rowNum); execute(cmd); } 

マクロ

状態を変更するメソッド呼び出しが、Undoスタックに格納するには単位が小さすぎることが判明する場合があります。 2次元リスト（クリップボードなど）からドキュメントに値を貼り付けるには、プロシージャinsertValues（int top、int left、String [] [] value）を検討してください。 ループ内のこのプロシージャは、バッファのセルの値でドキュメントセルを1つずつ更新します。 したがって、4×4テーブルの一部を挿入すると、元に戻すメカニズムの観点から、ドキュメントセルに16の変更が加えられます。 これは、ユーザーが挿入の結果をキャンセルする場合、[元に戻す]ボタンを16回押す必要がありますが、表では、16個のセルが以前の値を次々と復元することを意味します。

もちろん、これは間違っています。このような操作の結果は、キャンセルして全体として復元し、キャンセルされた操作のリストに1行で表示する必要があります。 これを可能にするために、マクロが使用されます。

マクロを実装するという考え方は単純です。これは、図に示すように、 コマンドクラスの特別な子孫であり、その中に他のコマンドのチェーンが含まれています。



MacroCommandクラスのexecute（）メソッドは、独自のコマンドリストを実行し、それらのexecute（）メソッドを実行します。 同じマクロのundo（）メソッドを呼び出すと、同じコマンドのリストを逆の順序で実行し、それらのundo（）メソッドを呼び出します。

モデル/ビュー/コントローラーアーキテクチャで構築されたアプリケーションのクリップボードペーストメソッドに類似したマクロメソッドは、原則としてモデルの一部ではありませんが、コントローラーレベルで実装されます。 多くの場合、これらは、ある種の日常的な作業の自動化のみを表し、その必要性は、ユーザーインターフェイスの種類に応じて、存在する場合と存在しない場合があります。 さらに、多くの場合、複数のユーザーアクションを1つにグループ化する必要があります。たとえば、テキストエディターは、個々の文字を入力するためのエントリで元に戻すスタックを詰まらせるのではなく、単語と文のユーザー入力を1つのマクロアクションにグループ化します。

したがって、マクロサポートは、アプリケーションに依存しない方法で、抽象レベルで実装できます。 これは、パブリックメソッドbeginMacro（文字列の説明）とendMacro（）をモデルルートクラスに追加することで実行されます。 メソッドは、マクロアクションの前後に呼び出されます。 beginMacro（...）を、キャンセルされた操作のリストでユーザーが使用できる文字列パラメーターで呼び出すことにより、 MacroCommand型のオブジェクトを生成し、Undoスタックを内部マクロスタックで一時的に置き換えます。 したがって、beginMacroを呼び出した後、ルートクラスのexecute（...）メソッドにコマンドを転送すると、Undoスタックに直接書き込まれるのではなく、現在のマクロの内部スタックに書き込まれます（順番に、すでにUndoスタックに書き込まれます） ） endMacro（）呼び出しは、すべてをその場所に戻します。 マクロを相互にマルチレベルでネストすることもできます。

未保存の変更を追跡する

元に戻す機能を使用すると、ドキュメントに保存されていない変更を追跡する信頼できる方法が提供されます。 これは、アプリケーションの「保存」ボタンの正しい動作を実装するために必要です。

1. 「保存」ボタンは、未保存の変更が存在する場合にのみアクティブにする必要があります（そうでない場合は保存する必要はありません。ドキュメントは変更されていません）。
2. ドキュメントを閉じるときに、未保存の変更が存在する場合にのみ変更を保存するかどうかをユーザーに尋ねることは理にかなっています。

この例では、未保存の変更の存在がisModified（）メソッドによって返されます。 次のように実装されます。save （...）メソッドが呼び出されるたびに、Undoスタックの現在のトップがlastSavedPoint変数に保存されます。 isModifiedメソッドが呼び出されると、 Undoスタックの現在のトップがlastSavedPoint値と比較されます。等しい場合、保存されていない変更はありません。 元に戻すメカニズムを無効にすると、 isModified（）メソッドは常にtrueを返します 。

おわりに

私たちの意見では、他のプロジェクトのテンプレートとして十分に普遍的な例を使用して、線形マルチレベルの元に戻す/やり直しを実装するための基本原則を検討しました。

元に戻すとやり直しの機能が、アプリケーションのアーキテクチャと開発者のプロ意識に対して非常に深刻な要求をすることは驚くことではありません。 しかし、Model / View / Controllerアーキテクチャの厳密な遵守や適切に設計されたモデル（システムのモデルの状態を変更するメソッドを元に戻すことは「費用がかかる」）など、面倒な作業にもかかわらず、作成中のプログラムの高品質と信頼性が得られます。最終的にはユーザーの満足につながります。

* * *

この記事で説明されている例の完全なソースコードと対応する単体テストはhttps://github.com/inponomarev/undoredoで入手でき、Mavenを使用してコンパイルおよび実行できます。