dotnet C# 高性能配置文件读写库 dotnetCampus.Configurations 简介

dotnet add package dotnetCampus.Configurations

<PackageReference Include="dotnetCampus.Configurations" Version="1.6.8" />

// 使用一个文件路径创建默认配置的实例。文件可以存在也可以不存在，甚至其所在的文件夹也可以不需要提前存在。
// 这里的配置文件后缀名 coin 是 Configuration\n，即 “配置+换行符” 的简称。你也可以使用其他扩展名，因为它实际上只是 UTF-8 编码的纯文本而已。
var configs = DefaultConfiguration.FromFile(@"C:\Users\lvyi\Desktop\walterlv.coin");

// 获取配置 Foo 的字符串值。
// 这里的 value 一定不会为 null，如果文件不存在或者没有对应的配置项，那么为空字符串。
string value0 = configs["Foo"];

// 获取字符串值的时候，如果文件不存在或者没有对应的配置项，那么会使用默认值（空传递运算符 ?? 可以用来指定默认值）。
string value1 = configs["Foo"] ?? "anonymous";

// 设置配置 Foo 的字符串值。
configs["Foo"] = "lvyi";

// 可以设置为 null，但你下次再次获取值的时候却依然保证不会返回 null 字符串。
configs["Foo"] = null;

// 可以设置为空字符串，效果与设置为 null 是等同的。
configs["Foo"] = "";

// 这里是大型项目配置初始化处的代码。
// 此类型中包含底层的配置读写方法，而且所有读写全部是异步的，防止影响启动性能。
var configFileName = @"C:\Users\lvyi\Desktop\walterlv.coin";
var config = ConfigurationFactory.FromFile(configFileName);

// 如果你需要对整个应用程序公开配置，那么可以公开 CreateAppConfigurator 方法返回的新实例。
// 这个实例的所有配置读写全部是同步方法，这是为了方便其他模块使用。
// 以下是 Container 即是容器，放入到容器中相当于全局单例
Container.Set<IAppConfigurator>(config.CreateAppConfigurator());

internal class StateConfiguration : Configuration
{
    /// <summary>
    /// 获取或设置整型。
    /// </summary>
    internal int? Count
    {
        get => GetInt32();
        set => SetValue(value);
    }

    /// <summary>
    /// 获取或设置带默认值的整型。
    /// </summary>
    internal int Length
    {
        get => GetInt32() ?? 2;
        set => SetValue(Equals(value, 2) ? null : value);
    }

    /// <summary>
    /// 获取或设置布尔值。
    /// </summary>
    internal bool? State
    {
        get => GetBoolean();
        set => SetValue(value);
    }

    /// <summary>
    /// 获取或设置字符串。
    /// </summary>
    internal string Value
    {
        get => GetString();
        set => SetValue(value);
    }

    /// <summary>
    /// 获取或设置带默认值的字符串。
    /// </summary>
    internal string Host
    {
        get => GetString() ?? "https://localhost:17134";
        set => SetValue(Equals(value, "https://localhost:17134") ? null : value);
    }

    /// <summary>
    /// 获取或设置非基元值类型。
    /// </summary>
    internal Rect? Screen
    {
        get => this.GetValue<Rect>();
        set => this.SetValue<Rect>(value);
    }
}

private readonly IAppConfiguration _config = Container.Get<IAppConfigurator>(); // 从 Container 容器获取，相当于从单例获取对象

// 读取配置。
private void Restore()
{
    var config = _config.Of<StateConfiguration>();
    var bounds = config.Screen;
    if (bounds != null)
    {
        // 恢复窗口位置和尺寸。
    }
}

// 写入配置。
public void Update()
{
    var config = _config.Of<StateConfiguration>();
    config.Screen = new Rect(0, 0, 3840, 2160);
}

public void Foo(IConfigurationBuilder builder)
{
     IAppConfigurator appConfigurator = builder.ToAppConfigurator();
     // 完成接入
}

public void Foo(IConfiguration configuration)
{
     IAppConfigurator appConfigurator = configuration.ToAppConfigurator();
     // 完成接入
}

private void Foo(IConfiguration configuration)
{
    IAppConfigurator appConfigurator = configuration.ToAppConfigurator();
    var config = appConfigurator.Of<StateConfiguration>();
    // 读取配置。
    var bounds = config.Screen;
    if (bounds != null)
    {
        // 恢复窗口位置和尺寸。
    }
    // 写入配置。
    config.Screen = new Rect(0, 0, 3840, 2160);
}

> 配置文件
> 版本 1.0
State.BuildLogFile
xxxxx
> 注释内容
Foo
这是第一行
这是第二行
>
> 配置文件结束