c#通用配置文件读写类与格式转换xml,ini,json

.NET下编写程序的时候经常会使用到配置文件。配置文件格式通常有xmlinijson等几种,操作不同类型配置文件需要使用不同的方法,操作较为麻烦。特别是针对同时应用不同格式配置文件的时候,很容易引起混淆。如果使用一个统一的方法对其进行操作,岂不美哉。

技术方案

思路很简单,就是使用一个基类将配置文件的内容抽象出来,不同配置文件有不同的实现,对外统一调用方法。最开始,打算自己写一个,后来对比ini与xml的时候(最开始没有把json考虑进来,自己用它来做配置文件的项目较少),发现xml完全可以替代ini文件的描述,直接用xml不是更好?

于是方案就变成了用xml作为最基础的数据对象,其他配置文件转换成xml进行操作

XDocument VS XmlDocment

不解释,直接看图。

img

ini <-> xml

ini文件构造比较简单,常见的ini有以下几条规范:

  1. 注释以;开头,一直到行尾;
  2. 类别项用[]包围,占据一整行;
  3. 类别项下可以有多个配置项,直到下一个类别项或EOF结束;
  4. 配置项格式:key=value

ini格式是二级配置结构:类别>key。通过类别和key就可以唯一获得一个值。

public static XDocument ToXml(this string[] iniStr)
{
    //ini没有根节点是不能直接转成xml的。
    XDocument xdoc = new XDocument(new XElement("G" + Guid.NewGuid().ToString("N")));
    XElement node = xdoc.Root;
    foreach (var line in iniStr)
    {
        var cline = line.Trim();
        if (string.IsNullOrWhiteSpace(cline)) continue;
        switch (line[0])
        {
            case ';':
                node.Add(new XComment(cline.Substring(1)));
                break;
            case '[':
                node = new XElement(cline.Substring(1,line.Length - 2));
                xdoc.Root.Add(node);
                break;
            case '\r':
                break;
            default:
                int index = cline.IndexOf('=');
                if (index < 1)
                {
                    throw new InvalidOperationException("Property does not contains '=' operator");
                }
                node.Add(new XElement(cline.Substring(0,index).Trim(),cline.Substring(index + 1)));
                break;
        }

    }
    return xdoc;
}

ini适合比较简单的配置读取,文件可读性强,读写也简单;而xml具有多级结构,复杂,还有dtd,xslt什么的,相对来说比较全面。因此,从xml转成ini,要求xml符合ini二级结构,详见
源代码中的IniExtensions类。

xml <-> json

json在前端不要太火,用途广泛,占用空间小,机器也较好识别。但是由于最开始没考虑到json,就先上了xml的船,也懒得去想是不是json作为基础结构更好了,先转换json到xml吧。
json与xml互转:直接用Newtonsoft.Json就可以了。使用SerializeXNodeDeserializeXNode就可以完成转换。

注意,xml与json互转,有一些地方需要小心。

  • xml的属性,转成json会加上前缀“@”
  • xml如果带声明的话,转成json就有前缀“?”
  • xml同级相同名称的元素在json中会构成一个数组
  • xml的某一级只有一个元素时,如果需要转成数组,需要加上json:Array='true'属性

考虑转换都在内部,读取json->xml->保存json。这个流程不需要考虑以上问题。

//json没有根节点是不能直接转成xml的。
private static XDocument DecorateJson(string jsonStr)
{
    return JsonConvert.DeserializeXNode(jsonStr,"G" + Guid.NewGuid().ToString("N"));
}

封装问题

xml要求必须有且只有一个根节点,这一点,ini不满足,json有的不满足,因此需要添加一个默认根节点来处理这个问题。

为了防止配置项目和节点名称冲突,使用Guid.NewGuid()来得到不重复的值,由于xml要求元素名称不能以数字开头,所以人为添加一个“G”前缀,感觉不是很优雅,有办法还请告知~

操作配置文件

不管文件类型是什么,都用代表一个对象代表一个配置文件。由于使用了XDocment,那么使用linq是比较直接的选择。但是考虑到读取配置的时候,一般用户都清楚需要读取的项目,使用查询反而不是很直观。

