【テクニカル・上級編】【中級者・実務】VB.NETとWPFにおける設定ファイル(App.config / JSON)の動的読み書きとUIへの自動バインド – Visual Basic (VB / VB.NET)解析バイブル

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

App.configの呪縛を解け:WPFにおける動的ステート永続化の極致

エンジニアが中級者の壁を越え、シニアへと昇華する瞬間。それは、単に「動くコード」を書く段階を終え、「堅牢で、保守性が高く、ユーザーの体験を損なわないアーキテクチャ」を設計できるようになった時だ。

多くの開発者が、アプリケーションの設定保存において、いまだに `App.config`(`ConfigurationManager`)の呪縛に囚われている。しかし、実務の最前線において、接続文字列のような「静的な構成情報」と、ウィンドウの座標やユーザーの操作状態といった「動的な状態情報」を同じ器に盛ることは、設計思想として致命的な欠陥である。

本稿では、WPFにおけるモダンな設定管理の真髄、すなわち JSONによる動的永続化 と、Windows APIを用いた完璧なウィンドウ状態の復元、そしてそれらを MVVMパターンへ美しくバインドする手法 について、その深淵を解説する。

1. なぜ App.config を捨て、JSON を選ぶのか

`App.config` は、.NET Framework時代からの遺産だ。読み取りには適しているが、実行時に書き換えるには、実行権限(Administrator)の問題や、スキーマの硬直性が大きな障壁となる。

モダンな業務アプリケーションにおいて、ユーザーごとの設定(Window Position, Last Opened Path, UI Theme)は、アプリケーション本体のインストールディレクトリではなく、`%AppData%`(Local/Roaming)に保存されるべきである。

JSONを選択する理由は明白だ。

  • 階層構造の柔軟性: オブジェクトグラフをそのままシリアライズできる。
  • 軽量なオーバーヘッド: `System.Text.Json` による高速な処理。
  • 疎結合: 設定スキーマの変更が、アプリケーションの再コンパイルを強いない。

2. 完璧なウィンドウ状態を制御する:Windows APIの活用

単に `Width` や `Height` を保存するだけでは、プロの仕事とは言えない。ユーザーが「最大化」して終了した場合、次に起動したときに「最大化された状態で、かつ正しい座標で」復元されるか? ここには `USER32.dll` の知見が必要となる。

`GetWindowPlacement` と `SetWindowPlacement` を使い、ウィンドウの「配置状態(最大化・最小化・通常)」を含めて管理するのが、極限のユーザー体験への近道だ。

3. 実装:State Management Engine

以下に、実務でそのまま転用可能な、堅牢な実装パターンを示す。

A. 設定のデータモデル (POCO)

まず、永続化したいデータを定義する。ここは純粋なデータ保持クラス(POCO)とし、ロジックを混ぜない。

''' <summary>
''' アプリケーションの動的設定を保持するデータモデル
''' </summary>
Public Class UserSettings
    ' ウィンドウの配置情報 (Windows API用)
    Public Property WindowPlacement As Byte()

    ' ウィンドウの表示状態 (Normal, Maximized, Minimized)
    Public Property WindowState As WindowState = WindowState.Normal

    ' ユーザー固有のプロパティ
    Public Property LastUsedPath As String = String.Empty
    Public Property ConnectionString As String = ""
    Public Property ThemeColor As String = "Default"
End Class

B. 設定管理サービス (Singleton Service)

I/O操作をカプセル化し、メモリ上のオブジェクトと物理ファイルを同期させる。

Imports System.IO
Imports System.Text.Json

''' <summary>
''' 設定の読み書きを司るサービス。シングルトンとして運用。
''' </summary>
Public Class SettingsService
    Private ReadOnly _filePath As String
    Public Property Current As UserSettings

    Public Sub New()
        ' %AppData%/Local/YourApp/settings.json に保存
        Dim appData As String = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData)
        Dim folder As String = Path.Combine(appData, "MyAdvancedApp")
        
        If Not Directory.Exists(folder) Then Directory.CreateDirectory(folder)
        _filePath = Path.Combine(folder, "settings.json")

        ' 初期化
        Load()
    End Sub

    ''' <summary>
    ''' ファイルから設定をロードする
    ''' </summary>
    Public Sub Load()
        Try
            If File.Exists(_filePath) Then
                Dim json As String = File.ReadAllText(_filePath)
                ' デシリアライズ時に型安全性を確保
                Current = JsonSerializer.Deserialize(Of UserSettings)(json)
            Else
                Current = New UserSettings()
            End If
        Catch ex As Exception
            ' ログ出力等の実務処理をここに。失敗時はデフォルト値を返す。
            Current = New UserSettings()
        End Try
    End Sub

    ''' <summary>
    ''' 現在の設定をファイルに永続化する
    ''' </summary>
    Public Sub Save()
        Try
            Dim options As New JsonSerializerOptions With {
                .WriteIndented = True ' 人間が読める形式で保存
            }
            Dim json As String = JsonSerializer.Serialize(Current, options)
            File.WriteAllText(_filePath, json)
        Catch ex As Exception
            ' 書き込みエラーのハンドリング(ディスクフル、権限不足等)
            Debug.WriteLine($"Critical Error saving settings: {ex.Message}")
        End Try
    End Sub
End Class

C. ViewModel によるバインド

WPFの真骨頂であるデータバインディングを活用する。`INotifyPropertyChanged` を実装し、UIと設定値を同期させる。

Imports System.ComponentModel
Imports System.Runtime.CompilerServices

