.NET Framework データベースアプリケーションでコンカレンシー例外を処理する

[アーティクル]
10/20/2023

Note

データセットと関連クラスは、アプリケーションがデータベースから切断されている間にアプリケーションがメモリ内のデータを操作できるようにする、2000 年代初期からのレガシ .NET Framework テクノロジです。テクノロジが特に役立つのは、ユーザーがデータを変更し、変更をデータベースに戻して保持できるようにするアプリケーションです。データセットは非常に優れたテクノロジであることが証明されていますが、新しい .NET アプリケーションでは Entity Framework Core を使用することをお勧めしています。 Entity Framework には、オブジェクトモデルとして表形式データを操作する、より自然な方法が用意されており、よりシンプルなプログラミングインターフェイスが備わっています。

2 人のユーザーが同じデータベースの同じデータを同時に変更しようとすると、コンカレンシー例外 (System.Data.DBConcurrencyException) が発生します。このチュートリアルでは、DBConcurrencyException をキャッチする方法、エラーの原因となった行を特定する方法、およびその処理方法を説明する Windows アプリケーションを作成します。

ここでは次の手順を実行します。

新しい [Windows フォームアプリ (.NET Framework)] プロジェクトを作成します。
Northwind の Customers テーブルに基づいて、新しいデータセットを作成します。
データを表示する DataGridView を備えたフォームを作成します。
Northwind データベースの Customers テーブルからデータセットにデータを読み込みます。
サーバーエクスプローラーの [テーブルデータの表示] 機能を使用して Customers テーブルのデータにアクセスし、レコードを変更します。
同じレコードを別の値に変更し、データセットを更新し、変更内容をデータベースに書き込もうとします。これにより、コンカレンシーエラーが発生します。
エラーをキャッチし、操作を継続してデータベースを更新するか、または更新をキャンセルするかを判断できるように、レコードの異なるバージョンを表示します。

必須コンポーネント

このチュートリアルでは SQL Server Express LocalDB と Northwind サンプルデータベースを使用します。

SQL Server Express LocalDB がない場合は、SQL Server Express のダウンロードページからインストールするか、Visual Studio インストーラーを使用してインストールします。 Visual Studio インストーラーでは、データストレージとデータ処理ワークロードの一部として、または個別のコンポーネントとして、SQL Server Express LocalDB をインストールできます。
次の手順に従って、Northwind サンプルデータベースをインストールします。
1. Visual Studio で、 [SQL Server オブジェクトエクスプローラー] ウィンドウを開きます。 (SQL Server オブジェクトエクスプローラーは、Visual Studio インストーラーのデータストレージとデータ処理ワークロードの一部としてインストールされます)。 [SQL Server] ノードを展開します。 LocalDB インスタンスを右クリックし、 [新しいクエリ] を選択します。
  
  クエリエディターウィンドウが開きます。
2. Northwind Transact-SQL スクリプトをクリップボードにコピーします。この T-SQL スクリプトを使用すると、Northwind データベースが新規作成され、データが設定されます。
3. T-SQL スクリプトをクエリエディターに貼り付け、 [実行] ボタンを選択します。
  
  しばらくすると、クエリの実行が完了し、Northwind データベースが作成されます。

新しいプロジェクトを作成する

最初に、次のようにして新しい Windows フォームアプリケーションを作成します。