这里我采用XPathXPath是一门在 XML 文档中查找信息的语言。XPath 可用来在 XML 文档中对元素和属性进行遍历。相关资料可以参见http://www.w3school.com.cn/xpath

XPath的用法很简单,对简单的配置项就和文件路径一样。这里我使用索引器来进行数据读取配置,也提供了GetValue和SetValue方法。

public void Test1()
{
    string str = @";时间单位为ms
[Dynamic]
Interval = 5
Delay = 4000

[Default]
Interval = 5
";
    System.IO.File.WriteAllText("test.ini",str);
    // e.g. "//config/general/interval" 从任意节点开始,检索config节点下general节点下的interval节点
    //     "/config/tick[@type='origin']" 从根节点检索config节点下,属性type='origin'的tick节点(只对XML)
    ConfigManager config = new ConfigManager("test.ini");
    Assert.Equal("5",config[@"//Default/Interval"]);
    Assert.Equal("5",config.GetValue("Default","Interval"));
}

对以上配置,可以直接使用"//Delay"获得Delay的值(没有重名),对层级较深的配置,用户不需要关心其他细节,直切正题,这么用还是很爽快的~

完整代码

完整代码在github上,可以支持.net framework/.net core/xamarin。

https://github.com/circler3/UnifiedConfig

对应有nuget包,搜索nuget或者使用

Install-Package UnifiedConfig

即可将引用添加到项目。

特性

  • 配置文件统一操作接口(读取,修改,保存)
  • 可拓展配置类型支持
  • 自动推断文件类型

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


