从 .NET 中的 app.config 或 web.config 读取设置

Question

我正在处理C# class库，该库需要能够从DLL申请中读取web.config或app.config文件中的设置。

我发现了

ConfigurationSettings.AppSettings.Get("MySetting")

有效，但该代码已被 Microsoft 标记为已弃用。

我读过我应该使用：

ConfigurationManager.AppSettings["MySetting"]

但是， System.Configuration.ConfigurationManager class 似乎无法从 C# Class 库项目中获得。

做这个的最好方式是什么？

Answer 1

对于如下所示的示例 app.config 文件：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="countoffiles" value="7" />
    <add key="logfilelocation" value="abc.txt" />
  </appSettings>
</configuration>

您可以使用下面显示的代码阅读上述应用程序设置：

using System.Configuration;

如果还没有，您可能还需要在项目中添加对System.Configuration的引用。 然后，您可以像这样访问值：

string configvalue1 = ConfigurationManager.AppSettings["countoffiles"];
string configvalue2 = ConfigurationManager.AppSettings["logfilelocation"];

Answer 2

您需要在项目的引用文件夹中添加对System.Configuration的引用。

你绝对应该使用ConfigurationManager在过时的ConfigurationSettings 。

Answer 3

.NET Framework 4.5 和 4.6 的更新； 以下将不再起作用：

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

现在通过属性访问设置类：

string keyvalue = Properties.Settings.Default.keyname;

---

有关更多信息，请参阅管理应用程序设置。

Answer 4

右键单击您的类库，然后从菜单中选择“添加引用”选项。

然后从 .NET 选项卡中，选择 System.Configuration。 这会将 System.Configuration DLL 文件包含到您的项目中。

Answer 5

我正在使用它，它对我来说效果很好：

textBox1.Text = ConfigurationManager.AppSettings["Name"];

Answer 6

从配置中读取：

您需要添加对配置的引用：

1. 在您的项目中打开“属性”
2. 转到“设置”选项卡
3. 添加“名称”和“值”

4. 使用以下代码获取价值：

    string value = Properties.Settings.Default.keyname;

保存到配置：

   Properties.Settings.Default.keyName = value;
   Properties.Settings.Default.Save();

Answer 7

您必须向项目添加对 System.Configuration 程序集的引用。

Answer 8

您可能要将 App.config 文件添加到 DLL 文件中。 App.Config 仅适用于可执行项目，因为所有 DLL 文件都从正在执行的 EXE 文件的配置文件中获取配置。

假设您的解决方案中有两个项目：

• 某个DLL
• 某个执行器

您的问题可能与您将 app.config 文件包含到 SomeDLL 而不是 SomeExe 的事实有关。 SomeDll 能够从 SomeExe 项目中读取配置。

Answer 9

尝试这个：

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

在web.config文件中，这应该是下一个结构：

<configuration>
<appSettings>
<add key="keyname" value="keyvalue" />
</appSettings>
</configuration>

Answer 10

我有同样的问题。 只需这样阅读： System.Configuration.ConfigurationSettings.AppSettings["MySetting"]

Answer 11

步骤 1：右键单击引用选项卡以添加引用。

第 2 步：单击程序集选项卡

第 3 步：搜索“System.Configuration”

第四步：点击确定。

然后它会起作用。

 string value = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Answer 12

因为我发现通过在 System.Configuration 上创建一个包装类，以系统的方式访问应用程序设置变量的最佳方法如下

public class BaseConfiguration
{
    protected static object GetAppSetting(Type expectedType, string key)
    {
        string value = ConfigurationManager.AppSettings.Get(key);
        try
        {
            if (expectedType == typeof(int))
                return int.Parse(value);
            if (expectedType == typeof(string))
                return value;

            throw new Exception("Type not supported.");
        }
        catch (Exception ex)
        {
            throw new Exception(string.Format("Config key:{0} was expected to be of type {1} but was not.",
                key, expectedType), ex);
        }
    }
}

现在我们可以使用另一个类通过硬编码名称访问所需的设置变量，如下所示：

public class ConfigurationSettings:BaseConfiguration
{
    #region App setting

