Webでconfigとapp.configファイルにカスタム構成ノードを追加


経験のある開発者はみな開発していることを知っている.NETアプリケーションでは、ログファイルの保存パス、データベース接続情報など、一般的に使用される変更可能な情報をプロファイルで保存できます.これにより、本番環境のパラメータ情報が開発環境と一致しなくても、ソースコードを変更せずにプロファイルを変更して再コンパイルするだけで便利です.また,ノードにアプリケーションの構成情報を保存し,にデータベース接続文字列情報を保存することも一般的に約束されている(詳細は本ブログ『ASP.NET夜話の11』参照).上記の方法と約束は大部分の開発において便利を得るのに十分であるが、場合によってはグループ別に配置情報を格納することができる場合があり、上記の方法を採用すれば直感的ではないだけでなく、読み取りもあまり便利ではないので、幸いである.NETではこのような方法が提供されています.Log 4 NetまたはEnyimを使用した場合Cachingの友達は、次の配置に慣れていないに違いありません.
 

  
  
  
  
  1. <sectionGroup name="enyim.com"><section name="memcached" type="Enyim.Caching.Configuration.MemcachedClientSection, Enyim.Caching" /></sectionGroup> 

または、
 

  
  
  
  
  1. <configSections><section name="log4net" type="System.Configuration.IgnoreSectionHandler"/></configSections> 

上記の構成ファイルが表示されると、configファイルのデフォルトノードではありませんが、上記の構成でプログラムが実行されてもエラーは発生しません.enyim.comまたはlog 4 netというノードが表示されます.これにより,関連構成情報もうまく分類して保存できる.ここで、周公は簡単な例を示します.この例は周公が2006年から開発した自用ソフトウェア(美化されていないので無料で公開されていない)に由来しています.このアプリケーションのconnfigファイルには、独自の構成を追加して、自分のノード、appを追加しました.configファイルの内容は以下の通りです.
 

  
  
  
  
  1. <?xml version="1.0" encoding="utf-8" ?> 
  2. <configuration> 
  3.   <configSections> 
  4.       <section name="SoftwareSettings" type="ImageAssistant.Configuration.SoftwareSettings, ImageAssistant" /> 
  5.   </configSections> 
  6.   <SoftwareSettings> 
  7.     <LoadSettings> 
  8.       <add key="LoadBmp" value="true"/> 
  9.       <add key="LoadJpg" value="true"/> 
  10.       <add key="LoadGif" value="true"/> 
  11.       <add key="LoadPng" value="false"/> 
  12.     </LoadSettings> 
  13.     <PathSettings SavePath="C:\ResizeImages\" SearchSubPath="true"/> 
  14.   </SoftwareSettings> 
  15.   <appSettings> 
  16.     <add key="LoadBmp" value="true"/> 
  17.     <add key="LoadJpg" value="true"/> 
  18.     <add key="LoadGif" value="true"/> 
  19.     <add key="LoadPng" value="false"/> 
  20.     <add key="IncludeSubPath"  value="true"/> 
  21.   </appSettings> 
  22.     
  23. </configuration> 

