在 .NET 中在运行时合并自定义配置部分

Question

我的问题是关于使用标准 .NET 配置对象和自定义配置元素（可以通过扩展 System.Configuration.ConfigurationSection 类来定义）。我们通常从System.Configuration.ConfigurationManager类的方法中获取这些，GetSection(...)就是一个例子。

加载的配置对象似乎是一个合并配置对象，其中包含应用程序配置文件中的设置（app.config 或 web.config 文件（开发人员可能已创建）以及 ma​​chine.config 文件中定义的内容（后者随 .NET Framework 安装提供）。

因此，我们可以假设首先使用 ma​​chine.config 以分层方式加载配置，然后任何用户定义的配置覆盖该默认设置，并且可以这样查看：

• ma​​chine.config
  • app.config（覆盖/合并 machine.config 中的相应元素）

我的目标是创建多层配置，以便在 ma​​chine.config 和 app.config 之间（如果可能的话，之后）可能还有其他配置文件强>文件：

• ma​​chine.config
  • custom.config（在 machine.config 和 app.config 文件之间产生干扰的自定义配置）
    • app.config - 现在 app.config 与 ma​​chine.config 和 custom.config 合并

---

更新

重点是 - 如果我在 custom.config 和 app.config 中都定义了配置部分，我需要获得两个配置的合并版本当我打电话给ConfigurationManager.GetSection("MyCustomSection")。理想情况下，如果我能够按照this MSDN article 中的描述执行合并，那就太好了。

---

通常，我会编写自己的配置管理器类，并尽可能地获得所需的结果，但假设 .NET 框架可以为 ma​​chine.config 和app.config，我想我可能会从框架的内置功能中受益。此外，如果我确实应该求助于我自己的配置管理器实现，我不知道如何手动触发这种合并。

那么，是否可以利用配置部分/元素与自定义配置文件合并的内置机制？我对为自定义配置部分开发和支持这一点特别感兴趣。 System.Configuration 命名空间包含用于构建配置部分和元素的基础对象，这些对象允许与合并相关的一些设置（例如设置适当的ConfigurationElementCollectionType）。这些是否与仅与 ma​​chine.config （或 Web 应用程序中的多层 web.config 文件）合并有关，或者是否可以手动触发 pre 的合并-加载的配置文件？我试图避免在我的任何自定义配置对象中支持自定义合并，并且可能忘记支持 System.Configuration 中的现有设置...

---

更新

为了回应现有的答案和 cmets，我想做一个重要的澄清。我能够从当前应用程序设置 (app.config / web.config) 和我的 自定义物理文件中加载 ConfigurationSection 对象.config。我需要知道是否有机会通过框架中的一些内置方式，在不诉诸反射和逐个属性比较的情况下合并这些对象。

---

^{注意：如果有更好的解决方案可以在 .NET 3.0+ 上运行，我将不胜感激。如果您的答案针对的是更高版本的框架，请添加注释。}

Answer 1

.NET 配置系统不是超级灵活

该评论指出了这一点，并解释了为什么您已经寻找了很长时间但还没有找到任何东西。并非所有 .NET Framework 部分都是“好”的，System.Configuration 应该放在最底层。对于最终是一项简单的任务但同时变成极其不灵活的事情，它被过度设计了。很难对这是如何发生的进行逆向工程，我认为它因安全问题而瘫痪。或许可以理解，用数据征用程序总是有相当大的风险。

我知道的唯一扩展点是编写你自己的SettingsProvider。该框架只有一个用于一般用途的 LocalFileSettingProvider 类。同样非常不灵活，没有任何方法可以改变它的行为。自定义设置提供程序有一个不错的示例，RegistrySettingsProvider sample 演示了将设置存储在注册表中的提供程序。这可能是编写自己的一个很好的起点。

也许不完全是您的想法，请不要考虑您可以打破 System.Configuration 内部分层的想法。

Answer 2

正如silver 所指出的，配置良好的ExeConfigurationFileMap 可以完成这项工作，但需要付出一定的代价。

我已经以他为例子并制作了它的工作版本。

这是我为测试目的而合并的两个配置文件：

