如何在 .NET 核心中使用 .settings 文件？

Question

我正在将应用程序移植到依赖.settings 文件的 .NET 核心。不幸的是，我找不到从 .NET 核心读取它的方法。通常，将以下行添加到 .csproj 会生成一个 TestSettings 类，它可以让我读取设置。

<ItemGroup>
    <None Include="TestSettings.settings">
        <Generator>SettingsSingleFileGenerator</Generator>
    </None>
</ItemGroup>

不幸的是，这似乎不再起作用。我什至无法验证SettingsSingleFileGenerator 是否运行。这个GitHub issue 表明这是新的.csproj 格式的错误，但没有人提供替代方案。

在 .NET core 中读取.settings 文件的正确方法是什么？

Answer 1

对于 .NET Core 2.x，请使用 Microsoft.Extensions.Configuration 命名空间（请参阅下面的注释），并且 NuGet 上有大量扩展，您需要从环境变量到 Azure Key Vault（但更现实的是，JSON 文件、XML 等）。

这是一个来自控制台程序的示例，该程序检索设置的方式与我们在为我们的 Azure 站点启动 Kestrel 时使用它们的方式相同：

public static IConfiguration Configuration { get; } = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)

    // This allows us to set a system environment variable to Development
    // when running a compiled Release build on a local workstation, so we don't
    // have to alter our real production appsettings file for compiled-local-test.
    //.AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Production"}.json", optional: true)

    .AddEnvironmentVariables()
    //.AddAzureKeyVault()
    .Build();

然后在需要设置的代码中，您只需引用 Configuration 或注册 IConfiguration 以进行依赖注入或其他任何操作。

注意：IConfiguration 是只读的，并且可能永远不会根据this 评论获得持久性。因此，如果需要阅读和写作，您将需要一个不同的选项。可能是System.Configuration sans 设计师。

Answer 2

正如我在问题中所问的那样，这不可能是“正确的”，但我将其用作权宜之计，直到出现更合理的情况。我不能保证它适用于其他任何人。

将您的 .settings 文件作为嵌入资源包含在内，然后像这样使用它：

private static readonly ConfigurationShim Configuration = new ConfigurationShim("MyApp.Settings.settings");
public static bool MyBoolSetting => (bool) Configuration["MyBoolSetting"];

代码：

internal class ConfigurationShim
{
    private static readonly XNamespace ns = "http://schemas.microsoft.com/VisualStudio/2004/01/settings";

    private readonly Lazy<IDictionary<string, object>> configuration;

    public ConfigurationShim(string settingsResourceName)
    {
        configuration = new Lazy<IDictionary<string, object>>(
            () =>
            {
                Assembly assembly = Assembly.GetExecutingAssembly();
                using (Stream stream = assembly.GetManifestResourceStream(settingsResourceName))
                using (var reader = new StreamReader(stream))
                {
                    XDocument document = XDocument.Load(reader);
                    return document.Element(ns + "SettingsFile")
                                   .Element(ns + "Settings")
                                   .Elements(ns + "Setting")
                                   .Select(ParseSetting)
                                   .ToDictionary(kv => kv.Item1, kv => kv.Item2);
                }
            });
    }

    public object this[string property] => configuration.Value[property];

    private static (string, object) ParseSetting(XElement setting)
    {
        string name = setting.Attribute("Name").Value;
        string typeName = setting.Attribute("Type").Value;
        string value = setting.Element(ns + "Value").Value;

        Type type = Type.GetType(typeName);
        IEnumerable<ConstructorInfo> ctors = GetSuitableConstructors(type);
        IEnumerable<MethodInfo> staticMethods = GetSuitableStaticMethods(type);

        object obj = null;
        foreach (MethodBase method in ctors.Cast<MethodBase>().Concat(staticMethods))
        {
            try
            {
                obj = method.Invoke(null, new object[] {value});
                break;
            }
            catch (TargetInvocationException)
            {
                // ignore and try next alternative
            }
        }

        return (name, obj);
    }

    private static IEnumerable<MethodInfo> GetSuitableStaticMethods(Type type)
    {
        // To use a static method to construct a type, it must provide a method that
        // returns a subtype of itself and that method must take a single string as
        // an argument. It cannot be generic.
        return type.GetMethods().Where(method =>
        {
            ParameterInfo[] parameters = method.GetParameters();
            return !method.ContainsGenericParameters &&
                   method.IsStatic &&
                   parameters.Length == 1 &&
                   parameters[0].ParameterType.IsAssignableFrom(typeof(string)) &&
                   type.IsAssignableFrom(method.ReturnType);
        });
    }

    private static IEnumerable<ConstructorInfo> GetSuitableConstructors(Type type)
    {
        // We need a constructor of a single string parameter with no generics.
        return type.GetConstructors().Where(ctor =>
        {
            ParameterInfo[] parameters = ctor.GetParameters();
            return !ctor.ContainsGenericParameters &&
                   parameters.Length == 1 &&
                   parameters[0].ParameterType.IsAssignableFrom(typeof(string));
        });
    }
}

Answer 3

移植现有项目时，我通常将生成的 Settings.Designer.cs 从旧项目复制到新项目。但我知道，这不利于更改设置文件或添加新的设置键。 我还注意到安装新版本后用户的设置被删除了，.net-Framework-Settings 不是这样。