.NET下編寫程序的時候經(jīng)常會使用到配置文件。配置文件格式通常有xml、ini、json等幾種，操作不同類型配置文件需要使用不同的方法，操作較為麻煩。特別是針對同時應(yīng)用不同格式配置文件的時候，很容易引起混淆。如果使用一個統(tǒng)一的方法對其進(jìn)行操作，豈不美哉。

技術(shù)方案

思路很簡單，就是使用一個基類將配置文件的內(nèi)容抽象出來，不同配置文件有不同的實(shí)現(xiàn)，對外統(tǒng)一調(diào)用方法。最開始，打算自己寫一個，后來對比ini與xml的時候（最開始沒有把json考慮進(jìn)來，自己用它來做配置文件的項(xiàng)目較少），發(fā)現(xiàn)xml完全可以替代ini文件的描述，直接用xml不是更好？

于是方案就變成了用xml作為最基礎(chǔ)的數(shù)據(jù)對象，其他配置文件轉(zhuǎn)換成xml進(jìn)行操作。

XDocument VS XmlDocment

不解釋，直接看圖。

大數(shù)據(jù)培訓(xùn),云培訓(xùn),數(shù)據(jù)挖掘培訓(xùn),云計(jì)算培訓(xùn),高端軟件開發(fā)培訓(xùn),項(xiàng)目經(jīng)理培訓(xùn)

ini <-> xml

ini文件構(gòu)造比較簡單，常見的ini有以下幾條規(guī)范：

  1. 注釋以;開頭，一直到行尾；

  2. 類別項(xiàng)用[]包圍，占據(jù)一整行；

  3. 類別項(xiàng)下可以有多個配置項(xiàng)，直到下一個類別項(xiàng)或EOF結(jié)束；

  4. 配置項(xiàng)格式：key=value

ini格式是二級配置結(jié)構(gòu)：類別>key。通過類別和key就可以唯一獲得一個值。

public static XDocument ToXml(this string[] iniStr){    //ini沒有根節(jié)點(diǎn)是不能直接轉(zhuǎn)成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適合比較簡單的配置讀取，文件可讀性強(qiáng)，讀寫也簡單；而xml具有多級結(jié)構(gòu)，復(fù)雜，還有dtd，xslt什么的，相對來說比較全面。

xml <-> json

json在前端不要太火，用途廣泛，占用空間小，機(jī)器也較好識別。但是由于最開始沒考慮到j(luò)son，就先上了xml的船，也懶得去想是不是json作為基礎(chǔ)結(jié)構(gòu)更好了，先轉(zhuǎn)換json到xml吧。
json與xml互轉(zhuǎn)：直接用Newtonsoft.Json就可以了。使用SerializeXNode和DeserializeXNode就可以完成轉(zhuǎn)換。

注意，xml與json互轉(zhuǎn)，有一些地方需要小心。

  • xml的屬性，轉(zhuǎn)成json會加上前綴“@”

  • xml如果帶聲明的話，轉(zhuǎn)成json就有前綴“?”

  • xml同級相同名稱的元素在json中會構(gòu)成一個數(shù)組

  • xml的某一級只有一個元素時，如果需要轉(zhuǎn)成數(shù)組，需要加上json:Array='true'屬性

考慮轉(zhuǎn)換都在內(nèi)部，讀取json->xml->保存json。這個流程不需要考慮以上問題。

//json沒有根節(jié)點(diǎn)是不能直接轉(zhuǎn)成xml的。private static XDocument DecorateJson(string jsonStr){    return JsonConvert.DeserializeXNode(jsonStr, "G" + Guid.NewGuid().ToString("N"));
}

封裝問題

xml要求必須有且只有一個根節(jié)點(diǎn)，這一點(diǎn)，ini不滿足，json有的不滿足，因此需要添加一個默認(rèn)根節(jié)點(diǎn)來處理這個問題。

為了防止配置項(xiàng)目和節(jié)點(diǎn)名稱沖突，使用Guid.NewGuid()來得到不重復(fù)的值，由于xml要求元素名稱不能以數(shù)字開頭，所以人為添加一個“G”前綴，感覺不是很優(yōu)雅，有辦法還請告知~

操作配置文件

不管文件類型是什么，都用代表一個對象代表一個配置文件。由于使用了XDocment，那么使用linq是比較直接的選擇。但是考慮到讀取配置的時候，一般用戶都清楚需要讀取的項(xiàng)目，使用查詢反而不是很直觀。

這里我采用XPath。XPath是一門在 XML 文檔中查找信息的語言。XPath 可用來在 XML 文檔中對元素和屬性進(jìn)行遍歷。相關(guān)資料可以參見http://www.w3school.com.cn/xpath。

XPath的用法很簡單，對簡單的配置項(xiàng)就和文件路徑一樣。這里我使用索引器來進(jìn)行數(shù)據(jù)讀取配置，也提供了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" 從任意節(jié)點(diǎn)開始，檢索config節(jié)點(diǎn)下general節(jié)點(diǎn)下的interval節(jié)點(diǎn)
    //     "/config/tick[@type='origin']" 從根節(jié)點(diǎn)檢索config節(jié)點(diǎn)下，屬性type='origin'的tick節(jié)點(diǎn)(只對XML)
    ConfigManager config = new ConfigManager("test.ini");
    Assert.Equal("5", config[@"//Default/Interval"]);
    Assert.Equal("5", config.GetValue("Default", "Interval"));
}

完整代碼

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

https://github.com/circler3/UnifiedConfig

對應(yīng)有nuget包，搜索nuget或者使用

Install-Package UnifiedConfig

即可將引用添加到項(xiàng)目。

大數(shù)據(jù)培訓(xùn),云培訓(xùn),數(shù)據(jù)挖掘培訓(xùn),云計(jì)算培訓(xùn),高端軟件開發(fā)培訓(xùn),項(xiàng)目經(jīng)理培訓(xùn)
除非特殊說明，本作品由podolski創(chuàng)作，采用知識共享署名 4.0 國際許可協(xié)議進(jìn)行許可。歡迎轉(zhuǎn)載，轉(zhuǎn)載請保留原文鏈接~

分類: Tools

http://www.cnblogs.com/podolski/p/7214437.html