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

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

【上級者への登竜門】WPFでExcel操作しても画面をフリーズさせない「STAスレッド」の魔法

こんにちは。業務自動化の世界へようこそ。

VBA(Excelマクロ)から一歩踏み出し、VB.NETやWPFを使って「本格的な業務アプリケーション」を作ろうとしているあなた。素晴らしい決断です。Excelを操作するコードを書けるようになった次のステップは、「ユーザーが使いやすい、止まらないソフト」を作ることです。

しかし、ここで多くのエンジニアが大きな壁にぶつかります。
「Excelを操作するプログラムを動かしている間、ウィンドウが真っ白になって操作できなくなった(応答なし)!」
「なぜかプログラムが異常終了してしまう……」

これは、あなたが「スレッド」と「COM」という、Windowsプログラミングの深淵に足を踏み入れた証拠です。今日は、この問題を根本から解決し、モダンなUI(WPF)とレガシーな力(Excel/COM)を安全に共存させる「STAスレッド・ラッパー」という究極のテクニックを伝授します。

ここをクリアすれば、あなたの作るソフトの品質は、プロの領域へと一気に引き上がりますよ。

1. なぜExcelを動かすと画面が固まるのか?

まず、敵の正体を知ることから始めましょう。原因は大きく分けて2つあります。

原因①:UIスレッドの占有(ブロッキング)

WPFの画面(ボタンやテキストボックス)を描画しているのは、「UIスレッド」と呼ばれる専用の通り道です。
もし、このUIスレッド上で「Excelを開いて、10万行のデータを読み込む」という重い処理を直接実行してしまうと、UIスレッドはExcelの作業が終わるまで、マウス操作や画面の更新を受け付けられなくなります。これが「画面が固まる」現象の正体です。

原因②:STA(Single-Threaded Apartment)の掟

ここが最も重要なポイントです。ExcelなどのCOMコンポーネントには、「STA(シングル・スレッド・アパートメント)という特別な部屋(スレッド)で動かなければならない」という厳しい掟があります。

  • STAスレッド: 「自分専用の部屋」を持つスレッド。COMオブジェクト(Excelなど)が安全に動くためのルール。
  • MTAスレッド: 「共有の広場」のようなスレッド。高速だが、COMの操作には不向き。

WPFのUIスレッドもSTAですが、重い処理をUIスレッドにさせると画面が固まる。かといって、普通の非同期処理(Task.Runなど)で新しいスレッドを作ると、それは通常MTAスレッドになり、Excelを操作しようとした瞬間に「スレッドのルール違反!」としてエラー(COMException)が発生します。

「画面を固めたくない(UIスレッドを使いたくない)が、Excelを動かすにはSTAスレッドが必要」

この矛盾をどう解決するか? それが今回のテーマです。

2. 解決策:専用の「STA作業員」を雇う

解決策はシンプルです。
「Excel操作のためだけの、STA属性を持った専用スレッド」をその都度生成し、そこで作業をさせ、結果だけをUIスレッドに報告するという設計にします。

これを実現するために、`TaskCompletionSource` という仕組みを使って、非同期(Async/Await)で扱える「STA専用ラッパー」を作ってみましょう。

実装:StaTaskRunner クラス

このクラスは、魔法の道具箱です。これをコピーしてプロジェクトに貼り付けるだけで、どんな重い処理もSTAスレッドで安全に実行できるようになります。

Imports System.Threading

