C Sharp/DLLのApp.config

提供: MonoBook
移動: 案内検索

.NET FrameworkDLLライブラリ)でApp.configアプリケーション構成ファイル)を使う方法を記述する。

手順[編集]

もっといい方法があると思うが、知っている人がいたら教えて欲しい。

ライブラリプロジェクト内にApp.configファイルを作る[編集]

ライブラリプロジェクトにApp.configアプリケーション構成ファイル)を追加する。 なお、app.configの中身の書き方は同じ。

App.configを「.dll.config」にリネームする[編集]

App.configのファイル名を「DLL名」+「.config」にリネームする。

たとえば「monobooklib.dll」であれば「monobooklib.dll.config」とする。 もっと自動で出来るかっこいい方法がありそうな気がしないでもないが知らん。

常にコピー[編集]

プロジェクト内のApp.configというファイル名の場合は自動的にコピーされるが、リネームしてあると自動的にはコピーされない。 また、App.configというファイル名でも別プロジェクトにはコピーされない。

そんな感じなので、Visual Studioで.dll.configファイルのプロパティを開き「出力ディレクトリにコピー」の値を「常にコピーする」に設定しておくと捗る。 なお.dll.configファイルは自動で強制上書きされると嬉しくないという場合は、この手順を飛ばして手動でコピーするとよい。

.dll.configファイルを読み込むクラスを作る[編集]

C#での記述例。

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Configuration;
 
    public static class ConfigUtil
    {
        public static System.Configuration.Configuration GetConfig(Type type)
        {
            string dll_config_path = type.Assembly.Location + ".config";
 
            if (!File.Exists(dll_config_path))
            {
                return null;
            }
 
            var file_map = new ExeConfigurationFileMap();
            file_map.ExeConfigFilename = dll_config_path;
            System.Configuration.Configuration config = ConfigurationManager.OpenMappedExeConfiguration(file_map, ConfigurationUserLevel.None);
 
            return config;
        }
    }

使ってみる[編集]

以下の設定ファイルはライブラリプロジェクトにあるものとする。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="hello"  value="monobook" />
  </appSettings>
</configuration>

以下のコードはライブラリプロジェクトにあるものとする。

    public class TestClass
    {
        public string Name { get; set; }
 
        public TestClass()
        {
            var config = ConfigUtil.GetConfig(this.GetType());
            var setting = config.AppSettings.Settings["hello"];
            if (setting != null)
            {
                this.Name = setting.Value;
            }
        }
    }

以下のコードはライブラリプロジェクトとは別にあるものとする。

    using System;
 
    class Program
    {
        static void Main(string[] args)
        {
            var test = new TestClass();
            Console.WriteLine(test.Name);
        }
    }

関連項目[編集]

参考文献[編集]

外部リンク[編集]