博文目录文章目录问题描述解决方案问题描述阿里云ECS, 系统切换为 Aliyun Linux 2.1903 LTS 64位 后, SSH可以连接, SFTP无法连接, 端口 22 已添加到阿里云ECS网络安全组表现为 Xshell 可以连接, Xftp 使用 SFTP 协议无法连接, 一片空白, 很长时间也不报错提示, 鼠标挪动的时候显示为圆圈(等待响应)解决方案将 /etc/ssh/sshd_config 中的Subsystem sftp /usr/libexec/opens
博文目录文章目录创建项目创建代码仓库完成工程代码并提交推送到仓库application.propertiespom.xml创建构建计划设置流程配置阶段说明 测试阶段说明 部署定义远程服务器信息远程服务器鉴权创建 SSH 密钥录入凭据在 持续集成 的 构建脚本 中做 SSH 鉴权操作远程服务器设置触发规则设置变量与缓存CODING 持续集成 帮助文档当下 DevOps, CI/CD 等概念非常火, 我自己也想试试, 碰巧知道 CODING.NET 免费提供了这个能力, 所以来尝试一把, 好在最终有
下载CentOS官网CentOS下载CentOS-7-x86_64-DVD-2003.isoCentOS-7-x86_64-DVD-2003.iso安装
博文目录文章目录服务端客户端测试效果服务端配置到 nginx 反向代理FRP Releases使用frp进行内网穿透FRP 示例FRP 实例 通过自定义域名访问内网的 Web 服务FRP 参考 服务端配置FRP Linux Server ReleaseFRP Windows Client Release服务端在 linux 上执行 arch, 结果如果是 [X86_64] 即可选择 [linux amd64] 版本的 Release 包wget https://github.co
博文目录文章目录环境下载安装配置使用环境阿里云ECS(Aliyun Linux 2.1903 LTS 64位)下载https://www.oracle.com/java/technologies/oracle-java-archive-downloads.htmlJava SE 8 (8u202 and earlier) 可以用于商业Java SE 8 (8u211 and later) 不可以用于商业安装tar -zxvf jdk-8u202-linux-x64.tar.gz 得到
博文目录文章目录环境下载安装配置使用环境阿里云ECS(Aliyun Linux 2.1903 LTS 64位)下载https://maven.apache.org/download.cgi安装tar -zxvf apache-maven-3.6.3-bin.tar.gz 得到解压包配置在 /root/.bashrc 文件内添加如下内容export MAVEN_HOME=/mrathena/application/maven-3.6.3export PATH=$JAVA_HOME/
博文目录文章目录嵩山版(2020.08.03)阿里开发手册官网嵩山版(2020.08.03)手册的详细版叫做 码出高效
博文目录文章目录EncodingFontMavenGradleOtherPluginsEncodingsetting 搜索 encodFile | Settings | Editor | File Encodings, 3个 UTF-8File | Settings | Tools | SSH Terminal, 1个 UTF-8Fontsetting 搜索 fontFile | Settings | Editor | FontMavensetting 搜索 mavenFile |
博文目录文章目录环境下载安装配置使用参考环境阿里云ECS(Aliyun Linux 2.1903 LTS 64位)下载http://nginx.org/en/download.htmlhttp://nginx.org/download/nginx-1.18.0.tar.gz选择稳定版(Stable version)下载即可, 分 linux 和 windows 两种, linux 版下载的是源码, 需要自行编译安装tar -zxvf nginx-1.18.0.tar.gz 得到解压包
博文目录文章目录单密钥方式多密钥方式默认生成的 rsa密钥位置在 ~/.ssh, 如 C:Usersmrathena.ssh. 各代码托管平台是可以使用同一个SSH密钥的, 这样最方便, 但是为了更安全也可以配置在不同的平台使用不同的密钥单密钥方式cmd 执行命令 ssh-keygen -t rsa -b 4096 -C "generic", -t type rsa, -b 位数 4096位, 如果不用 -C 指定邮箱, 则会生成一个默认的注释, 该注释无关紧要, 不影响验证选项全部默认(
博文目录文章目录环境下载安装配置使用参考环境阿里云ECS(Aliyun Linux 2.1903 LTS 64位)下载https://github.com/git/git/releaseshttps://codeload.github.com/git/git/tar.gz/v2.28.0, 下载之后可以重命名为 git-2.28.0.tar.gz安装tar -zxvf apache-maven-3.6.3-bin.tar.gz 得到解压包make prefix=/mrathena/a
博文目录文章目录环境下载安装简单配置汉化皮肤JDKMaven简单使用环境阿里云ECS(Aliyun Linux 2.1903 LTS 64位)下载Jenkins 官网, 支持选择中文https://www.jenkins.io/选择 LTS 长期支持版的最新版下载, 这里是 2.235.3 LTS, Generic Java package (.war) 是 java war 包, 可以通过 java -jar jenkins.war 直接运行官网下载 wget http://mir
原因分析 是因为使用了pycharm的版本的问题。并不是flask框架本身的问题(不管你是如何设置的flask配置,通过加载config也好,还是通过run的时候传入形参也好,均不影响) 可以很明显的
背景 兜兜转转以为做测试不用接触这么多编程,结果不仅要接触 py,还要接触 java,还有 elixir,更有 Lua,啊 我绝望了 太久没玩 Java,连导入项目都不会了...特此记录一下侮辱性的时
1. 安装制作工具 mkisofs 2. Linux 操作系统镜像 iso 打包 3. 校验并写入 md5 值
最近在学习 MySQL 的 bin-log 时候考虑到数据备份的问题,突然想到如果能将数据通过 Linux 命令行方式备份到百度网盘,那是一件多么牛逼的事情。百度网盘有免费的 2TB 存储空间,而且有
作为一名开发者,熟悉使用 git 代码管理工具是一项必备的基本技能。git 相较 SVN 而言,其优点不言而喻。git 的功能非常强大,其包括的操作命令也非常的多,但是从实用性而言,很多命令可能我们一
kickstart 能实现 linux 系统的自动化安装,需要设置 ks.cfg 文件,而这个 ks.cfg 文件的生成最好使用 system-config-kickstart 工具生成,比较准确,也
介绍 GitBook是一个基于Node.js的命令行工具,可使用 Github/Git和Markdown来制作精美的电子书,GitBook 并非关 Git的教程。 导出格式有PDF、HTML等,需要添
Tips 总结 1. VSCode显示空格和tab符号 1.打开setting,在搜索框中输入renderControlCharacters,选中勾选框,即可显示tab 2.在搜索框中输入render