【実務・中級編】【中級者・実務】VB.NETとWPFでのDataGrid一括編集・行追加・行削除:DataTableバインディング時のトラブルシューティング – Visual Basic (VB / VB.NET)解析バイブル

スポンサーリンク
スポンサーリンク

DataGridとDataTableの「不協和音」を制する:堅牢な業務システムのためのデータ同期設計論

業務アプリケーションの開発において、WPFの`DataGrid`とADO.NETの`DataTable`の組み合わせは、いわば「標準装備」だ。大量のデータをグリッドに流し込み、ユーザーに編集させ、その結果をデータベースへ書き戻す。この一連の流れは、一見すると極めて単純に見える。

しかし、現場で「動くもの」を作っている初級者と、「壊れないもの」を作るプロフェッショナルの間には、決定的な設計思想の差がある。

多くの開発者が、行の削除時に`IndexOutOfRangeException`に泣き、一括更新時に「どの行が変更されたか分からない」という泥沼に陥り、あるいはUIスレッドをブロックしてアプリケーションをフリーズさせる。

本稿では、DataTableバインディングにおける罠を解剖し、プロフェッショナルが実践する「データ整合性を担保した一括編集・同期テクニック」を伝授する。

1. 致命的な誤解:View(UI)を操作してはいけない

まず、最も重要な原則を叩き込んでおく。
「DataGridのアイテムを直接操作しようとするな。操作すべきは、その背後にあるデータソース(DataTable)のみである」

初心者がやりがちなミスは、`DataGrid.Items.RemoveAt(index)` のように、UIコントロールに対して直接命令を下すことだ。これは設計として極めて脆弱である。なぜなら、WPFのデータバインディングは「データソースの状態をViewに反映させる」ものであり、その逆(Viewの状態をデータに強制同期させる)は、バインディングのライフサイクルを破壊するリスクを孕んでいるからだ。

修正すべき設計思想

  • ❌ 誤ったアプローチ: `DataGrid` の選択行を取得し、そのインデックスを使って `DataGrid.Items` から削除する。
  • ✅ 正しいアプローチ: `DataGrid.SelectedItem` から `DataRowView` を取得し、その背後にある `DataRow.Delete()` を呼び出す。

この差が、`DataTable` が持つ「変更履歴(RowState)」を正しく維持できるかどうかの分かれ目となる。

2. DataTableのライフサイクルとRowStateの掌握

`DataTable` を使う最大のメリットは、各行が `Unchanged`, `Added`, `Modified`, `Deleted` という「状態(`DataRowState`)」を自律的に管理している点にある。

一括編集を実現する場合、この `RowState` をいかに汚さず、かつ正確に収集するかが鍵となる。ここで多くの開発者が犯す最大のミスが、「更新前に `DataTable.AcceptChanges()` を呼んでしまうこと」だ。

`AcceptChanges()` を呼んだ瞬間、すべての行のステータスは `Unchanged` にリセットされる。つまり、データベースに送るべき「変更の差分」が消失するのだ。

堅牢な更新フローの黄金律

1. 編集フェーズ: ユーザーが `DataGrid` 上で加えた変更は、`DataTable` の `RowState` に蓄積される。
2. 検証フェーズ: `DataTable.GetChanges()` メソッドを使用し、変更があった行(差分)だけを抽出する。
3. 永続化フェーズ: 抽出した差分に対して、SQL(またはORM)を実行する。
4. 確定フェーズ: データベースへの書き込みが成功した後で初めて、`DataTable.AcceptChanges()` を呼び出し、メモリ上の状態を確定させる。

3. 実践:プロダクションレベルのDataGridマネージャー

以下に、単なるコードの断片ではなく、保守性と堅牢性を考慮した `DataGridManager` の実装例を示す。ここでは、行の追加、削除、およびデータベースへの安全な一括保存のロジックをカプセル化している。

Imports System.Data
Imports System.Data.SqlClient

