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

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

VB.NET/WPFにおける「状態の永続化」の極意:JSONとMVVMで構築する堅牢な設定管理アーキテクチャ

業務アプリケーションの開発において、避けて通れないのが「状態の保存」だ。
ユーザーが最後に開いていたウィンドウのサイズ、最後に選択した検索条件、あるいはデータベースへの接続文字列……。これらをアプリケーションの再起動時に「前と同じ状態」で復元できないツールは、ユーザーにとって使い勝手の悪い、未完成のプロダクトに過ぎない。

しかし、多くの開発者がここで陥る罠がある。
`My.Settings` を安易に使い倒したり、`Window_Closing` イベントの中に直接、ファイル書き込みの泥臭いロジックを書き込んだりすることだ。これらは、アプリケーションの規模が拡大した瞬間に、保守不能なスパゲッティコードへと変貌する。

今日は、プロフェッショナルとして、「設定の読み書き」をUIから完全に切り離し、MVVMパターンに則った堅牢で拡張性の高い設計を伝授する。

1. 思考の転換:App.config は「設定」ではない

まず、設計の前提を正そう。
多くの者が混同しているが、`App.config` (または `web.config`) と、ユーザー個別の「設定ファイル」は、その役割が決定的に異なる。

  • App.config: アプリケーションの「動作環境」を定義するもの。接続文字列やログレベルなど、デプロイ時に決定される静的な情報に適している。
  • JSON設定ファイル: ユーザーの「状態」を保存するもの。ウィンドウサイズ、ユーザーの嗜好、入力途中の中間データなど、動的に変化する情報に適している。

現代のモダンなWPF開発において、ユーザーごとの動的な設定保存には JSON形式 を採用すべきだ。型安全性が高く、構造化されたデータを直感的に扱え、何よりデバッグが容易だからだ。

2. 黄金のアーキテクチャ:3つのレイヤー

堅牢な設計には、役割の分離が不可欠である。以下の3層構造で実装する。

1. Settings Model (POCO): 設定データの「器」となる純粋なクラス。
2. Settings Service: ファイルI/O(JSONのシリアライズ・デシリアライズ)を専門に担当するロジック層。
3. ViewModel: UIの状態を保持し、Serviceを介してデータを永続化させる制御層。

3. 実装ガイド:プロダクションレベルのコード例

それでは、実際に動作するコードを提示する。ここでは `System.Text.Json` を使用する。

Step 1: Settings Model の定義

まずは、保存したいデータの構造を定義する。余計なロジックは一切持たせない。

''' <summary>
''' アプリケーションの設定値を保持する純粋なデータモデル
''' </summary>
Public Class AppSettings
    ' ウィンドウのサイズと位置
    Public Property WindowWidth As Double = 800
    Public Property WindowHeight As Double = 600
    Public Property WindowTop As Double = 100
    Public Property WindowLeft As Double = 100

    ' ユーザーの操作状態
    Public Property LastSearchKeyword As String = String.Empty
    Public Property IsDarkMode As Boolean = False

    ' 接続情報など(機密情報は暗号化を検討すべきだが、ここでは構造の例として)
    Public Property ConnectionString As String = "Server=myServerAddress;Database=myDataBase;..."
End Class

Step 2: Settings Service の実装

ここが心臓部だ。ファイルへの書き込み・読み込みをカプセル化する。

Imports System.IO
Imports System.Text.Json

''' <summary>
''' 設定ファイルの永続化を担当するサービス
''' </summary>
Public Class SettingsService
    Private ReadOnly _filePath As String = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "user_settings.json")

    ''' <summary>
    ''' 設定をファイルに保存する
    ''' </summary>
    Public Sub Save(settings As AppSettings)
        Try
            ' インデントを付けて人間が読める形式で保存
            Dim options = New JsonSerializerOptions { .WriteIndented = True }
            Dim jsonString = JsonSerializer.Serialize(settings, options)
            File.WriteAllText(_filePath, jsonString)
        Catch ex As Exception
            ' 本来はロガーを用いてエラーを記録すべき
            Debug.WriteLine($"設定の保存に失敗しました: {ex.Message}")
        End Try
    End Sub

    ''' <summary>
    ''' 設定をファイルから読み込む
    ''' </summary>
    Public Function Load() As AppSettings
        If Not File.Exists(_filePath) Then
            ' ファイルがない場合はデフォルト値を返す
            Return New AppSettings()
        End If

        Try
            Dim jsonString = File.ReadAllText(_filePath)
            Dim settings = JsonSerializer.Deserialize(Of AppSettings)(jsonString)
            Return If(settings, New AppSettings())
        Catch ex As Exception
            Debug.WriteLine($"設定の読み込みに失敗しました: {ex.Message}")
            Return New AppSettings()
        End Try
    End Function
