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

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

プロフェッショナルへの第一歩:WPFで「記憶」を持つアプリケーションを作る —— 設定値の永続化と自動バインドの極意

こんにちは。技術の深淵へようこそ。

あなたがExcel VBAや、あるいは単発のスクリプトから一歩踏み出し、「Windowsアプリケーションを作りたい」と考えたとき、必ず直面する壁があります。それは「アプリケーションの記憶」です。

「前回開いた時のウィンドウサイズはどこだったか?」
「ユーザーが最後に選択した設定は何だったか?」
「データベースへの接続情報はどこに隠しておくべきか?」

これらが毎回リセットされてしまうアプリは、どんなに機能が素晴らしくても「道具」としては未完成です。ユーザーが「お、このアプリは分かっているな」と感じる瞬間。それは、アプリがユーザーの好みを「覚えている」瞬間なのです。

今日は、VB.NETとWPFという強力な武器を使い、設定値をスマートに保存(永続化)し、それをUIへ魔法のように反映させる「モダンな設計パターン」を伝授します。ここをクリアすれば、あなたの作るソフトは「スクリプト」から「製品」へと昇華します。

1. 武器の選定:App.config か、それとも JSON か?

まず、設定をどこに保存するかという戦略を立てましょう。設計者として、用途に応じた使い分けが重要です。

特徴 App.config (構成ファイル) JSONファイル (モダンな選択)
主な用途 接続文字列、システム全体の設定 ユーザーごとの設定、ウィンドウ状態
書き換え 基本的に「読み取り専用」として扱う プログラムから自由に読み書きが可能
構造 XML形式(少し冗長) 軽量・階層構造が得意(直感的)
推奨シーン 開発者が決める「環境」の定義 ユーザーが決める「好み」の保存

実務では、「環境設定はApp.config、ユーザー設定はJSON」と使い分けるのが、プロフェッショナルな設計の定石です。今回は、より柔軟でモダンなJSON形式による永続化に焦点を当てます。

2. 設計図:MVVMパターンとデータの流れ

WPFを扱う上で、絶対に避けて通れないのが MVVM (Model-View-ViewModel) という考え方です。

「ボタンを押したら、このラベルの文字を変える」といった直接的な操作(コードビハインド)は、WPFでは「悪」とされます。代わりに、「データが変わったから、UIが勝手に変わる」というデータバインディングの仕組みを使います。

今回の設計図はこうです:

1. Model: 設定値を保持する純粋なクラス(データの入れ物)。
2. Service: JSONファイルへの保存・読み込みを担当する職人。
3. ViewModel: ModelとViewの橋渡し役。UIからの要求を受け、Modelを更新する。
4. View (XAML): ユーザーが見る画面。ViewModelのデータを「監視」している。

3. 実装:魂を込めたコード例

では、実際に動くコードを見ていきましょう。

Step 1: 設定を保持する「Model」を作る

まずは、何を設定したいのかを定義します。