Visual Studio の [ファイル] メニューで､ [新規作成]>[プロジェクト] を選択します。
左側のペインで [Visual C#] または [Visual Basic] を展開し、 [Windows デスクトップ] を選択します。
中央のペインで、 [Windows フォームアプリ] プロジェクトタイプを選択します。
プロジェクトに ConcurrencyWalkthrough という名前を付け、 [OK] を選択します。

ConcurrencyWalkthrough プロジェクトが作成されてソリューションエクスプローラーに追加され、デザイナーで新しいフォームが開きます。

Northwind データセットを作成する

次に、NorthwindDataSet という名前のデータセットを作成します。

[データ] メニューの [新しいデータソースの追加] を選択します。

データソース構成ウィザードが開きます。
[データソースの種類の選択] 画面で、 [データベース] を選択します。
使用可能な接続の一覧から、Northwind サンプルデータベースへの接続を選択します。接続の一覧で接続が使用できない場合は、 [新しい接続] を選択します。

Note

ローカルデータベースファイルに接続する場合は、プロジェクトにファイルを追加するかどうかをたずねるメッセージが表示されたときに [いいえ] を選択します。
[アプリケーション構成ファイルに接続文字列を保存] 画面で、 [次へ] を選択します。
[テーブル] ノードを展開し、Customers テーブルを選択します。既定のデータセット名は、NorthwindDataSet です。
[完了] を選択して、プロジェクトにデータセットを追加します。

データバインド DataGridView コントロールを作成する

ここでは、 [データソース] ウィンドウから Windows フォームに Customers 項目をドラッグして、System.Windows.Forms.DataGridView を作成します。

[データソース] ウィンドウを開くには、 [データ] メニューの [データソースの表示] を選択します。
[データソース] ウィンドウの [NorthwindDataSet] ノードを展開し、Customers テーブルを選択します。
テーブルノードの下向き矢印を選択し、ドロップダウンリストの [DataGridView] を選択します。
テーブルをフォームの空の領域にドラッグします。

CustomersDataGridView という名前の DataGridView コントロールと、CustomersBindingNavigator という名前の BindingNavigator が、BindingSource にバインドされているフォームに追加されます。次に、NorthwindDataSet の Customers テーブルにバインドされます。

フォームをテストする

フォームをテストして、ここまでの設定が期待どおりに動作することを確認します。

F5 キーを選択してアプリケーションを実行します。

フォームは、Customers テーブルのデータが読み込まれた状態で DataGridView コントロールに表示されます。
[デバッグ] メニューの [デバッグの停止] を選択します。

コンカレンシーエラーを処理する

エラーを処理する方法は、アプリケーションを管理するそれぞれのビジネスルールによって異なります。このチュートリアルでは、コンカレンシーエラーを処理する方法の例として、次の方法を使用します。

アプリケーションでは、ユーザーに対して次の 3 つのバージョンのレコードが用意されます。

データベース内の現在のレコード
データセットに読み込まれた元のレコード
データセット内の提案された変更

ユーザーは、提案されたバージョンでデータベースを上書きするか、更新をキャンセルし、データベースから新しい値をデータセットに再読み込むことができます。

コンカレンシーエラーを処理できるようにするには

カスタムエラーハンドラーの作成
ユーザーに対する選択肢の表示
ユーザーの応答の処理
更新の再送、またはデータセット内のデータのリセット

コンカレンシー例外を処理するコードを追加する

更新の実行を試みると例外が発生する場合、通常は、発生した例外によって提供される情報に対して何らかの対処を行います。このセクションでは、データベースの更新を試みるコードを追加します。また、発生する可能性がある DBConcurrencyException や、その他の例外も処理します。

注意

チュートリアルの後半では、CreateMessage メソッドと ProcessDialogResults メソッドを追加します。

Form1_Load メソッドの下に次のコードを追加します。

private void UpdateDatabase()
{
    try
    {
        this.customersTableAdapter.Update(this.northwindDataSet.Customers);
        MessageBox.Show("Update successful");
    }
    catch (DBConcurrencyException dbcx)
    {
        DialogResult response = MessageBox.Show(CreateMessage((NorthwindDataSet.CustomersRow)
            (dbcx.Row)), "Concurrency Exception", MessageBoxButtons.YesNo);

        ProcessDialogResult(response);
    }
    catch (Exception ex)
    {
        MessageBox.Show("An error was thrown while attempting to update the database.");
    }
}

Private Sub UpdateDatabase()

    Try
        Me.CustomersTableAdapter.Update(Me.NorthwindDataSet.Customers)
        MsgBox("Update successful")

    Catch dbcx As Data.DBConcurrencyException
        Dim response As Windows.Forms.DialogResult

        response = MessageBox.Show(CreateMessage(CType(dbcx.Row, NorthwindDataSet.CustomersRow)),
            "Concurrency Exception", MessageBoxButtons.YesNo)

        ProcessDialogResult(response)

    Catch ex As Exception
        MsgBox("An error was thrown while attempting to update the database.")
    End Try
End Sub

次のように CustomersBindingNavigatorSaveItem_Click メソッドを UpdateDatabase メソッドの呼び出しに置き換えます。

private void customersBindingNavigatorSaveItem_Click(object sender, EventArgs e)
{
    UpdateDatabase();
}

Private Sub CustomersBindingNavigatorSaveItem_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles CustomersBindingNavigatorSaveItem.Click
    UpdateDatabase()
End Sub

ユーザーに対する選択肢の表示

上のコードにより CreateMessage プロシージャが呼び出され、ユーザーにエラー情報が表示されます。このチュートリアルでは、メッセージボックスを使用して、さまざまなバージョンのレコードをユーザーに表示します。これにより、ユーザーは、レコードを変更内容で上書きするか、編集をキャンセルするかを選択できます。ユーザーがメッセージボックスのオプションを選択する (ボタンをクリックする) と、ProcessDialogResult メソッドに応答が渡されます。

コードエディターに次のコードを追加して、メッセージを作成します。このコードは、UpdateDatabase メソッドの下に入力します。

private string CreateMessage(NorthwindDataSet.CustomersRow cr)
{
    return
        "Database: " + GetRowData(GetCurrentRowInDB(cr), DataRowVersion.Default) + "\n" +
        "Original: " + GetRowData(cr, DataRowVersion.Original) + "\n" +
        "Proposed: " + GetRowData(cr, DataRowVersion.Current) + "\n" +
        "Do you still want to update the database with the proposed value?";
}


//--------------------------------------------------------------------------
// This method loads a temporary table with current records from the database
// and returns the current values from the row that caused the exception.
//--------------------------------------------------------------------------
private NorthwindDataSet.CustomersDataTable tempCustomersDataTable = 
    new NorthwindDataSet.CustomersDataTable();

private NorthwindDataSet.CustomersRow GetCurrentRowInDB(NorthwindDataSet.CustomersRow RowWithError)
{
    this.customersTableAdapter.Fill(tempCustomersDataTable);

    NorthwindDataSet.CustomersRow currentRowInDb = 
        tempCustomersDataTable.FindByCustomerID(RowWithError.CustomerID);

    return currentRowInDb;
}


//--------------------------------------------------------------------------
// This method takes a CustomersRow and RowVersion 
// and returns a string of column values to display to the user.
//--------------------------------------------------------------------------
private string GetRowData(NorthwindDataSet.CustomersRow custRow, DataRowVersion RowVersion)
{
    string rowData = "";

    for (int i = 0; i < custRow.ItemArray.Length ; i++ )
    {
        rowData = rowData + custRow[i, RowVersion].ToString() + " ";
    }
    return rowData;
}

Private Function CreateMessage(ByVal cr As NorthwindDataSet.CustomersRow) As String
    Return "Database: " & GetRowData(GetCurrentRowInDB(cr), 
                                     Data.DataRowVersion.Default) & vbCrLf &
           "Original: " & GetRowData(cr, Data.DataRowVersion.Original) & vbCrLf &
           "Proposed: " & GetRowData(cr, Data.DataRowVersion.Current) & vbCrLf &
           "Do you still want to update the database with the proposed value?"
End Function


'--------------------------------------------------------------------------
' This method loads a temporary table with current records from the database
' and returns the current values from the row that caused the exception.
'--------------------------------------------------------------------------
Private TempCustomersDataTable As New NorthwindDataSet.CustomersDataTable

Private Function GetCurrentRowInDB(
    ByVal RowWithError As NorthwindDataSet.CustomersRow
    ) As NorthwindDataSet.CustomersRow

    Me.CustomersTableAdapter.Fill(TempCustomersDataTable)

    Dim currentRowInDb As NorthwindDataSet.CustomersRow =
        TempCustomersDataTable.FindByCustomerID(RowWithError.CustomerID)

    Return currentRowInDb
End Function


'--------------------------------------------------------------------------
' This method takes a CustomersRow and RowVersion 
' and returns a string of column values to display to the user.
'--------------------------------------------------------------------------
Private Function GetRowData(ByVal custRow As NorthwindDataSet.CustomersRow,
    ByVal RowVersion As Data.DataRowVersion) As String

    Dim rowData As String = ""

    For i As Integer = 0 To custRow.ItemArray.Length - 1
        rowData &= custRow.Item(i, RowVersion).ToString() & " "
    Next

    Return rowData
End Function

ユーザーの応答の処理

メッセージボックスへのユーザーの応答を処理するコードも必要です。オプションは、データベースの現在のレコードを提案された変更内容で上書きするか、またはローカルの変更内容を破棄し、データベースの現在のレコードでデータテーブルを更新するかのいずれかです。ユーザーが [はい] を選択した場合、preserveChanges 引数が true に設定された Merge メソッドが呼び出されます。この結果、レコードの元のバージョンがデータベースのレコードと一致するようになり、更新の試みは成功します。

前の手順で追加したコードの下に次のコードを追加します。

// This method takes the DialogResult selected by the user and updates the database 
// with the new values or cancels the update and resets the Customers table 
// (in the dataset) with the values currently in the database.

private void ProcessDialogResult(DialogResult response)
{
    switch (response)
    {
        case DialogResult.Yes:
            northwindDataSet.Merge(tempCustomersDataTable, true, MissingSchemaAction.Ignore);
            UpdateDatabase();
            break;

        case DialogResult.No:
            northwindDataSet.Merge(tempCustomersDataTable);
            MessageBox.Show("Update cancelled");
            break;
    }
}

' This method takes the DialogResult selected by the user and updates the database 
' with the new values or cancels the update and resets the Customers table 
' (in the dataset) with the values currently in the database.

Private Sub ProcessDialogResult(ByVal response As Windows.Forms.DialogResult)

    Select Case response

        Case Windows.Forms.DialogResult.Yes
            NorthwindDataSet.Customers.Merge(TempCustomersDataTable, True)
            UpdateDatabase()

        Case Windows.Forms.DialogResult.No
            NorthwindDataSet.Customers.Merge(TempCustomersDataTable)
            MsgBox("Update cancelled")
    End Select
End Sub

フォームの動作をテストする

フォームをテストして、期待どおりに動作することを確認します。コンカレンシー違反をシミュレートするには、NorthwindDataSet にデータを読み込んだ後で、データベースのデータを変更します。

F5 キーを選択してアプリケーションを実行します。
フォームが表示されたら、実行を継続したまま Visual Studio IDE に切り替えます。
[表示] メニューの [サーバーエクスプローラー] を選択します。
サーバーエクスプローラーで、アプリケーションで使用する接続を展開し、次に [テーブル] ノードを展開します。
Customers テーブルを右クリックし、 [テーブルデータの表示] を選択します。
最初のレコード (ALFKI) で、 [ContactName] を [Maria Anders2] に変更します。

注意

別の行に移動し、変更をコミットします。
ConcurrencyWalkthrough の実行フォームに切り替えます。
フォームの最初のレコード (ALFKI) で、 [ContactName] を [Maria Anders1] に変更します。
[保存] ボタンを選択します。

コンカレンシーエラーが発生し、メッセージボックスが表示されます。

[いいえ] を選択すると、更新がキャンセルされ、現在データベース内にある値でデータセットが更新されます。 [はい] を選択すると、提案された値がデータベースに書き込まれます。

データをデータベースに保存する

次の方法で共有

.NET Framework データベースアプリケーションでコンカレンシー例外を処理する

必須コンポーネント

新しいプロジェクトを作成する

Northwind データセットを作成する

データバインド DataGridView コントロールを作成する

フォームをテストする

コンカレンシーエラーを処理する

コンカレンシーエラーを処理できるようにするには

コンカレンシー例外を処理するコードを追加する

ユーザーに対する選択肢の表示

ユーザーの応答の処理

フォームの動作をテストする

フィードバック

その他のリソース

次の方法で共有

.NET Framework データベース アプリケーションでコンカレンシー例外を処理する

必須コンポーネント

新しいプロジェクトを作成する

Northwind データセットを作成する

データ バインド DataGridView コントロールを作成する

フォームをテストする

コンカレンシー エラーを処理する

コンカレンシー エラーを処理できるようにするには

コンカレンシー例外を処理するコードを追加する

ユーザーに対する選択肢の表示

ユーザーの応答の処理

フォームの動作をテストする

関連するコンテンツ

フィードバック

その他のリソース

.NET Framework データベースアプリケーションでコンカレンシー例外を処理する

データバインド DataGridView コントロールを作成する

コンカレンシーエラーを処理する

コンカレンシーエラーを処理できるようにするには