从单独的类库访问 web.config？

Question

我正在寻找一种实现以下目标的好方法：

我有一个 Web 应用程序 (MVC 3)，带有一个单独的类库，其中包含我正在制作的 CMS 的后端逻辑。此 CMS 使用 NHibernate 连接到数据库。我希望用户能够在其 web.config 文件中配置连接字符串（最终甚至是数据库的风格）。

我正在寻找一种从 web.config 文件获取连接字符串的好方法，即使 DLL 是完全独立的。这可能吗？我是否必须以某种方式将连接字符串传递到我的类库？或者当应用程序运行时我可以访问它吗？

如果我必须在我的 Web 应用程序中创建一些代码来将连接字符串传递到我的类库，我怎样才能使该代码尽可能可移植，这样我就不必为我的下一个 Web 应用程序再次编写它？

非常感谢您的任何想法。

Answer 1

您可以将连接字符串从网站传递到类库中的类。

与尝试直接从配置文件获取信息相比，这是一个更好的选择，否则您将依赖于具有确切正确密钥的现有配置文件（使测试类变得更加困难）。

请参阅这篇博文 对于反对直接访问配置的参数（这是很常见的做法，但不是最佳实践）。

Answer 2

您可以访问 System.Configuration.ConfigurationManager 来自您的类库。这将使您能够访问 AppSettings 和 ConnectionStrings。

Answer 3

我的设置与我参与的自由开源项目完全相同。它包含“Core”类库中的所有内容（甚至是控制器和 Global.asax.cs）。

有很多有效的解决方案，我选择的一个是创建一个 Settings 类，它本质上是一组静态属性，其中包含：

public static string ConnectionString
{
        get { return ConfigurationManager.ConnectionStrings["MYAPP"].ConnectionString; }
}

注意：确保您的类库已添加 System.Configuration 作为引用。

在您的应用程序（从 HttpApplication 派生的类）内部传递设置，尽管没有什么可以阻止您将 NH 设置与设置类紧密耦合：

protected void Application_Start()
{
        AreaRegistration.RegisterAllAreas();
        RegisterRoutes(RouteTable.Routes);
        SetupNHibernate();
}

public virtual void SetupNHibernate()
{
        NHibernateRepository.Current.Configure(RoadkillSettings.DatabaseType, Settings.ConnectionString, false, Settings.CachedEnabled);
}

如果这对您有任何用处，源代码在这里。

Answer 4

您可以使用 ConfigurationManager 类来访问 web.config 或 app.config 文件中的项目。但是，在您的类库中，请确保从使用者获取任何 appSettings 和/或 connectionString 设置的键名称（最好在构造函数中）。这避免了您选择消费者已经在其他地方使用的密钥名称的问题。

Answer 5

由于您正在 MVC Web 应用程序中使用类库，因此类库也可以访问它。不需要额外的设置。尽管类库在构建时给出了一个单独的 dll，但它在当前项目中被引用。因此连接字符串也可供类库使用。

Answer 6

我会使用像 Autofac 这样的东西来为您提供一些 IoC 实现，它可以为您的连接字符串存储设置界面。这将允许您在应用程序启动时从 web.config 设置值，或者在测试中将其设置为不同的值，而无需将类库耦合到 web.config。

Answer 7

您可以将另一个项目中的新现有项添加到您的类库中。然后将 Web 上的 Build Action 更改为 Embedded Resource，并将 Copy to Output Directory 更改为 Copy if newer .config 文件。

另一个项目中的Web.config

<configuration>
    <appSettings>
        <add key="MyConfigValue" value="Test" />
    </appSettings>
</configuration>

类库测试文件

var doc = XDocument.Load(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Web.config"));

var myConfigValue = doc.Element("configuration")
                       .Element("appSettings")
                       .Elements("add")
                       .FirstOrDefault(e => e.Attribute("key").Value == "MyConfigValue").Attribute("value").Value;