【実務・中級編】【上級者向け】VB.NETのWPFアプリにおけるSystem.IO.Ports(シリアル通信)やUSBデバイス連携とUIスレッドの統合 – Visual Basic (VB / VB.NET)解析バイブル

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

【極限の知見】WPF×シリアル通信における「UIフリーズ」と「スレッド例外」を根絶する高信頼アーキテクチャ

製造現場や計測器制御のアプリケーション開発において、VB.NETとWPFを選択するエンジニアは少なくない。しかし、ハードウェア(USB/シリアルデバイス)からのリアルタイムデータを取り込もうとした瞬間、多くの開発者が「壁」にぶつかる。

それは、`InvalidOperationException`(スレッド間のアクセス違反)、そしてUIの操作不能(フリーズ)だ。

もし君が、シリアルポートの`DataReceived`イベントの中で直接`TextBox.Text = data`と書き込もうとしているのなら、今すぐそのコードを捨ててほしい。それは「動いているように見えるだけの、爆弾を抱えたコード」だ。

本稿では、プロフェッショナルが実践する、高スループットかつ堅牢な「Producer-Consumer(生産者・消費者)パターン」を用いたアーキテクチャを伝授する。

1. なぜ、君のコードは「死ぬ」のか

まず、問題の本質を理解せよ。

WPFには「UIスレッド」という絶対的な支配者が存在する。ボタンのクリック、テキストの表示、グラフの描画……これらすべてはUIスレッドという単一の実行経路で行われる。

一方で、`System.IO.Ports.SerialPort`クラスがデータを検知した際に発生させる`DataReceived`イベントは、「ワーカースレッド(バックグラウンドスレッド)」で実行される。

ここで初心者が陥る罠が2つある。

1. 直接操作の罪: バックグラウンドスレッドからUI要素を直接触ろうとして、スレッド例外でアプリがクラッシュする。
2. Dispatcher.Invokeの乱用: 例外を回避するために`Dispatcher.Invoke`で無理やりUIスレッドへ処理を投げる。しかし、通信速度が1ms単位の高速なものだった場合、UIスレッドは「描画要求」の洪水に飲み込まれ、ユーザーの操作を受け付けないフリーズ状態に陥る。

「通信の速さ」と「描画の速さ」を切り離せ。 これが設計の鉄則だ。

2. 勝利の方程式:バッファリング・アーキテクチャ

堅牢な設計の要諦は、「データの受信(生産者)」と「データの表示(消費者)」を完全に分離し、その間に「スレッドセーフなキュー(待ち行列)」を挟むことにある。

アーキテクチャの階層構造

1. Hardware Layer (Producer): `SerialPort`がデータを読み取り、`ConcurrentQueue`に高速に放り込む。UIのことは一切考えない。
2. Data Buffer (Mediator): `ConcurrentQueue(Of T)`。スレッド間の衝突を防ぐための安全なバッファ。
3. ViewModel Layer (Consumer): タイマー(`DispatcherTimer`)を用い、一定周期(例:30msごと)でキューからデータをまとめて取り出し、UIに通知する。

この設計により、通信がどれほど高速であっても、UIの更新頻度は「人間が見て自然な速度」に制御され、CPU負荷も劇的に抑えられる。

3. プロダクション・コード例

以下に、そのまま実務のベースとして使える、保守性の高い実装例を示す。

DataModel.vb (データ構造)

まず、受け取るデータの型を定義する。