custom.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="custom" type="..." />
  </configSections>
  <custom>
    <singleProperty id="main" value="BaseValue" />
    <propertyCollection>
      <property id="1" value="One" />
      <property id="4" value="Four" />
    </propertyCollection>
  </custom>
</configuration>

app.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="custom" type="..."/>
  </configSections>
  <custom>
    <singleProperty id="main" value="OverriddenValue" />
    <propertyCollection>
      <property id="1" value="OverridenOne" />
      <property id="2" value="Two" />
      <property id="3" value="Three" />
    </propertyCollection>
  </custom>
</configuration>

我使用以下代码来测试合并的设置：

var map = new ExeConfigurationFileMap();
map.MachineConfigFilename = PathToCustomConfig;
map.ExeConfigFilename = PathToAppConfig;
                
var configuration = ConfigurationManager.OpenMappedExeConfiguration(
        map, 
        ConfigurationUserLevel.None);
var section = configuration.GetSection("custom") as CustomConfigSection;
Assert.IsNotNull(section);

Assert.AreEqual(section.SingleProperty.Value, "OverriddenValue");
Assert.AreEqual(section.PropertyCollection.Count, 4);
// Needed to map the properties as dictionary, not to rely on the property order
var values = section.PropertyCollection
        .Cast<SimpleConfigElement>()
        .ToDictionary(x => x.ID, x => x.Value);
Assert.AreEqual(values["1"], "OverridenOne");
Assert.AreEqual(values["2"], "Two");
Assert.AreEqual(values["3"], "Three");
Assert.AreEqual(values["4"], "Four");

这种方法的优点

• 我让内置的合并逻辑工作
• 适用于旧版本的 .NET（在 3.5 上测试）
• 无需反射或其他黑魔法东西来触发行为。

缺点

• 不太确定，但通过设置map.MachineConfigFilename = PathToCustomConfig;，我假设我正在删除由真实machine.config 文件设置的所有值。这可能很容易出错，应该避免用于 Web 应用程序，因为它们中的大多数依赖于真实的 machine.config 中的内容
• 需要传递应用程序配置文件的位置，因为它不再自动确定。因此需要弄清楚在编译代码时如何命名app.config（通常是AssemblyName.exe.config）
• 您可以通过这种方式合并两个文件的内容。如果需要更大的层次结构，那么这将无法正常工作。

我还在完善这项技术，因此我会在完成后返回更新这篇文章。

Answer 3

看看下面的代码，它知道加载你的配置或 exe 配置。 一旦您清楚以下代码，您就可以根据需要自定义加载和合并（加载两次并用另一次覆盖）。

private static void InitConfiguration()
{
    var map = new ExeConfigurationFileMap();
    var AssemblyConfigFile = "";
    if (File.Exists(AssemblyConfigFile))
        map.ExeConfigFilename = AssemblyConfigFile;
    else
        map.ExeConfigFilename = Path.Combine(Environment.CurrentDirectory, Environment.GetCommandLineArgs()[0]+".config");

    var Configuration = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.None);

    var serviceModelSectionGroup = ServiceModelSectionGroup.GetSectionGroup(Configuration);

}

Answer 4

默认情况下实际上有 3 个级别的配置继承：Machine、Exe 和 User（可以是 Roaming 或 Local）。如果您自己加载配置文件，您可以结合使用ExeConfigurationFileMap 类和ConfigurationManager.OpenMappedExeConfiguration 来加载您自己的自定义配置层次结构。

我认为您无法使用此更改 ConfigurationManager 类的默认路径，但您将获得一个 Configuration 元素，该元素可用于从加载的配置层次结构中获取任何部分。

如果您查看How to read configSections 的答案，它包含一些关于确定在层次结构中声明的级别部分的注释（使用 SectionInformation）

var localSections = cfg.Sections.Cast<ConfigurationSection>()
       .Where(s => s.SectionInformation.IsDeclared);

Answer 5

我们可能需要使用这些类 ConfigurationSection 和 ConfigurationProperty

有关实施的详细信息，请参阅以下链接 https://blog.danskingdom.com/adding-and-accessing-custom-sections-in-your-c-app-config/