    public static string ApplicationName
    {
        get { return (string)GetAppSetting(typeof(string), "ApplicationName"); }
    }

    public static string MailBccAddress
    {
        get { return (string)GetAppSetting(typeof(string), "MailBccAddress"); }
    }

    public static string DefaultConnection
    {
        get { return (string)GetAppSetting(typeof(string), "DefaultConnection"); }
    }

    #endregion App setting

    #region global setting


    #endregion global setting
}

Answer 13

web.config与 Web 应用程序一起使用。 web.config默认有几个 web 应用程序所需的配置。 您可以为 Web 应用程序下的每个文件夹创建一个web.config 。

app.config用于 Windows 应用程序。 在 Visual Studio 中构建应用程序时，它会自动重命名为<appname>.exe.config并且此文件必须与应用程序一起交付。

您可以使用相同的方法从两个配置文件中调用app settings值：System.Configuration.ConfigurationSettings.AppSettings["Key"]

Answer 14

我强烈建议您为此调用创建一个包装器。 类似于ConfigurationReaderService并使用依赖注入来获取此类。 通过这种方式，您将能够隔离此配置文件以进行测试。

所以使用ConfigurationManager.AppSettings["something"]; 建议并返回此值。 如果 .config 文件中没有任何可用的密钥，则使用此方法您可以创建某种默认返回值。

Answer 15

此外，您可以使用Formo ：

配置：

<appSettings>
    <add key="RetryAttempts" value="5" />
    <add key="ApplicationBuildDate" value="11/4/1999 6:23 AM" />
</appSettings>

代码：

dynamic config = new Configuration();
var retryAttempts1 = config.RetryAttempts;                 // Returns 5 as a string
var retryAttempts2 = config.RetryAttempts(10);             // Returns 5 if found in config, else 10
var retryAttempts3 = config.RetryAttempts(userInput, 10);  // Returns 5 if it exists in config, else userInput if not null, else 10
var appBuildDate = config.ApplicationBuildDate<DateTime>();

Answer 16

为了完整起见，还有一个仅适用于 Web 项目的选项：System.Web.Configuration.WebConfigurationManager.AppSettings["MySetting"]

这样做的好处是不需要添加额外的引用，因此对于某些人来说可能更可取。

Answer 17

我总是创建一个 IConfig 接口，其中包含为所有配置值声明的类型安全属性。 Config 实现类然后包装对 System.Configuration 的调用。 您所有的 System.Configuration 调用现在都集中在一个地方，维护和跟踪正在使用的字段并声明它们的默认值变得更加容易和干净。 我编写了一组私有辅助方法来读取和解析常见数据类型。

使用IoC框架，您可以通过简单地将接口传递给类构造函数来访问应用程序中任何位置的 IConfig 字段。 然后，您还可以在单​​元测试中创建 IConfig 接口的模拟实现，以便您现在可以测试各种配置值和值组合，而无需接触 App.config 或 Web.config 文件。

Answer 18

ConfigurationManager 不是您访问自己的设置所需要的。

为此，您应该使用

{YourAppName}.Properties.Settings.{settingName}

Answer 19

我能够使以下方法适用于 .NET Core 项目：

脚步：

1. 在您的项目中创建一个 appsettings.json（格式如下）。
2. 接下来创建一个配置类。 格式如下。

