强类型调用 web.config 而不重复属性名称？

Question

我在这里寻找答案。 如果之前有人问过这个问题，我很抱歉（我怀疑已经问过）。

摘要：如何在不重复属性名称的情况下对 web.config 进行强类型调用？

---

详细信息：在我的代码中，我尝试尽量减少字符串的使用，并且我不喜欢重复定义某些内容。

对这两种习惯的补充是我将 AppSettings 使用（及其字符串）限制为一个类，我在整个项目中引用了该类。 AppSettings 类公开公共属性：

    12   public static string DateFormatString {
    13       get {
    14           return ConfigurationManager.AppSettings["DateFormatString"];
    15       }
    16   }

如何保留此类并防止属性名称重复（第 12 行和第 14 行）？

或者，您可以推荐什么其他解决方案？

Answer 1

我喜欢使用自定义配置处理程序。

http://haacked. com/archive/2007/03/12/custom-configuration-sections-in-3-easy-steps.aspx

Answer 2

您的示例中没有重复：一个 DateFormatString 是属性名称，另一个是字符串。 您只是遵循一个约定，将属性命名为与值的查找键相同的名称。

我确实看到了一个可能的改进。 您应该在静态构造函数中读取一次配置文件并存储值，而不是每次访问属性时都从 AppSettings 中读取它们。

Answer 3

我可能建议将 web.config 反序列化为一个对象。 然后，您可以访问所有配置条目，就好像它们是属性一样（没有比这更强类型的了！）

Answer 4

我为不直接属于我的所有内容创建一个包装器。 这包括缓存、会话、配置、外部 Web 服务等。这使我能够封装使用该小部件的脏细节。 在配置方面，我有一个简单的配置类，它公开了我保存的 app.config 或 web.config 的各种属性。 这可能看起来像这样：

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Linq;
using System.Text;
using RanchBuddy.Core.Services.Impl;
using StructureMap;

namespace RanchBuddy.Core.Services.Impl
{
    [Pluggable("Default")]
    public class ConfigurationService : IConfigurationService
    {
        internal static int GetDefaultCacheDuration_Days()
        {
            return Convert.ToInt32(ConfigurationManager.AppSettings["DefaultCacheDuration_Days"]);
        }

        ...

        internal static LoggingType GetLoggingType()
        {
            string loggingType = ConfigurationManager.AppSettings["LoggingType"].ToString();
            if(loggingType.ToLower() == "verbose")
            {
                return LoggingType.Verbose;
            }
            else if (loggingType.ToLower() == "error")
            {
                return LoggingType.Error;
            }
            return LoggingType.Error;
        }

        ...

        public static string GetRoot()
        {
            string result = "";
            if(ConfigurationManager.AppSettings["Root"] != null)
            {
                result = ConfigurationManager.AppSettings["Root"].ToString();
            }
            return result;
        }
    }
}

在这里，您可以做的不仅仅是从配置文件中获取值。 您可以将字符串转换为它需要的类型。 您可以使用该字符串来确定要返回的枚举值。 等等。但关键是任何需要对配置进行的更改都可以在此处进行。 如果您想更换配置存储的机制，请包括在内！

Answer 5

使用配置部分设计器构建您自己的ConfigurationSection，这样您就不会根本必须使用 AppSettings...但您将拥有自己的设置集合，甚至在 web.config 文件中包含 Intellisense。

Answer 6

一种解决方案可能是，

public enum Settings
{
    None,
    DateFormatString,
    DefeaultUserPrefix,
    SomeOtherValue
}

然后有一个辅助类，例如，

public static class ConfigurationHelper
{
     public static Get<T>(Settings setting)
     {
         string output = ConfigurationManager.AppSettings[setting.ToString()];
         if(string.isNullOrEmpty(output))
               throw new ConfigurationErrorsException("Setting " + setting + " is not defined in Configuration file.");
         return (T)output; //You can probably use Convert.* functions. 
     }
}

您的调用代码将如下所示，

ConfigurationHelper.Get<string>(Settings.DateFormatString);

上述方法提供了某种程度的强类型，但您仍然必须确保配置文件中的设置名称与枚举的名称匹配。

最好的选择是根据配置文件自动生成类。

---

如果您想要强类型属性，您可以编写

public static string DateFormatString
{
    get { return ConfigurationHelper.Get<string>(Settings.DateFormatString); }
}

另外，我建议不要在构造函数中读取配置文件（过早优化？）。 如果您在构造函数中读取配置文件，则意味着您无法在应用程序运行时更改配置文件。

Answer 7

我编写了一个 nuget 包 来执行此操作（除其他外）。 附带的博客文章介绍了详细信息，但这个简化的代码片段显示了相关的要点对于你的问题。

public string DateFormatString =>
    ConfigurationManager.AppSettings[MethodBase.GetCurrentMethod().Name.Replace("get_", "")];