C#での設定ファイル（App.config）の扱い方とは？ファイルの追加・設定値の読み込み・1キーに複数値の設定・設定値の変更方法
C#での設定ファイル（App.config）の扱い方とは？
今回は、C#での設定ファイル（App.config）の扱い方について説明します。設定ファイルは「アプリケーション構成ファイル」のことです。アプリケーション固有の設定情報を格納しているファイルです。
ここでは、設定ファイルの追加、設定値の読み込み、1キーに複数値の設定、設定値の変更方法について紹介します。
C#での設定ファイルの扱い方に興味のある方はぜひご覧ください。
App.configの追加
C#での設定ファイル（App.config）の追加方法を紹介します。
Visual Studioのソリューションエクスプローラで、プロジェクトを右クリックします。ポップアップメニューの「追加」→「新しい項目の追加」を選び「新しい項目の追加」ダイアログが表示されます。
「アプリケーション構成ファイル」を選択して「追加」ボタンをクリックすると「アプリケーション構成ファイル（App.config）」が作成されます。初期状態では以下のようになっています。
|
1 2 3 |
<?xml version="1.0" encoding="utf-8" ?> <configuration> </configuration> |
以下のように、設定ファイルに設定値を追加します。
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="key1" value="value1" /> <add key="key2" value="value2" /> <add key="key3" value="value3" /> </appSettings> </configuration> |
設定値の読み込み
C#での設定ファイルの読み込み方法を紹介します。プログラムに「using System.Configuration;」を記述します。
次に、Visual Studioのツール（T）→ NuGetパッケージマネージャー（N）→ ソリューションのNuGetパッケージの管理（N）と選択します。ソリューションのパッケージの管理ウィンドウが開きますので、検索ボックスに「ConfigurationManager」を入力します。
「System.Configuration.ConfigurationManager」を選択してOKボタンをクリックします。
設定ファイルの読み込みのためのソースコードを見てみましょう。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
using System; using System.Configuration; static class Sample { static void Main(string[] args) { // 指定したkeyの値を取得 Console.WriteLine("key: {0}, value: {1}", "key1", ConfigurationManager.AppSettings["key1"]); // 見つからない場合はnull Console.WriteLine("key: {0}, value: {1}", "keyX", ConfigurationManager.AppSettings["keyX"]); // 全てのkeyとvalueを取得 foreach (string key in ConfigurationManager.AppSettings.AllKeys) { Console.WriteLine("key: {0}, value: {1}", key, ConfigurationManager.AppSettings[key]); } } } |
実行結果は以下のようになります。
|
1 2 3 4 5 |
key: key1, value: value1 key: keyX, value: key: key1, value: value1 key: key2, value: value2 key: key3, value: value3 |
このようにC#では、設定ファイルの値を読み込めます。
1キーに複数値設定
C#での設定ファイルの1つのキーに複数値を設定する方法を紹介します。設定ファイルは以下の状態とします。
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="key1" value="value1" /> <add key="key1" value="value2" /> <add key="key1" value="value3" /> </appSettings> </configuration> |
それでは、実際のソースコードを見てみましょう。
|
1 2 3 4 5 6 7 8 9 10 11 |
using System; using System.Configuration; static class Sample { static void Main(string[] args) { // 指定したkeyの値を取得 Console.WriteLine("key: {0}, value: {1}", "key1", ConfigurationManager.AppSettings["key1"]); } } |
実行結果は以下のようになります。最後の値のみが取得されています。
|
1 |
key: key1, value: value3 |
1つのキーに複数値を設定するには、例えば以下のようにカンマ区切りにします。
|
1 2 3 4 5 6 |
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="key1" value="value1,value2,value3" /> </appSettings> </configuration> |
ソースコードは以下のようにします。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
using System; using System.Configuration; static class Sample { static void Main(string[] args) { // 全てのkeyとvalueを取得 foreach (string key in ConfigurationManager.AppSettings.AllKeys) { // カンマ区切りで分割 var values = ConfigurationManager.AppSettings[key].Split(','); foreach (string value in values) { Console.WriteLine("key: {0}, value: {1}", key, value); } } } } |
実行結果は以下のようになります。
|
1 2 3 |
key: key1, value: value1 key: key1, value: value2 key: key1, value: value3 |
このようにC#では、設定ファイルの1つのキーに複数値を設定できます。
設定値の変更
C#での設定ファイルの値変更方法を紹介します。設定ファイルは以下の状態とします。
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="key1" value="value1" /> <add key="key2" value="value2" /> <add key="key3" value="value3" /> </appSettings> </configuration> |
ソースコードは以下のように記述します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
using System; using System.Configuration; static class Sample { static void Main(string[] args) { Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); config.AppSettings.Settings["key2"].Value = "value22"; config.Save(); Console.WriteLine(config.FilePath); // 全てのkeyとvalueを取得 foreach (string key in ConfigurationManager.AppSettings.AllKeys) { Console.WriteLine("key: {0}, value: {1}", key, ConfigurationManager.AppSettings[key]); } } } |
実行結果は以下のようになります。
|
1 2 3 4 |
C:\Users\<ユーザ名>\source\repos\ConsoleApp1\ConsoleApp1\bin\Debug\netcoreapp3.1\ConsoleApp1.dll.config key: key1, value: value1 key: key2, value: value22 key: key3, value: value3 |
config.FilePathのファイルを開くと、設定値が変更されていることが分かります。
まとめ
いかがでしたでしょうか。C#での設定ファイル（App.config）の扱い方について説明しました。ここでは、設定ファイルの追加、設定値の読み込み、1キーに複数値の設定、設定値の変更方法について紹介しました。
ぜひご自身でC#のソースコードを書いて、理解を深めてください。
