在web.config和app.config文件中增加自定义配置节点的方法
有经验的开发人员都知道在开发.NET应用时可以利用配置文件保存一些常用并且有可能变化的信息,例如日志文件的保存路径、数据库连接信息等等,这样即使生产环境中的参数信息与开发环境不一致也只需要更改配置文件而不用改动源代码再重新编译,极其方便。并且我们一般还约定,在<appSettings>节点保存应用程序的配置信息,在<connectionStrings>中保存数据库连接字符串信息。
上面的这些方法和约定足以让我们在大部分开发中获得方便,但是在有些情况下有些配置信息可以按组分类存放,如果采用上面的方法不仅不直观,而且读取起来也不是太方便,幸好在.NET里就提供了这样的方法。如果有使用过Log4Net或者Enyim.Caching的朋友,肯定对下面的配置不会陌生:
<sectionGroup name="enyim.com"><section name="memcached"
type="Enyim.Caching.Configuration.MemcachedClientSection, Enyim.Caching" /></sectionGroup>
或:
<configSections><section name="log4net" type="System.Configuration.IgnoreSectionHandler"/></configSections>
在出现上面配置的配置文件中,我们就会找到名称为"enyim.com"或者"log4net"的节点,尽管它们本不属于config文件的默认节点,但是通过上面的配置之后程序运行并不会报错。这样一来,相关配置信息也可以很好分类保存起来。
在这里我演示一个简单的例子,这个例子来源于我的一个从2006年起就开始开发的自用软件(因为没有美化所以没有免费发布),在这个应用程序的connfig文件中我增加了一些特有的配置,所以新增了一个自己的节点,app.config文件内容如下:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="SoftwareSettings" type="ImageAssistant.Configuration.SoftwareSettings, ImageAssistant" />
</configSections>
<SoftwareSettings>
<LoadSettings>
<add key="LoadBmp" value="true"/>
<add key="LoadJpg" value="true"/>
<add key="LoadGif" value="true"/>
<add key="LoadPng" value="false"/>
</LoadSettings>
<PathSettings SavePath="C:\ResizeImages\" SearchSubPath="true"/>
</SoftwareSettings>
<appSettings>
<add key="LoadBmp" value="true"/>
<add key="LoadJpg" value="true"/>
<add key="LoadGif" value="true"/>
<add key="LoadPng" value="false"/>
<add key="IncludeSubPath" value="true"/>
</appSettings>
</configuration>
在config文件中我们使用<section name="SoftwareSettings" type="ImageAssistant.Configuration.SoftwareSettings, ImageAssistant" />告诉应用程序对于配置文件中的SoftwareSettings节点,其对应的类是ImageAssistant程序集中ImageAssistant.Configuration.SoftwareSettings类,并且在<SoftwareSettings>节点中我们还看到有<LoadSettings>节点和<PathSettings>节点,其中<LoadSettings>是一个节点集合,还包含有多个子节点,为了表示清楚这些关系我们需要添加四个类:SoftwareSettings、LoadSettingsCollection、LoadSettingsElement及PathSettingElement。为了发布方便,我将这四个类的代码放在一个物理文件中,代码如下(注意添加对System.Configuration.dll的引用):
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Configuration;
namespace ImageAssistant.Configuration
{
public sealed class LoadSettingsCollection : ConfigurationElementCollection
{
private IDictionary<string, bool> settings;
protected override ConfigurationElement CreateNewElement()
{
return new LoadSettingsElement();
}
protected override object GetElementKey(ConfigurationElement element)
{
LoadSettingsElement ep = (LoadSettingsElement)element;
return ep.Key;
}
protected override string ElementName
{
get
{
return base.ElementName;
}
}
public IDictionary<string, bool> Settings
{
get
{
if (settings == null)
{
settings = new Dictionary<string, bool>();
foreach (LoadSettingsElement e in this)
{
settings.Add(e.Key, e.Value);
}
}
return settings;
}
}
public bool this[string key]
{
get
{
bool isLoad = true;
if (settings.TryGetValue(key, out isLoad))
{
return isLoad;
}
else
{
throw new ArgumentException("没有对'" + key + "'节点进行配置。");
}
}
}
}
public class LoadSettingsElement : ConfigurationElement
{
[ConfigurationProperty("key", IsRequired = true)]
public string Key
{
get { return (string)base["key"]; }
set { base["key"] = value; }
}
[ConfigurationProperty("value", IsRequired = true)]
public bool Value
{
get { return (bool)base["value"]; }
set { base["value"] = value; }
}
}
public class PathSettingElement : ConfigurationElement
{
/// <summary>
///
/// </summary>
[ConfigurationProperty("SavePath", IsRequired = true)]
public string SavePath
{
get { return (string)base["SavePath"]; }
set { base["SavePath"] = value; }
}
/// <summary>
///
/// </summary>
[ConfigurationProperty("SearchSubPath", IsRequired = false, DefaultValue = true)]
public bool SearchSubPath
{
get { return (bool)base["SearchSubPath"]; }
set { base["SearchSubPath"] = value; }
}
}
/// <summary>
/// 对应config文件中的
/// </summary>
public sealed class SoftwareSettings : ConfigurationSection
{
/// <summary>
/// 对应SoftwareSettings节点下的LoadSettings子节点
/// </summary>
[ConfigurationProperty("LoadSettings", IsRequired = true)]
public LoadSettingsCollection LoadSettings
{
get { return (LoadSettingsCollection)base["LoadSettings"]; }
}
/// <summary>
/// 对应SoftwareSettings节点下的PathSettings子节点,非必须
/// </summary>
[ConfigurationProperty("PathSettings", IsRequired = false)]
public PathSettingElement PathSetting
{
get { return (PathSettingElement)base["PathSettings"]; }
set { base["PathSettings"] = value; }
}
}
}
在上面的代码中可以看到ConfigurationProperty这个属性,这是表示对应的属性在config文件中的属性名,IsRequired表示是否是必须的属性,还有DefaultValue表示属性的默认值。初次之外,我们还要注意以下关系:
SoftwareSettings:根节点,继承自ConfigurationSection。
LoadSettingsCollection:子节点集合,继承自ConfigurationElementCollection。
LoadSettingsElement:子节点,继承自ConfigurationElement。
PathSettingElement:子节点,继承自ConfigurationElement。
编写了如下代码之后,我们又该如何使用上面的类呢?其实很简单,如下:
class Program
{
static void Main(string[] args)
{
SoftwareSettings softSettings = ConfigurationManager.GetSection("SoftwareSettings") as SoftwareSettings;
foreach (string key in softSettings.LoadSettings.Settings.Keys)
{
Console.WriteLine("{0}={1}", key, softSettings.LoadSettings[key]);
}
Console.WriteLine("SavePath={0},SearchSubPath={1}", softSettings.PathSetting.SavePath, softSettings.PathSetting.SearchSubPath);
Console.ReadLine();
}
}
这个程序的运行结果如下:
LoadBmp=True
LoadJpg=True
LoadGif=True
LoadPng=False
SavePath=C:/ResizeImages/,SearchSubPath=True
总结:在上面的config文件中通过<appSettings>也达到了类似的效果,但是通过自定义节点我们可以方便地读取相关的应用程序配置,同时也便于维护。如果在开发过程中遇到本文中类似的情况,不妨采取本文所述的方式。
相关文章
- 这篇文章主要介绍了ASP.NET配置文件Web.config,Web.config是asp.net应用程序中一个很重要的配置文件,需要的朋友可以参考下...2021-09-22
.NET Core 2.0迁移小技巧之web.config 配置文件示例详解
这篇文章主要给大家介绍了关于.NET Core 2.0迁移技巧之web.config 配置文件的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面跟着小编来一起学习学习吧。...2021-09-22IIS7.5提示无法写入配置文件web.config的解决方法
这篇文章主要介绍了IIS7.5提示无法写入配置文件web.config的解决方法,需要的朋友可以参考下...2016-01-27Asp.Net FckEditor在web.config中配置的具体实例
Asp.Net FckEditor在web.config中配置的具体实例,需要的朋友可以参考一下...2021-09-22- Web.config 和 App.config 的区别分析,需要的朋友可以参考一下...2021-09-22
- 本篇文章给大家分享了C#App.config和Web.config加密的相关知识点以及具体代码步骤,有兴趣的朋友参考学习下。...2020-06-25
- C#读写操作app.config中的数据应用介绍;需要的朋友可以参考下...2020-06-25
- 加密web.config的方法分享,需要的朋友可以参考一下...2021-09-22
- 在本篇内容里小编给大家分享了C#获取App.Config配置项的方法和相关知识点,需要的朋友们学习下。...2020-06-25
- 下面小编就为大家带来一篇c# 配置文件App.config操作类库的方法。小编觉的挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25
- 这篇文章主要介绍了ASP.NET配置文件Web.config用法,详细解读了Web.config配置文件各个节点的含义及用法,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了ASP.NET web.config 节点的配置,讲解的非常详细,需要的朋友可以参考下。...2021-09-22
图解修改IIS web.config配置文件增设置默认文档的方法
通常我们在IIS中发布一个网站过后,都需要手动设置网站的启动页面,下面我介绍如何使用代码,而不需要手动设置...2016-01-27- C#中Web.Config加密与解密的方法,需要的朋友可以参考一下...2020-06-25
c#读写App.config,ConfigurationManager.AppSettings 不生效的解决方法
这篇文章主要介绍了c#读写App.config,ConfigurationManager.AppSettings 不生效的解决方法,需要的朋友可以参考下...2020-06-25- 这篇文章主要介绍了C#中读取App.config配置文件代码实例,包括循环读取、单个读取的方法,需要的朋友可以参考下...2020-06-25
SQL Server数据库连接 Web.config如何配置
以下的文章主要描述的是Web.config正确配置SQL Server数据库连接的实际擦步骤。我们以图文结合的方式对其有个更好的说明,需要的朋友可以参考下...2021-09-22- web.config是asp.net一个重要的配置文件,本文将介绍如何利用web.config配置伪静态,步骤很详细,需要了解的朋友可以参考下...2021-09-22
- Web.config文件是一个XML文本文件,它用来储存 ASP.NET Web 应用程序的配置信息(如最常用的设置ASP.NET Web 应用程序的身份验证方式),它可以出现在应用程序的每一个目录中,接下来详细介绍一下配置情况,感兴趣的朋友可以了解下...2021-09-22
- 这篇文章主要介绍了web.config使用方法,具体格式,注意点等方面,有需要的小伙伴可以参考下。...2021-09-22