''' <summary>
''' 計測器から送られてくるデータモデル
''' </summary>
Public Class MeasurementData
    Public Property Timestamp As DateTime
    Public Property Value As Double
End Class

SerialService.vb (通信層:Producer)

ここでは`System.IO.Ports`をカプセル化し、UIへの依存をゼロにする。

Imports System.IO.Ports
Imports System.Collections.Concurrent

''' <summary>
''' シリアル通信を管理するサービス。UIスレッドとは完全に独立して動作する。
''' </summary>
Public Class SerialService
    Implements IDisposable

    Private _serialPort As SerialPort
    ' スレッドセーフなキュー。ここがProducerとConsumerの境界線となる。
    Public Property DataQueue As New ConcurrentQueue(Of MeasurementData)()

    Public Sub New(portName As String, baudRate As Integer)
        _serialPort = New SerialPort(portName, baudRate)
        AddHandler _serialPort.DataReceived, AddressOf OnDataReceived
    End Sub

    Public Sub Open()
        If Not _serialPort.IsOpen Then _serialPort.Open()
    End Sub

    Public Sub Close()
        If _serialPort.IsOpen Then _serialPort.Close()
    End Sub

    ''' <summary>
    ''' バックグラウンドスレッドで実行されるイベントハンドラ
    ''' </summary>
    Private Sub OnDataReceived(sender As Object, e As SerialDataReceivedEventArgs)
        Try
            ' 実際の現場では、プロトコルに基づいたパースが必要
            Dim rawData As String = _serialPort.ReadLine()
            Dim val As Double
            
            If Double.TryParse(rawData, val) Then
                ' UIを操作せず、ただキューに放り込むだけ。これが高速化の鍵。
                DataQueue.Enqueue(New MeasurementData With {
                    .Timestamp = DateTime.Now,
                    .Value = val
                })
            End If
        Catch ex As Exception
            ' 現場ではここでのログ出力が死活問題となる
            Debug.WriteLine($"Communication Error: {ex.Message}")
        End Try
    End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        Close()
        _serialPort?.Dispose()
    End Sub
End Class

MainViewModel.vb (制御層:Consumer)

ここで`DispatcherTimer`を使い、キューからデータを「バッチ処理」で吸い上げる。

Imports System.ComponentModel
Imports System.Windows.Threading
Imports System.Collections.ObjectModel

''' <summary>
''' UIと通信サービスを繋ぐViewModel。
''' </summary>
Public Class MainViewModel
    Implements INotifyPropertyChanged

    Private ReadOnly _serialService As SerialService
    Private ReadOnly _displayTimer As DispatcherTimer
    
    ' UIにバインドされるコレクション
    Public Property DataLog As New ObservableCollection(Of MeasurementData)()

    Public Sub New(service As SerialService)
        _serialService = service

        ' UI更新用のタイマー。33ms(約30fps)ごとにキューをチェックする。
        ' これにより、通信が1ms間隔でもUI更新は30fpsに制限され、フリーズを防げる。
        _displayTimer = New DispatcherTimer()
        AddHandler _displayTimer.Tick, AddressOf OnUpdateTimerTick
        _displayTimer.Interval = TimeSpan.FromMilliseconds(33)
        _displayTimer.Start()
    End Sub

    ''' <summary>
    ''' タイマーによってUIスレッド上で定期的に実行される
    ''' </summary>
    Private Sub OnUpdateTimerTick(sender As Object, e As EventArgs)
        ' キューにあるデータを全て取り出す(バッチ処理)
        ' 1つずつInvokeするのではなく、まとめて処理するのがプロの技
        While _serialService.DataQueue.TryDequeue(If(Nothing, Nothing), Dim data)
            ' UIスレッド上で動作しているため、直接コレクションに追加可能
            DataLog.Add(data)

            ' メモリ肥大化防止:ログが多すぎる場合は古いものを削除
            If DataLog.Count > 100 Then
                DataLog.RemoveAt(0)
            End If
        End While

        ' PropertyChangedの通知が必要な場合はここで実行
        OnPropertyChanged(NameOf(DataLog))
    End Sub

    ' INotifyPropertyChangedの実装(略)
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
    Protected Sub OnPropertyChanged(propertyName As String)
        RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(propertyName))
    End Sub
End Class

4. リーダーからの設計アドバイス

このアーキテクチャを実装する際、以下の3点に留意せよ。これらが守られていないコードは、リリース後に現場で「使い物にならない」と判断される。

① リソースのライフサイクル管理

`SerialPort`はOSのハンドルを握る貴重なリソースだ。`IDisposable`を正しく実装し、アプリ終了時やデバイス切断時に確実に`Dispose`(または`Close`)を行え。これを怠ると、アプリを再起動しても「ポートが既に使用されています」というエラーに悩まされることになる。

② エラーハンドリングの階層化

通信エラー(ノイズによるパース失敗、ケーブル断線)が発生した際、アプリ全体をクラッシュさせるな。

  • 通信層: エラーをログに記録し、通信を継続するか再試行するかを判断する。
  • ViewModel層: ユーザーに「通信不安定」などのステータスを表示する。

③ メモリの境界線

リアルタイムデータを取り込み続けるアプリにおいて、`ObservableCollection`への追加は「無限のメモリ消費」を意味する。必ず、表示に必要な最大件数(例:直近100件、あるいはグラフの表示範囲)を決め、古いデータを破棄するロジックを組み込め。

結論

WPFでハードウェア連携を行うなら、「通信スレッドをUIから隔離し、キューを介してバッチ更新する」。これが、バグのない、プロフェッショナルな業務アプリケーションを構築するための唯一の道だ。

この設計思想をマスターすれば、君の作るツールは、どんな高速な計測器に対しても揺るぎない堅牢性を発揮するだろう。

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