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


技术方案

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

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

XDocument VS XmlDocment

不解释,直接看图。

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

即可将引用添加到项目。

特性

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

c#通用配置文件读写类与格式转换(xml,ini,json)的更多相关文章

  1. c#通用配置文件读写类(xml,ini,json)

    .NET下编写程序的时候经常会使用到配置文件.配置文件格式通常有xml.ini.json等几种,操作不同类型配置文件需要使用不同的方法,操作较为麻烦.特别是针对同时应用不同格式配置文件的时候,很容易引 ...

  2. xStream完美转换XML、JSON

    xStream框架 xStream可以轻易的将Java对象和xml文档相互转换,而且可以修改某个特定的属性和节点名称,而且也支持json的转换: 前面有介绍过json-lib这个框架,在线博文:htt ...

  3. 常用两种数据交换格式之XML和JSON的比较

    目前,在web开发领域,主要的数据交换格式有XML和JSON,对于XML相信每一个web developer都不会感到陌生: 相比之下,JSON可能对于一些新步入开发领域的新手会感到有些陌生,也可能你 ...

  4. .net core将URL请求格式化为XML或JSON(网站动态生成sitemap.xml)

    .net core将URL请求格式化为XML或JSON(网站动态生成sitemap.xml) 首先设置 Startup.cs 文件 配置 ConfigureServices services .Add ...

  5. xStream完美转换XML、JSON(转)

    xStream框架 xStream可以轻易的将Java对象和xml文档相互转换,而且可以修改某个特定的属性和节点名称,而且也支持json的转换: 前面有介绍过json-lib这个框架,在线博文:htt ...

  6. 两种常用的数据交换格式:XML和JSON

    不同编程语言之间的数据传输,需要一种通用的数据交换格式,它需要简洁.易于数据储存.快速读取,且独立于各种编程语言.我们往往传输的是文本文件,比如我们都知道的csv(comma seperated va ...

  7. C# INI配置文件读写类

    ini是一种很古老的配置文件,C#操作ini文件借助windows底层ini操作函数,使用起来很方便: public class IniHelper { [DllImport("kernel ...

  8. C# XML配置文件读写类(用于程序配置保存)

    调用方式 //初始化并指定文件路径 XmlConfigUtil util = new XmlConfigUtil("C:\\1.xml"); //写入要保存的值以及路径(Syste ...

  9. C++[类设计] ini配置文件读写类config

      //in Config.h #pragma once #include <windows.h> #include <shlwapi.h> #pragma comment(l ...

随机推荐

  1. Linux RCU 机制详解

    1.简介: RCU(Read-Copy Update)是数据同步的一种方式,在当前的Linux内核中发挥着重要的作用. RCU主要针对的数据对象是链表,目的是提高遍历读取数据的效率,为了达到目的使用R ...

  2. 深度学习word embedding猜测性别初探

    根据用户的一些特征数据,如果能推测出用户的性别借此提高产品的服务质量.广告的精准性等都是极好的. 机器学习方法有很多,而且一般都可以达到不错的效果,比如svm或神经网络等. 本文使用的代码参考——&l ...

  3. 3.3Python数据处理篇之Numpy系列(三)---数组的索引与切片

    目录 (一)数组的索引与切片 1.说明: 2.实例: (二)多维数组的索引与切片 1.说明: 2.实例: 目录: 1.一维数组的索引与切片 2.多维数组的索引与切片 (一)数组的索引与切片 1.说明: ...

  4. January 17th, 2018 Week 03rd Wednesday

    Don't let go too soon, but don't hold on too long. 不要太快放手,也别紧握太久. It is inevitalbe to encounter with ...

  5. Pair Programming 2

    学生-社团匹配程序 项目流程: 1. 分析讨论 2. 分工合作 3. 代码规范 4. 编码实现 5. 模块结合 6. 测试修改 7. 数据样例 8. 心得体会 9. GitHub链接 结对队友:陈文举 ...

  6. 浅析JAVA中堆内存与栈内存的区别

    Java把内存划分成两种:一种是栈内存,一种是堆内存. 一.栈内存 存放基本类型的变量,对象的引用和方法调用,遵循先入后出的原则.     栈内存在函数中定义的“一些基本类型的变量和对象的引用变量”都 ...

  7. java死锁详解

    进程死锁及解决办法: 一:死锁的概念:    死锁是进程死锁的简称    什么是死锁:    死锁是指多个进程循环等待他方占有的资源而无限的僵持下去的局面.很显然,没有外力作用,那么死锁涉及到的各个进 ...

  8. MySQL InnoDB Update和Crash Recovery流程

    MySQL InnoDB Update和Crash Recovery流程 概要信息 首先介绍了Redo,Undo,Log Sequence Number (LSN),Checkpoint,Rollba ...

  9. 难点--均方误差(MSE)和均方根误差(RMSE)和平均绝对误差(MAE)

    MSE: Mean Squared Error 均方误差是指参数估计值与参数真值之差平方的期望值; MSE可以评价数据的变化程度,MSE的值越小,说明预测模型描述实验数据具有更好的精确度. MSE=1 ...

  10. Android之activity总结

    http://www.cnblogs.com/lyp3314/archive/2011/11/10/2244971.html 一.什么是activity Activity 是用户接口程序,原则上它会提 ...