トランザクションを使用してモデルを更新する

2025-06-12

トランザクションでは、ストアに加えられた変更がグループとして扱われます。グループ化された変更は、単一のユニットとしてコミットまたはロールバックできます。

プログラムコードで Visual Studio の視覚化およびモデリング SDK のストアの要素を変更、追加、または削除するときは、常にトランザクション内で実行する必要があります。変更が発生するときに、ストアに関連付けられている Transaction のアクティブなインスタンスが存在している必要があります。これは、すべてのモデル要素、リレーションシップ、図形、図、およびそれらのプロパティに適用されます。

トランザクションメカニズムは、一貫性のない状態を回避するのに役立ちます。トランザクションの実行中にエラーが発生した場合は、すべての変更がロールバックされます。ユーザーが元に戻すコマンドを実行した場合は、最近のトランザクションがそれぞれ単一の手順として処理されます。最近の変更が別個のトランザクションに明示的に配置されていない限り、ユーザーは変更の一部を元に戻すことはできません。

トランザクションを開く

トランザクションを管理する最も便利な方法は、try...catch ステートメントの中で using ステートメントを使用することです。

Store store; ...
try
{
  using (Transaction transaction =
    store.TransactionManager.BeginTransaction("update model"))
    // Outermost transaction must always have a name.
  {
    // Make several changes in Store:
    Person p = new Person(store);
    p.FamilyTreeModel = familyTree;
    p.Name = "Edward VI";
    // end of changes to Store

    transaction.Commit(); // Don't forget this!
  } // transaction disposed here
}
catch (Exception ex)
{
  // If an exception occurs, the Store will be
  // rolled back to its previous state.
}

変更中に最後の Commit() を妨げる例外が発生した場合、ストアは前の状態にリセットされます。これにより、エラーによってモデルが不整合な状態にならないようにすることができます。

1 つのトランザクション内で任意の数の変更を行うことができます。アクティブなトランザクション内で新しいトランザクションを開くことができます。入れ子になったトランザクションは、親トランザクションが終了する前にコミットまたはロールバックする必要があります。詳細については、TransactionDepth プロパティの例を参照してください。

変更を永続的なものにするには、トランザクションが破棄される前にトランザクションの Commit を実行する必要があります。トランザクション内でキャッチされない例外が発生した場合、ストアは変更前の状態にリセットされます。

トランザクションのロールバック

ストアをトランザクション実行前の状態のままにするか、その状態に戻すには、次のいずれかの方法を使用できます。

トランザクションのスコープ内でキャッチされない例外を発生させます。
トランザクションを明示的にロールバックします。
```
this.Store.TransactionManager.CurrentTransaction.Rollback();
```

トランザクションはストア以外のオブジェクトには影響しない

トランザクションでは、ストアの状態のみが制御されます。ファイル、データベース、または DSL 定義の外部で通常の型で宣言したオブジェクトなど、外部項目に対して行われた部分的な変更を元に戻すことはできません。

例外によってストアとの一貫性を欠く変更が残る可能性がある場合は、その可能性を例外ハンドラーで処理する必要があります。外部リソースとストアオブジェクトが確実に同期されるようにする方法の 1 つは、イベントハンドラーを使用して、各外部オブジェクトをストア内の要素に結合することです。詳細については、「イベントハンドラーによって変更がモデル外に反映される」を参照してください。

ルールはトランザクションの終了時に起動される

トランザクションの最後、トランザクションが破棄される前に、ストア内の要素に関連付けられているルールが起動されます。各ルールは、変更されたモデル要素に適用されるメソッドです。たとえば、モデル要素が変更されたときに図形の状態を更新し、モデル要素が作成されたときに図形を作成する "修正" ルールがあります。起動順序は指定されていません。ルールによって行われた変更によって、別のルールを起動できます。

独自のルールを定義できます。ルールの詳細については、「変更に対する応答と反映」を参照してください。

元に戻す、やり直す、またはロールバックするためのコマンドを実行しても、ルールは起動されません。

トランザクションコンテキスト

各トランザクションには、必要なすべての情報を格納できるディクショナリがあります。

store.TransactionManager

.CurrentTransaction.TopLevelTransaction

.Context.Add(aKey, aValue);

これは、ルール間で情報を転送する場合に特に便利です。

トランザクションの状態

場合によっては、トランザクションを元に戻す操作またはやり直す操作によって変更が発生した場合に、変更が反映されないようにする必要があります。これは、たとえば、ストア内の別の値を更新できるプロパティ値ハンドラーを記述した場合に発生する可能性があります。元に戻す操作では、ストア内のすべての値が以前の状態にリセットされるので、更新された値を計算する必要はありません。次のコードを使用します。

if (!this.Store.InUndoRedoOrRollback) {...}

ストアが最初にファイルから読み込まれたときにルールが起動される可能性があります。これらの変更に対する応答を回避するには、以下を使用します。

if (!this.Store.InSerializationTransaction) {...}

次の方法で共有