''' <summary>
''' COM操作(Excel等)をSTAスレッドで安全に実行するためのラッパークラス
''' </summary>
Public Class StaTaskRunner
    ''' <summary>
    ''' 指定されたアクションをSTAスレッドで実行し、その結果をTaskとして返します。
    ''' </summary>
    ''' <typeparam name="T">実行する処理の戻り値の型</typeparam>
    ''' <param name="action">STAスレッドで実行したい処理</param>
    ''' <returns>実行結果を保持するTask</returns>
    Public Shared Function ExecuteAsync(Of T)(action As Func(Of T)) As Task(Of T)
        ' TaskCompletionSourceは、手動で「処理が終わったよ!」と通知するための橋渡し役です
        Dim tcs As New TaskCompletionSource(Of T)()

        ' 新しいスレッドを作成します
        Dim thread As New Thread(Sub()
                                    Try
                                        ' 1. ここが重要!スレッドの性質をSTAに設定します
                                        Thread.CurrentThread.SetApartmentState(ApartmentState.STA)

                                        ' 2. 実際の処理を実行
                                        Dim result = action.Invoke()

                                        ' 3. 成功したら結果をTaskにセットして完了を通知
                                        tcs.SetResult(result)
                                    Catch ex As Exception
                                        ' 4. エラーが発生したら、その例外をTaskに伝えます
                                        tcs.SetException(ex)
                                    End Try
                                End Sub)

        ' スレッドを開始
        thread.Start()

        ' Taskとして返却することで、呼び出し元は Async/Await が使えるようになります
        Return tcs.Task
    End Function
End Class

3. 実践:Excelを操作してみよう

では、実際にこの `StaTaskRunner` を使って、WPFの画面からExcelを操作するコードを書いてみましょう。

WPFのコード例 (MainWindow.xaml.vb)

Imports Microsoft.Office.Interop.Excel
Imports System.Threading.Tasks

Class MainWindow
    ''' <summary>
    ''' ボタンクリック時のイベント。Asyncキーワードを忘れずに!
    ''' </summary>
    Private Async Sub btnRunExcel_Click(sender As Object, e As RoutedEventArgs) Handles btnRunExcel.Click
        ' ユーザーに「処理中」であることを伝える
        btnRunExcel.IsEnabled = False
        txtStatus.Text = "Excelを起動中..."

        Try
            ' 【ここが極意!】
            ' 重いExcel操作を、StaTaskRunnerを通じて「STAスレッド」へ放り投げます。
            ' await を使うことで、Excelの作業中もUIスレッドは自由になり、画面は固まりません。
            Dim resultMessage As String = Awake ExecuteExcelWork()

            ' 結果を表示(ここはUIスレッドに戻ってきています)
            txtStatus.Text = "完了: " & resultMessage

        Catch ex As Exception
            ' エラーが発生した場合の処理
            MessageBox.Show("エラーが発生しました: " & ex.Message, "エラー", MessageBoxButton.OK, MessageBoxImage.Error)
            txtStatus.Text = "エラー発生"
        Finally
            ' ボタンを元に戻す
            btnRunExcel.IsEnabled = True
        End Try
    End Sub

    ''' <summary>
    ''' Excel操作の本体。STAスレッドで実行されることを前提としています。
    ''' </summary>
    Private Async Function ExecuteExcelWork() As Task(Of String)
        ' StaTaskRunnerを使って、STAスレッドでExcel操作を実行
        Return Awake StaTaskRunner.ExecuteAsync(Function()
                                                    ' --- ここから下はSTAスレッド内で動く ---
                                                    Dim excelApp As Application = Nothing
                                                    Dim workbook As Workbook = Nothing
                                                    Dim sheet As Worksheet = Nothing

                                                    Try
                                                        ' Excelの起動
                                                        excelApp = New Application()
                                                        excelApp.Visible = True ' 動きが見えるように
                                                        workbook = excelApp.Workbooks.Add()
                                                        sheet = workbook.Sheets(1)

                                                        ' 重い処理のシミュレーション(大量のセル書き込み)
                                                        For i As Integer = 1 To 1000
                                                            sheet.Cells(i, 1).Value = "Data " & i
                                                        Next

                                                        ' 処理完了のメッセージを返す
                                                        Return "1000行の書き込みに成功しました!"

                                                    Catch ex As Exception
                                                        ' 再スローして外側のCatchで捕まえる
                                                        Throw ex
                                                    Finally
                                                        ' 【重要】COMオブジェクトの解放
                                                        ' これを忘れるとExcelプロセスが残り続けます
                                                        If Not sheet Is Nothing Then System.Runtime.InteropServices.Marshal.ReleaseComObject(sheet)
                                                        If Not workbook Is Nothing Then System.Runtime.InteropServices.Marshal.ReleaseComObject(workbook)
                                                        If Not excelApp Is Nothing Then
                                                            excelApp.Quit()
                                                            System.Runtime.InteropServices.Marshal.ReleaseComObject(excelApp)
                                                        End If
                                                    End Try
                                                    ' --- ここまでSTAスレッド ---
                                                End Function)
    End Function
End Class

4. コードの解説と、プロの心得

このコードには、現場で通用する「三種の神器」が組み込まれています。

① `SetApartmentState(ApartmentState.STA)`

`StaTaskRunner` の中でこれを行っているのが、今回の最大のポイントです。これにより、Excelという「気難しい専門家」が、自分専用の落ち着いた部屋(STAスレッド)で作業できるようになります。

② `TaskCompletionSource` による非同期の架け橋

通常、自分で作ったスレッドの結果を `await` で待つのは難しいのですが、`TaskCompletionSource` を使うことで、「独自スレッドの完了」を「モダンなTaskの完了」に変換しています。これにより、呼び出し側は `Await` と書くだけで、スレッドの管理を意識せずに済むのです。

③ COMオブジェクトの解放 (`Marshal.ReleaseComObject`)

これはVB.NET/Excel操作における「作法」です。Excelは非常にメモリ管理がシビアです。使い終わったオブジェクトを明示的に解放しないと、プログラムを終了してもタスクマネージャーに `EXCEL.EXE` が残り続ける「ゾンビプロセス」が発生します。必ず `Finally` ブロックで解放しましょう。

まとめ:一歩先のエンジニアへ

いかがでしたか?

1. UIスレッドで重い処理をしない(画面を固めない)
2. COM操作にはSTAスレッドが必要(エラーを防ぐ)
3. 専用のSTAスレッドを立てて、Taskで繋ぐ(モダンな設計)

この3点をマスターすれば、あなたはもう「マクロが動かない」「ソフトが固まる」といった初歩的なトラブルに悩まされることはありません。

プログラミングは、こうした「仕組み」を一つずつ理解していくことで、魔法から技術へと変わっていきます。大丈夫、あなたは確実にその道を歩んでいますよ。

次なる挑戦を楽しみにしています。応援しています!

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