README.md

JieRuntimeNet.Ini

报告 Bug · 请求增加功能

喜欢这个项目？给我点个Star吧！

关于项目

JieRuntime.Ini 是基于 .NET 平台的一款跨平台 ini 配置项处理工具类, 该工具能快速实现 ini 配置文件的增删改查, 轻松分离 ini 配置文件中的 "节"、"键"、"值" 和 "注释", 大量使用了 .NET 平台的特性, 使其更易于使用.

快速开始

本运行库基于 .net standard 2.0 构建, 可以在支持 .net standard 2.0 依赖的任意项目上引用本运行库. 你可以在 Nuget 上搜索 JieRuntime.Ini 来安装本运行库.

Demo

1. 创建一个新的配置项

    // 指定文件路径, 默认使用 UTF8 编码
    IniConfiguration ini = new IniConfiguration (文件路径);
    // 指定文件路径, 指定文件的编码
    IniConfiguration ini = new IniConfiguration (文件路径, 文件编码);

2. 从现有的配置项读取文件

    // 创建对象时指定了文件路径, 因此直接读取
    ini.Load ();

3. 增加配置

    // 增加 "节"
    ini.Configuration.Add (new IniSection ("Section1"));
    // 增加 "键值"
    ini.Configuration["Section1"].Add ("key1", value);

    // 如果 Section1 或 Key1 不存在会自动创建
    ini.Configuration["Section1"]["Key1"] = value;

4. 删除配置

    // 删除 "节"
    ini.Configuration.Remove ("Section1");

    // 删除 "键值"
    ini.Configuration["Section1"].Remove ("Key1");

5. 修改配置

    // 修改 "节"
    // 无论传入的 IniSection 对象的 Name 是何值, 都会被修改成 Section1
    ini.Configuration["Section1"] = new IniSection("xxxxx");

    // 修改 "键值"
    // value 可以是已知范围的任何类型的值, 将会自动转换为文本, 如果 Section1 或 Key1 不存在会自动创建
    ini.Configuration["Section1"]["Key1"] = value;

6. 查询配置

    // 查询 "节", 不存在会自动创建
    IniSection section = ini.Configuration["Section1"];

    // 查询 "键值", 不存在会返回默认值, 会依据返回值的类型自动转换
    var value = ini.Configuration["Section1"]["Key1"];

7. 将修改保存到文件

    // 创建对象时指定了文件路径, 因此直接写入
    ini.Save ();