3. 我创建了一个 Login() 方法来显示配置类的用法。

   在您的项目中使用内容创建 appsettings.json：

    { "Environments": { "QA": { "Url": "somevalue", "Username": "someuser", "Password": "somepwd" }, "BrowserConfig": { "Browser": "Chrome", "Headless": "true" }, "EnvironmentSelected": { "Environment": "QA" } } public static class Configuration { private static IConfiguration _configuration; static Configuration() { var builder = new ConfigurationBuilder() .AddJsonFile($"appsettings.json"); _configuration = builder.Build(); } public static Browser GetBrowser() { if (_configuration.GetSection("BrowserConfig:Browser").Value == "Firefox") { return Browser.Firefox; } if (_configuration.GetSection("BrowserConfig:Browser").Value == "Edge") { return Browser.Edge; } if (_configuration.GetSection("BrowserConfig:Browser").Value == "IE") { return Browser.InternetExplorer; } return Browser.Chrome; } public static bool IsHeadless() { return _configuration.GetSection("BrowserConfig:Headless").Value == "true"; } public static string GetEnvironment() { return _configuration.GetSection("EnvironmentSelected")["Environment"]; } public static IConfigurationSection EnvironmentInfo() { var env = GetEnvironment(); return _configuration.GetSection($@"Environments:{env}"); } } public void Login() { var environment = Configuration.EnvironmentInfo(); Email.SendKeys(environment["username"]); Password.SendKeys(environment["password"]); WaitForElementToBeClickableAndClick(_driver, SignIn); }

Answer 20

如果您需要/想要使用ConfigurationManager类...

您可能需要通过NuGet 包管理器加载System.Configuration.ConfigurationManager

工具->NuGet 包管理器->管理解决方案的 NuGet 包...

微软文档

文档中值得注意的一件事......

如果您的应用程序需要对其自己的配置进行只读访问，我们建议您使用 GetSection(String) 方法。 此方法提供对当前应用程序缓存的配置值的访问，它比 Configuration 类具有更好的性能。

Answer 21

几天来，我一直试图找到解决同一问题的方法。 我能够通过在web.config文件的 appsettings 标记中添加一个键来解决这个问题。 使用帮助程序时，这应该覆盖 .dll 文件。

<configuration>
    <appSettings>
        <add key="loginUrl" value="~/RedirectValue.cshtml" />
        <add key="autoFormsAuthentication" value="false"/>
    </appSettings>
</configuration>

Answer 22

另一种可能的解决方案：

var MyReader = new System.Configuration.AppSettingsReader();
string keyvalue = MyReader.GetValue("keyalue",typeof(string)).ToString();

Answer 23

您可以使用以下行。 在我的情况下，它正在工作： System.Configuration.ConfigurationSettings.AppSettings["yourKeyName"]

您必须注意上面的代码行也是旧版本，并且在新库中已弃用。

Answer 24

请检查您正在使用的 .NET 版本。 它应该高于 4。并且您必须将 System.Configuration 系统库添加到您的应用程序中。

Answer 25

额外：如果您正在处理类库项目，则必须嵌入settings.json文件。

类库不应该直接引用 app.config 中的任何内容——该类没有 app.config，因为它不是应用程序，而是一个类。

1. 转到 JSON 文件的属性。
2. 更改构建操作 -> 嵌入式资源。
3. 使用下面的代码来阅读它。

var assembly = Assembly.GetExecutingAssembly();

var resourceStream = assembly.GetManifestResourceStream("Assembly.file.json");

string myString = reader.ReadToEnd();

现在我们有了一个 JSON 字符串，我们可以使用JsonConvert反序列化它

如果您没有将文件嵌入到程序集中，则不能只使用 DLL 文件而不使用该文件

Answer 26

我正在使用 Visual Studio for Mac 版本 17.0.6。

正如您在此屏幕截图中看到的，无法添加对 System.Configuration 的引用。

解决方案：

1. 安装 NuGet Package - System.Configuration.ConfigurationManager。
2. 创建 app.config 文件并将“构建操作”设置为“EmbeddedResource”

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <appSettings>
        <add key="name" value="Joe"/>
    </appSettings>
</configuration>

3. 使用 System.Configuration；
4. 请享用）

字符串名称 = ConfigurationManager.AppSettings["name"];

Answer 27

我在这个链接https://stackoverflow.com/a/1836938/1492229中找到了答案

不仅需要使用命名空间System.Configuration 。 您还必须添加对程序集System.Configuration.dll的引用，通过

1. 右键单击引用/依赖项
2. 选择添加参考
3. 查找并添加System.Configuration 。

这肯定会起作用。 同样对于NameValueCollection你必须写：

using System.Collections.Specialized;

Answer 28

这是一个例子： App.config

<applicationSettings>
    <MyApp.My.MySettings>
        <setting name="Printer" serializeAs="String">
            <value>1234 </value>
        </setting>
    </MyApp.My.MySettings>
</applicationSettings>

Dim strPrinterName as string = My.settings.Printer