''' <summary>
''' メインウィンドウのViewModel
''' </summary>
Public Class MainViewModel
    Implements INotifyPropertyChanged

    Private ReadOnly _settingsService As SettingsService

    Public Sub New(settingsService As SettingsService)
        _settingsService = settingsService
    End Sub

    ' プロパティの例:ユーザーが最後に開いたパス
    Public Property LastPath As String
        Get
            Return _settingsService.Current.LastUsedPath
        End Get
        Set(value As String)
            _settingsService.Current.LastUsedPath = value
            OnPropertyChanged()
        End Set
    End Property

    ' --- INotifyPropertyChanged の実装 ---
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged

    Protected Sub OnPropertyChanged(<CallerMemberName> Optional propertyName As String = Nothing)
        RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(propertyName))
    End Sub
End Class

D. Window Code-Behind:Windows API との融合

ここが最もテクニカルな部分だ。ウィンドウの「配置」を `USER32.dll` を通じて制御する。

Imports System.Runtime.InteropServices

Class MainWindow
    ' Windows API の宣言
    <StructLayout(LayoutKind.Sequential)>
    Public Structure RECT
        Public Left, Top, Right, Bottom As Integer
    End Structure

    <StructLayout(LayoutKind.Sequential)>
    Public Structure WINDOWPLACEMENT
        Public Length As Integer
        Public Flags As Integer
        Public ShowCmd As Integer
        Public MinPos As Point
        Public MaxPos As Point
        Public NormalPosition As RECT
    End Structure

    <DllImport("user32.dll")>
    Public Shared Function GetWindowPlacement(hWnd As IntPtr, ByRef lpwndpl As WINDOWPLACEMENT) As Boolean
    End Function

    <DllImport("user32.dll")>
    Public Shared Function SetWindowPlacement(hWnd As IntPtr, ByRef lpwndpl As WINDOWPLACEMENT) As Boolean
    End Function

    Private ReadOnly _settingsService As SettingsService = New SettingsService()
    Private _viewModel As MainViewModel

    Public Sub New()
        InitializeComponent()
        _viewModel = New MainViewModel(_settingsService)
        Me.DataContext = _viewModel
    End Sub

    ''' <summary>
    ''' ウィンドウがロードされた際の処理
    ''' </summary>
    Private Sub Window_Loaded(sender As Object, e As RoutedEventArgs) Handles Me.Loaded
        ' 1. ウィンドウ状態の復元
        If _settingsService.Current.WindowPlacement IsNot Nothing Then
            Dim wp As New WINDOWPLACEMENT()
            wp.Length = Marshal.SizeOf(GetType(WINDOWPLACEMENT))
            
            ' バイト配列から構造体へ復元(メモリ操作の極致)
            Dim ptr As IntPtr = Marshal.AllocHGlobal(wp.Length)
            Try
                Marshal.Copy(_settingsService.Current.WindowPlacement, 0, ptr, _settingsService.Current.WindowPlacement.Length)
                Marshal.PtrToStructure(ptr, wp)
                SetWindowPlacement(Me.Handle, wp)
                ' ShowCmd (最大化/最小化) を反映
                Me.WindowState = DirectCast(wp.ShowCmd, WindowState)
            Finally
                Marshal.FreeHGlobal(ptr)
            End Try
        End If
    End Sub

    ''' <summary>
    ''' ウィンドウが閉じられる際の処理
    ''' </summary>
    Private Sub Window_Closing(sender As Object, e As System.ComponentModel.CancelEventArgs) Handles Me.Closing
        ' 1. ウィンドウ配置情報の取得
        Dim wp As New WINDOWPLACEMENT()
        wp.Length = Marshal.SizeOf(GetType(WINDOWPLACEMENT))
        
        If GetWindowPlacement(Me.Handle, wp) Then
            ' 構造体をバイト配列に変換して保存
            Dim size As Integer = Marshal.SizeOf(wp)
            Dim arr(size - 1) As Byte
            Dim ptr As IntPtr = Marshal.AllocHGlobal(size)
            Try
                Marshal.StructureToPtr(wp, ptr, False)
                Marshal.Copy(ptr, arr, 0, size)
                _settingsService.Current.WindowPlacement = arr
            Finally
                Marshal.FreeHGlobal(ptr)
            End Try
        End If

        ' 2. 状態の保存
        _settingsService.Save()
    End Sub
End Class

4. アーキテクトの視点:パフォーマンスと堅牢性

この実装を実務に投入する際、以下の3点に留意せよ。

1. メモリ管理の厳格さ:
`Marshal.AllocHGlobal` を使用した場合、必ず `Try…Finally` ブロックで `FreeHGlobal` を呼び出せ。これを怠れば、アプリケーションが長時間稼働する業務システムにおいて、じわじわとメモリを食いつぶす「メモリリーク」の温床となる。
2. 非同期 I/O の検討:
本稿ではシンプルにするために同期的な `File.WriteAllText` を用いているが、設定ファイルが巨大化する場合、あるいは書き込み中にユーザーがアプリを強制終了するリスクを考慮する場合、`WriteAsync` を検討し、書き込み中の「不完全なファイル」による破損を防ぐ(Write-to-temporary-and-rename 戦略)べきだ。
3. 例外の階層化:
`SettingsService` 内で発生した例外をそのまま UI スレッドに投げ返してはならない。設定ファイルが壊れているのは「異常事態」ではなく、業務システムにおいては「起こりうる事象」だ。デフォルト値へのフォールバックを、いかにエレガントに行うかが腕の見せ所である。

結論

`App.config` は過去の遺物となりつつある。WPFという強力なフレームワークを使いこなすならば、ステート(状態)の管理もまた、モダンで、柔軟で、かつ低レイヤーの制御を厭わない設計でなければならない。

Windows APIによる精密な制御と、JSONによる柔軟な永続化。この二つを組み合わせることで、あなたのアプリケーションは単なる「ツール」から、ユーザーの操作を理解する「洗練されたソフトウェア」へと進化する。

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