End Class

Step 3: ViewModel による制御

ViewModelは、UIからの要求を受け取り、Serviceを呼び出す。ここで `INotifyPropertyChanged` を実装し、UIとのバインドを確立する。

Imports System.ComponentModel

''' <summary>
''' メインウィンドウの制御を行うViewModel
''' </summary>
Public Class MainViewModel
    Implements INotifyPropertyChanged

    Private ReadOnly _settingsService As New SettingsService()
    Private _settings As AppSettings

    Public Sub New()
        ' 起動時に設定をロード
        _settings = _settingsService.Load()
    End Sub

    ' プロパティの公開(UIからバインドされる)
    Public Property WindowWidth As Double
        Get => _settings.WindowWidth
        Set
            _settings.WindowWidth = Value
            OnPropertyChanged(NameOf(WindowWidth))
        End Select
    End Property

    ' ... 他のプロパティ(Height, Top, Left, SearchKeyword等)も同様に実装 ...

    ''' <summary>
    ''' アプリ終了時に呼び出される保存メソッド
    ''' </summary>
    Public Sub SaveSettings()
        _settingsService.Save(_settings)
    End Sub

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

Step 4: XAML による View へのバインド

最後に、View(Window)側でこれらのプロパティをバインドする。

<Window x:Class="MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Modern WPF App"
        
        <!-- ViewModelのバインド -->
        DataContext="{Binding Source={StaticResource MainViewModel}}"
        
        <!-- ウィンドウの状態をViewModelにTwoWayバインド -->
        Width="{Binding WindowWidth, Mode=TwoWay}"
        Height="{Binding WindowHeight, Mode=TwoWay}"
        Top="{Binding WindowTop, Mode=TwoWay}"
        Left="{Binding WindowLeft, Mode=TwoWay}">
    
    <Grid>
        <!-- UIコンテンツ -->
    </Grid>
</Window>

4. 現場で差がつく、極限の注意点

コードを書くだけでは足りない。プロフェッショナルとして、以下の「落とし穴」を回避せよ。

① ウィンドウの「不自然なサイズ」問題

ユーザーがウィンドウを画面外に移動させたまま終了した場合、次回の起動時にウィンドウが「見えない」状態になる。
対策: `Load` メソッド内で、読み込んだ `Top` や `Left` が現在のディスプレイ領域内にあるかをチェックするバリデーションロジックを組み込むこと。

② ファイルI/O のタイミングと例外

`Window_Closing` イベントで保存を行うのは一般的だが、アプリケーションがクラッシュした場合には保存されない。
対策: 重要な設定(接続文字列の変更など)については、変更された瞬間に即時保存(Auto-save)する設計にせよ。ただし、ウィンドウサイズのような頻繁に変わる値は、終了時のみにするのがパフォーマンス上の定石だ。

③ 依存関係の注入 (Dependency Injection)

上記の例では `New SettingsService()` と直接生成しているが、大規模なプロジェクトでは、`SettingsService` をインターフェース (`ISettingsService`) 経由でコンストラクタ注入すべきだ。これにより、ユニットテストにおいて「ファイルへの書き込みを伴わないモック」を用いたテストが可能になる。

結論

「設定を保存する」という単純な行為にも、設計の美学と堅牢性が求められる。
UIに直接ロジックを書くのは、プロの仕事ではない。データ(Model)、永続化(Service)、制御(ViewModel)を明確に分離することで、あなたのアプリケーションは、変化に強く、テスト可能で、そして何よりユーザーに信頼されるプロダクトへと進化する。

この設計パターンを、あなたの次のプロジェクトのテンプレートにせよ。

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