コンフィギュレーションファイルでは
を使用して、アプリケーションにコンフィギュレーションファイルのSoftwareSettingsノードについて、対応するクラスがImageAssistantプログラムセットImageAssistantであることを伝える.Configuration.SoftwareSettingsクラスがあり、ノードにはノードとノードも見られます.はノードの集合であり、複数のサブノードも含まれています.これらの関係を明確にするには、SoftwareSettings、LoadSettings Collection、LoadSettings Element、およびPathSettings Elementの4つのクラスを追加する必要があります.パブリッシュの便宜上、周公はこの4つのクラスのコードを物理ファイルに配置し、コードは以下の通りです(System.configuration.dllへの参照を追加することに注意してください).
 

  
  
  
  
  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Linq;  
  4. using System.Text;  
  5. using System.Configuration;  
  6.  
  7. // :zhoufoxcn( )  
  8. // :2011-03-08  
  9. //blog:http://blog.csdn.net/zhoufoxcn  http://zhoufoxcn.blog.51cto.com  
  10. // : , , 。  
  11. namespace ImageAssistant.Configuration  
  12. {  
  13.     public sealed class LoadSettingsCollection : ConfigurationElementCollection  
  14.     {  
  15.         private IDictionary<stringbool> settings;  
  16.  
  17.         protected override ConfigurationElement CreateNewElement()  
  18.         {  
  19.             return new LoadSettingsElement();  
  20.         }  
  21.  
  22.         protected override object GetElementKey(ConfigurationElement element)  
  23.         {  
  24.             LoadSettingsElement ep = (LoadSettingsElement)element;  
  25.  
  26.             return ep.Key;  
  27.         }  
  28.  
  29.         protected override string ElementName  
  30.         {  
  31.             get 
  32.             {  
  33.                 return base.ElementName;  
  34.             }  
  35.         }  
  36.  
  37.         public IDictionary<stringbool> Settings  
  38.         {  
  39.             get 
  40.             {  
  41.                 if (settings == null)  
  42.                 {  
  43.                     settings = new Dictionary<stringbool>();  
  44.                     foreach (LoadSettingsElement e in this)  
  45.                     {  
  46.                         settings.Add(e.Key, e.Value);  
  47.                     }  
  48.                 }  
  49.                 return settings;  
  50.             }  
  51.         }  
  52.  
  53.         public bool this[string key]  
  54.         {  
  55.             get 
  56.             {  
  57.                 bool isLoad = true;  
  58.                 if (settings.TryGetValue(key, out isLoad))  
  59.                 {  
  60.                     return isLoad;  
  61.                 }  
  62.                 else 
  63.                 {  
  64.                     throw new ArgumentException(" '" + key + "' 。");  
  65.                 }  
  66.             }  
  67.         }  
  68.  
  69.     }  
  70.  
  71.     public class LoadSettingsElement : ConfigurationElement  
  72.     {  
  73.         [ConfigurationProperty("key", IsRequired = true)]  
  74.         public string Key  
  75.         {  
  76.             get { return (string)base["key"]; }  
  77.             set { base["key"] = value; }  
  78.         }  
  79.         [ConfigurationProperty("value", IsRequired = true)]  
  80.         public bool Value  
  81.         {  
  82.             get { return (bool)base["value"]; }  
  83.             set { base["value"] = value; }  
  84.         }  
  85.     }  
  86.  
  87.     public class PathSettingElement : ConfigurationElement  
  88.     {  
  89.         /// <summary>  
  90.         ///   
  91.         /// </summary>  
  92.         [ConfigurationProperty("SavePath", IsRequired = true)]  
  93.         public string SavePath  
  94.         {  
  95.             get { return (string)base["SavePath"]; }  
  96.             set { base["SavePath"] = value; }  
  97.         }  
  98.         /// <summary>  
  99.         ///   
  100.         /// </summary>  
  101.         [ConfigurationProperty("SearchSubPath", IsRequired = false, DefaultValue = true)]  
  102.         public bool SearchSubPath  
  103.         {  
  104.             get { return (bool)base["SearchSubPath"]; }  
  105.             set { base["SearchSubPath"] = value; }  
  106.         }  
  107.     }  
  108.  
  109.     /// <summary>  
  110.     ///  config  
  111.     /// </summary>  
  112.     public sealed class SoftwareSettings : ConfigurationSection  
  113.     {  
  114.         /// <summary>  
  115.         ///  SoftwareSettings LoadSettings  
  116.         /// </summary>  
  117.         [ConfigurationProperty("LoadSettings", IsRequired = true)]  
  118.         public LoadSettingsCollection LoadSettings  
  119.         {  
  120.             get { return (LoadSettingsCollection)base["LoadSettings"]; }  
  121.         }  
  122.  
  123.         /// <summary>  
  124.         ///  SoftwareSettings PathSettings ,  
  125.         /// </summary>  
  126.         [ConfigurationProperty("PathSettings", IsRequired = false)]  
  127.         public PathSettingElement PathSetting  
  128.         {  
  129.             get { return (PathSettingElement)base["PathSettings"]; }  
  130.             set { base["PathSettings"] = value; }  
  131.         }  
  132.  
  133.     }  

上記のコードでは、configファイルに対応する属性の属性名、IsRequiredは必須属性かどうか、DefaultValueは属性のデフォルト値を示すコンフィギュレーションプロパティという属性が表示されます.最初に、次の関係に注意します.SoftwareSettings:ルートノード、コンフィギュレーション設定から継承されます.LoadSettings Collection:子ノードの集合.コンフィギュレーションElementCollectionから継承されます.LoadSettingsElement:子ノード、コンフィギュレーションElementから継承されます.PathSettingElement:子ノード、コンフィギュレーションElementから継承されます.次のコードを作成した後、上記のクラスをどのように使用すればいいのでしょうか.実は簡単です.以下のようにします.
 

  
  
  
  
  1. class Program  
  2.     {  
  3.         static void Main(string[] args)  
  4.         {  
  5.             SoftwareSettings softSettings = ConfigurationManager.GetSection("SoftwareSettings"as SoftwareSettings;  
  6.  
  7.             foreach (string key in softSettings.LoadSettings.Settings.Keys)  
  8.             {  
  9.                 Console.WriteLine("{0}={1}", key, softSettings.LoadSettings[key]);  
  10.             }  
  11.             Console.WriteLine("SavePath={0},SearchSubPath={1}", softSettings.PathSetting.SavePath, softSettings.PathSetting.SearchSubPath);  
  12.             Console.ReadLine();  
  13.         }  
  14.     } 

このプログラムの実行結果は、LoadBmp=True LoadJpg=True LoadGif=True LoadPng=False SavePath=C:ResizeImages,SearchSubPath=True
まとめ:上記のconfigファイルではで同様の効果が得られましたが、カスタムノードでは関連するアプリケーション構成を簡単に読み取ることができ、メンテナンスも容易です.開発中に本明細書で同様の状況に遭遇した場合は、本明細書で説明する方法を採用してもよい.添付ファイルは、本明細書で使用するソースコードです.
周公2011-03-08