【テクニカル・上級編】【上級者向け】VB.NETとWPFにおけるCOMインターフェース・Excel/Interop操作時のスレッド競合とUIブロックの完全排除 – Visual Basic (VB / VB.NET)解析バイブル

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

COMインターフェースの呪縛を解く:WPFにおけるSTAスレッド管理とExcel操作の極致

レガシーな資産、すなわちVBAやCOMコンポーネントを、現代的なWPF(Windows Presentation Foundation)へと昇華させるプロセスは、単なる言語の書き換えではない。それは、「スレッドモデルの衝突」と「メモリ管理のパラダイムシフト」という、極めて危険な領域への踏み込みである。

多くのエンジニアが、`Task.Run` で Excel 操作をラップすれば UI が固まらないと誤解し、結果として「Excel プロセスがタスクマネージャーに居座り続ける」「ランダムなデッドロックでアプリが死ぬ」「COM例外がスレッド間を飛び交う」という地獄を招く。

本稿では、STA(Single-Threaded Apartment)という COM の鉄の掟を、いかにしてモダンな非同期プログラミング(async/await)の世界と調和させるか。その設計思想と実装の真髄を伝授する。

1. 衝突の正体:STA vs MTA

WPF の UI スレッドは STA (Single-Threaded Apartment) モデルで動作する。一方で、.NET の `Task.Run` が利用する ThreadPool は MTA (Multi-Threaded Apartment) モデルだ。

ここが最大の落とし穴である。Excel や多くのレガシーな COM コンポーネントは、自身が生成されたスレッド(STA)以外からの呼び出しを極端に嫌う。MTA スレッドから COM オブジェクトを操作しようとすると、スレッド間マーシャリングのオーバーヘッドが発生し、最悪の場合、スレッドのデッドロックを引き起こす。

「UI をブロックしないために `Task.Run` を使う」という行為が、COM 操作においては「動作の不安定化」という副作用を招くのだ。

2. 解決策:STA 専用ワーカー・スレッドの構築

我々が取るべき戦略は、「COM 操作専用の STA スレッドを隔離し、そこへタスクをキューイングする」というアーキテクチャである。

単に新しいスレッドを作るのではない。`TaskCompletionSource(Of T)` を活用し、非同期の `await` 構文を維持しながら、内部的には STA スレッドへ命令を送り、結果を待機する「非同期 STA ラッパー」を設計する必要がある。

実装例:StaTaskRunner

以下のコードは、任意の処理を STA スレッド上で実行し、その結果を非同期で返すためのコア・エンジンである。

Imports System.Threading
Imports System.Collections.Concurrent
Imports System.Threading.Tasks

''' <summary>
''' COM操作などのSTA環境を必要とする処理を、
''' 非同期(async/await)で安全に実行するための専用ランナー。
''' </summary>
Public Class StaTaskRunner
    Implements IDisposable

    ' STAスレッド専用のキュー
    Private ReadOnly _workQueue As New BlockingCollection(Of Action)()
    ' 専用スレッドの管理
    Private ReadOnly _staThread As Thread
    Private _isDisposed As Boolean = False

    Public Sub New()
        ' STAスレッドを明示的に生成
        _staThread = New Thread(AddressOf _processQueue)
        _staThread.SetApartmentState(ApartmentState.STA)
        _staThread.IsBackground = True
        _staThread.Start()
    End Sub

    ''' <summary>
    ''' STAスレッド上で処理を実行し、その結果をTaskとして返す。
    ''' </summary>
    Public Function ExecuteAsync(Of T)(Of func As Func(Of T)) As Task(Of T)
        Dim tcs As New TaskCompletionSource(Of T)()

        ' 実行したい処理をキューに投入
        _workQueue.Add(Sub()
                           Try
                               ' STAスレッド上で実際の処理を実行
                               Dim result = func()
                               tcs.SetResult(result)
                           Catch ex As Exception
                               ' 例外が発生した場合はTaskに伝播させる
                               tcs.SetException(ex)
                           End Try
                       End Sub)

        Return tcs.Task
    End Function

    ''' <summary>
    ''' 引数付きの処理を実行する場合
    ''' </summary>
    Public Function ExecuteAsync(Of T)(Of func As Action(Of T), param As T) As Task(Of T)
        ' (実装の簡略化のため、必要に応じて拡張せよ)
        Throw New NotImplementedException("高度な実装には型安全なデリゲート設計が必要")
    End Function

    ' 内部ループ:STAスレッドで常に待機し、キューからタスクを取り出す
    Private Sub _processQueue()
        Try
            For Each action In _workQueue.GetConsumingEnumerable()
                action.Invoke()
            Next
        Catch ex As Exception
            ' ロギング等の処理
        End Try
    End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        If Not _isDisposed Then
            _workQueue.CompleteAdding()
            _staThread.Join(2000) ' スレッドの終了を待機
            _workQueue.Dispose()
            _isDisposed = True
        End If
    End Sub