''' <summary>
''' ユーザー設定を保持する純粋なデータモデル
''' </summary>
Public Class UserSettings
    ' ウィンドウの幅
    Public Property WindowWidth As Double = 800
    ' ウィンドウの高さ
    Public Property WindowHeight As Double = 600
    ' 最後に選択されたテーマ(例: "Dark", "Light")
    Public Property SelectedTheme As String = "Light"
    ' ユーザー名
    Public Property LastUserName As String = ""
End Class

Step 2: JSONを操る「Service」を作る

ここでは `System.Text.Json` を使用します。これは非常に高速で、現代の.NET開発における標準です。

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 UserSettings)
        Try
            ' オプション:整形して保存(人間が読みやすくなる)
            Dim options = New JsonSerializerOptions With {.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 UserSettings
        If Not File.Exists(_filePath) Then
            ' ファイルがなければデフォルト設定を返す
            Return New UserSettings()
        End If

        Try
            Dim jsonString = File.ReadAllText(_filePath)
            ' JSONからオブジェクトへ復元
            Return JsonSerializer.Deserialize(Of UserSettings)(jsonString)
        Catch ex As Exception
            Debug.WriteLine($"読み込みエラー: {ex.Message}")
            Return New UserSettings()
        End Try
    End Function
End Class

Step 3: UIとデータを繋ぐ「ViewModel」を作る

ここが一番の肝です。`INotifyPropertyChanged` を実装することで、「値が変わったよ!」という通知をUIに送ることができます。これがないと、バインディングは沈黙したままです。

Imports System.ComponentModel
Imports System.Runtime.CompilerServices

''' <summary>
''' ViewとModelを繋ぐ司令塔
''' </summary>
Public Class MainViewModel
    Implements INotifyPropertyChanged

    Private _settings As UserSettings
    Private ReadOnly _service As SettingsService

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

    ' --- プロパティ ---

    Public Property WindowWidth As Double
    Public Property WindowHeight As Double
    Public Property LastUserName As String

    ' 実際の実装では、プロパティのSetterで通知を行う必要があります
    Public Property UserName As String
        Get
            Return _settings.LastUserName
        End Get
        Set(value As String)
            _settings.LastUserName = value
            OnPropertyChanged() ' UIに通知
        End Set
    End Property

    ' --- 保存処理 ---

    Public Sub SaveSettings(width As Double, height As Double)
        _settings.WindowWidth = width
        _settings.WindowHeight = height
        _settings.LastUserName = _settings.LastUserName ' 更新を反映
        _service.Save(_settings)
    End Sub

    ' --- 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

Step 4: 画面(XAML)でバインドする

最後に、View(MainWindow.xaml)でデータと紐付けます。

<Window x:Class="MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Modern Settings App" 
        Height="{Binding WindowHeight, Mode=TwoWay}" 
        Width="{Binding WindowWidth, Mode=TwoWay}">
    
    <!-- DataContextにViewModelをセット(コードビハインドで行うのが一般的) -->
    
    <StackPanel Margin="20">
        <TextBlock Text="ユーザー名を入力してください:" Margin="0,0,0,5"/>
        <!-- TextプロパティをViewModelのUserNameにバインド -->
        <TextBox Text="{Binding UserName, UpdateSourceTrigger=PropertyChanged}" 
                 Margin="0,0,0,20"/>

        <Button Content="設定を保存して終了" 
                Click="SaveButton_Click" 
                Padding="10,5"/>
    </StackPanel>
</Window>

4. 陥りやすい罠:プロの視点からのアドバイス

ここまで実装できれば、あなたはもう初学者ではありません。しかし、実務では以下のような「落とし穴」が待ち構えています。

① 「いつ」保存するか?

上記の例ではボタンクリックで保存していますが、ウィンドウサイズなどは `Closing` イベント(ウィンドウが閉じる直前)で自動保存するのがユーザー体験としては最高です。
「ユーザーに保存ボタンを押させるな。アプリが勝手にやっておくものだ」。これがモダンUIの哲学です。

② バインドの「Mode」に注意

XAMLの `Binding` には `Mode` があります。

  • `OneWay`: ViewModel → View(表示のみ)
  • `TwoWay`: ViewModel ↔ View(入力も反映される)

ウィンドウサイズのように、「画面を動かした結果をデータに書き戻したい」場合は、必ず `Mode=TwoWay` を指定してください。これを忘れると、「保存しても次回起動時にサイズが変わらない!」という怪奇現象に悩まされることになります。

③ ファイルアクセスの例外処理

設定ファイルは、ユーザーが手動で消したり、ウイルス対策ソフトがロックしたりすることがあります。`Try…Catch` による例外処理は、単なる「おまじない」ではなく、アプリの生存戦略です。

結びに:次なるステップへ

お疲れ様でした。
あなたは今、単なる「コードの書き方」ではなく、「データのライフサイクルを管理する設計思想」を手にしました。

`App.config` でシステムを支え、`JSON` でユーザーを理解する。この使い分けができるようになれば、あなたの作るアプリケーションの品質は、他の追随を許さないレベルに到達します。

「動けばいい」のフェーズを卒業し、「美しく、使いやすい」を目指す。その旅路を、これからも楽しんでください。応援していますよ!

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