zoukankan      html  css  js  c++  java
  • 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 '
    ':
                    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
    

    即可将引用添加到项目。

    特性

    • 配置文件统一操作接口(读取,修改,保存)
    • 可拓展配置类型支持
    • 自动推断文件类型
  • 相关阅读:
    得不到的都能释怀
    个人读后感
    面向对象程序设计
    关于QQ的NABCD模型
    团队成员及分工
    软件工程结对项目--实用计算器的设计和制作
    实践作业2 个人项目作业
    github地址
    github心得体会
    人,绩效和职业道德
  • 原文地址:https://www.cnblogs.com/podolski/p/7214437.html
Copyright © 2011-2022 走看看