End Class

3. メモリの儀式:COM オブジェクトの明示的解放

STA スレッドの問題を解決しても、次に立ちはだかるのは 「Excel プロセスが残る」 という亡霊だ。

.NET のガベージコレクション (GC) は、COM オブジェクトの参照カウントを完全に管理できない。`Nothing` を代入しただけでは、COM 側での参照カウントは減らず、Excel はバックグラウンドで死に体として生き続ける。

これを防ぐには、「ボトムアップの解放」という儀式が必要である。
`Application` → `Workbook` → `Worksheet` → `Range` の順ではなく、`Range` → `Worksheet` → `Workbook` → `Application` の順で、一つずつ `Marshal.ReleaseComObject` を呼び出し、参照を削り取らなければならない。

実装例:安全な Excel 操作サービス

Imports Microsoft.Office.Interop.Excel
Imports System.Runtime.InteropServices

Public Class ExcelService
    Private ReadOnly _staRunner As StaTaskRunner

    Public Sub New(runner As StaTaskRunner)
        _staRunner = runner
    End Sub

    ''' <summary>
    ''' Excelを使用してデータを書き込み、安全にクローズする。
    ''' </summary>
    Public Async Function WriteDataToExcelAsync(filePath As String, data As String) As Task
        ' STAスレッド上で実行することを保証する
        Await _staRunner.ExecuteAsync(Of Unit)(Sub()
            Dim xlApp As Application = Nothing
            Dim xlWorkbooks As Workbooks = Nothing
            Dim xlWorkbook As Workbook = Nothing
            Dim xlWorksheet As Worksheet = Nothing
            Dim xlRange As Range = Nothing

            Try
                ' COMオブジェクトの生成
                xlApp = New Application()
                xlWorkbooks = xlApp.Workbooks
                xlWorkbook = xlWorkbooks.Add()
                xlWorksheet = xlWorkbook.ActiveSheet(1)
                xlRange = xlWorksheet.Cells(1, 1)

                ' データの書き込み
                xlRange.Value = data

                ' 保存
                xlWorkbook.SaveAs(filePath)

            Catch ex As Exception
                ' 例外のハンドリング
                Throw
            Finally
                ' 【重要】ボトムアップでの明示的解放
                ' これを怠ると、Excelプロセスが残る。
                If xlRange IsNot Nothing Then Marshal.ReleaseComObject(xlRange)
                If xlWorksheet IsNot Nothing Then Marshal.ReleaseComObject(xlWorksheet)
                If xlWorkbook IsNot Nothing Then Marshal.ReleaseComObject(xlWorkbook)
                If xlWorkbooks IsNot Nothing Then Marshal.ReleaseComObject(xlWorkbooks)
                If xlApp IsNot Nothing Then
                    xlApp.Quit()
                    Marshal.ReleaseComObject(xlApp)
                End If

                ' GCを強制的に回す(COM解放の確実性を高めるための最終手段)
                GC.Collect()
                GC.WaitForPendingFinalizers()
            End Try
        End End Sub)
    End Function
End Class

4. アーキテクトの視点:WPF への統合

この設計を WPF の ViewModel で使用する場合、UI スレッドは一切ブロックせず、ユーザーには `ProgressRing` 等で処理中であることを示しながら、背後で STA スレッドが黙々と Excel を操る、という理想的な挙動が実現できる。

' ViewModel内での利用イメージ
Public Async Sub ExecuteCommand()
    IsBusy = True ' UIにローディングを表示
    Try
        ' Excel操作はSTAスレッドで行われ、UIスレッドは解放されている
        Await _excelService.WriteDataToExcelAsync("C:\temp\report.xlsx", "Hello, Architect!")
        MessageBox.Show("完了しました")
    Catch ex As Exception
        MessageBox.Show($"エラーが発生しました: {ex.Message}")
    Finally
        IsBusy = False
    End Try
End Sub

結論

WPF と COM の融合において、我々に許されているのは「妥協」ではない。「制御」である。

1. スレッドモデルを分離せよ: `Task.Run` に頼らず、専用の STA スレッドを管理下に置け。
2. 非同期のインターフェースを維持せよ: `TaskCompletionSource` を使い、モダンな `async/await` の恩恵を捨てずに COM を扱え。
3. メモリ解放を儀式として捉えよ: `Marshal.ReleaseComObject` によるボトムアップの解放を、コードの品質基準の最上位に置け。

これらを守ることで初めて、レガシーな技術を現代のアーキテクチャの中で、真に信頼に足るコンポーネントとして蘇らせることができるのである。

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