C#プロジェクトにApp.configファイルを追加する方法

C#のプロジェクトで作成されるApp.configファイルですが、どんな機能があるのか、どのように使うのか、分からない方もいるのではないでしょうか。この記事では、App.configファイルの役割から追加方法までを紹介していきます。ぜひ参考にしてみてください。

プログラマー

既存プロジェクトに「App.config」というファイルが含まれています。C#のソースは拡張子が「.cs」だと思うのですが、このファイルはソースコードではないのでしょうか？

プロジェクト
リーダー

良いところに気付きましたね。App.configがどんなファイルで、どのように使用されているか、覚えていきましょう！

App.configファイル（アプリケーション構成ファイル）について

アプリケーション構成ファイルとは、その名の通り、アプリケーション固有の設定情報を保持するためのファイルです。以下の例のように、XML形式で記述されています。

XML文書では、1要素を

の形式で記述します。
※＜タグ名＞は開始タグ、＜/タグ名＞は終了タグと呼ばれます。

また、終了タグを省略して

と記述することも可能です。

アプリケーションの設定情報を指定しているのは、appSettingsタグ内です。
設定項目毎に、キーと値を保持します。

App.configファイルの追加方法

それでは、Visual Studio 2019の環境を例に挙げて、
実際にApp.configファイルをプロジェクトに追加してみましょう。

1. 1. ソリューションエクスプローラーで対象のプロジェクト名を右クリックし、「追加」→「新しい項目」の順に選択します。

1. 1. 「インストール済み」→「Visual C# アイテム」を選択します。

一覧より、「アプリケーション構成ファイル」を選択し、「追加」をクリックします。
※この際、特別な理由が無ければ、ファイル名はデフォルト（App.config）のままをおすすめします。ファイル名を変更すると、読み込み処理のソースが多少複雑になってしまうためです。

1. 1. プロジェクトに「App.config」が追加されたことを確認できました。

1. 1. 初期状態では設定情報が空のため、アプリケーションに必要な設定項目を追記します。

<変更前>

<変更後>

以上でアプリケーション構成ファイルの設定は完了です。
この状態でプロジェクトをビルドすると、実行ファイル（.exe）と合わせて、アプリケーション構成ファイル（.config）も出力されます。

プログラマー

なるほど、App.configはこんな風に使えるのですね。

プロジェクト
リーダー

アプリケーション毎の設定値をソース上で記述してしまうと、設定値の変更をするとき、毎回ビルドし直すことになり大変不便です。設定情報はApp.configなどの外部ファイルに切り出しておく方が便利ですね。

App.configファイルではアプリケーションの設定情報が管理できる

今回はApp.configファイルの内容と追加方法を紹介しました。今まで使用したことがない方は、この機会に一度使用してみてください。頭だけで覚えるよりも、実際にプログラムを書いて実行する方が身につきやすいかと思うのでおすすめです。