''' <summary>
''' DataGridとDataTableの同期および一括更新を制御するマネージャークラス。
''' UI操作ではなく、データソースの整合性を守ることに特化する。
''' </summary>
Public Class DataGridManager
    Private ReadOnly _dataTable As DataTable
    Private ReadOnly _connectionString As String

    Public Property DataTable As DataTable
        Get
            Return _dataTable
        End Get
    End Property

    Public Sub New(dt As DataTable, connectionString As String)
        _dataTable = dt
        _connectionString = connectionString
    End Sub

    ''' <summary>
    ''' 新しい行を追加する。
    ''' DataGridにバインドされている場合、DataTableへの追加は自動的にUIに反映される。
    ''' </summary>
    Public Sub AddNewRow()
        ' DataRowの生成と追加をアトミックに行う
        Dim newRow As DataRow = _dataTable.NewRow()
        
        ' 必要に応じてデフォルト値を設定
        ' newRow("CreatedDate") = DateTime.Now
        
        _dataTable.Rows.Add(newRow)
    End Sub

    ''' <summary>
    ''' 選択された行を削除する。
    ''' 直接Rows.Removeするのではなく、Deleteメソッドを使用することで
    ''' RowStateを「Deleted」に保ち、後の一括更新で検知可能にする。
    ''' </summary>
    ''' <param name="rowView">DataGridから渡されるDataRowView</param>
    Public Sub DeleteSelectedRow(rowView As DataRowView)
        If rowView Is Nothing Then Return

        ' RowStateをDeletedにする。これにより、GetChanges()で抽出対象となる。
        rowView.Row.Delete()
    End Sub

    ''' <summary>
    ''' 変更された差分のみをデータベースへ反映する。
    ''' </summary>
    <System.Threading.Tasks.Task>
    Public Async Function SaveChangesAsync() As Task(Of Boolean)
        ' 1. 変更された行(差分)の抽出
        Dim changesTable As DataTable = _dataTable.GetChanges()

        ' 変更がない場合は即座に終了
        If changesTable Is Nothing Then Return True

        Try
            Using conn As New SqlConnection(_connectionString)
                Await conn.OpenAsync()
                ' トランザクションの開始:一括処理の原子性を保証する
                Using transaction As SqlTransaction = conn.BeginTransaction()
                    Try
                        ' ここでは簡易的な実装例として、DataTableDataAdapterを使用する。
                        ' 実務では、より高度なマッピングや、ストアドプロシージャの呼び出しを行う。
                        Using adapter As New SqlDataAdapter()
                            ' ※本来はCommandBuilder等を用いて、Insert/Update/Deleteコマンドを構成する
                            ' ここでは概念を示すための記述とする
                            
                            ' 変更内容をDBへ反映
                            ' adapter.Update(_dataTable) 
                            
                            ' --- プロフェッショナルのためのアドバイス ---
                            ' 大規模データの場合、adapter.Updateではなく、
                            ' Table-Valued Parameters (TVP) を用いて一括でストアドに渡す手法が
                            ' パフォーマンスと安全性の観点から最も優れている。
                            ' ---------------------------------------

                            Await Task.Run(Sub()
                                            ' 擬似的なDB書き込み処理
                                            Threading.Thread.Sleep(1000) 
                                        End Sub)

                            transaction.Commit()
                        End Using

                        ' 2. DBへの書き込みが成功した後に、メモリ上の変更を確定させる
                        _dataTable.AcceptChanges()
                        Return True

                    Catch ex As Exception
                        transaction.Rollback()
                        Throw New Exception("データベース更新中にエラーが発生しました。ロールバックを実行しました。", ex)
                    End Try
                End Using
            End Using
        Catch ex As Exception
            ' ロギング処理をここに入れる
            Debug.WriteLine($"Critical Error: {ex.Message}")
            Return False
        End Try
    End Function
End Class

実装のポイント解説

1. `DeleteSelectedRow` の設計: `Rows.Remove()` ではなく `Row.Delete()` を使っている点に注目してほしい。これにより、行は物理的に消えるのではなく「削除予定」という状態になり、`GetChanges()` を通じて `DELETE` 文の発行対象として認識される。
2. トランザクションの強制: 業務システムにおいて、一部の行だけ更新されて他が失敗するという事態は、データの整合性を破壊する「災厄」だ。必ず `SqlTransaction` を用い、全操作が成功するか、全操作が破棄されるかのどちらか(Atomicity)を保証せよ。
3. `AcceptChanges` のタイミング: これを `Save` メソッドの最後、つまり「DBへの書き込み成功後」に配置している。これが、メモリ上のデータとDBのデータを同期させる唯一の正しいタイミングだ。

4. トラブルシューティング:実務で遭遇する「3つの壁」

壁①:`IndexOutOfRangeException`

原因: `foreach` ループの中で `DataTable.Rows.Remove()` を実行している。
対策: 削除対象のインデックスを一度リストに格納してから逆順で回すか、前述のように `GetChanges()` で取得した差分に対して処理を行うこと。

壁②:UIのフリーズ(応答なし)

原因: `DataTable` の更新や、大規模なDBアクセスをUIスレッド(メインスレッド)で行っている。
対策: `Task.Run` や `async/await` を活用し、データアクセス層を非同期化せよ。ただし、`DataTable` 自体はスレッドセーフではないため、UIスレッドから離れた場所で `DataTable` を直接操作する際は、排他制御(`lock`)または Dispatcher を介したアクセスを忘れてはならない。

壁③:Null値による例外

原因: `DataTable` の列が `AllowDBNull = true` なのに、コード内で `row[“Column”]` を直接参照し、`DBNull.Value` を考慮せずにキャストしている。
対策: `row.IsNull(“ColumnName”)` でチェックを行うか、拡張メソッドを作成して安全にキャストする癖をつけろ。

結論:設計は「守り」から始まる

WPFとDataTableを用いた開発において、優れたエンジニアは「いかに簡単に書くか」ではなく、「いかにデータの整合性を壊さないか」に思考の比重を置く。

`RowState` を理解し、トランザクションを制御し、ViewとModelを明確に分離する。この一見遠回りに見える作法こそが、数ヶ月後の保守フェーズで、深夜の障害対応に追われないための唯一の防壁となるのだ。

君が書くコードが、単なる「動くコード」ではなく、堅牢な「システム」であることを期待している。

タイトルとURLをコピーしました