在.NET平臺日常開發中，讀取配置檔案是一個很常見的需求。以前都是使用System.Configuration.ConfigurationSettings來操作，這個說實話，搞起來比較費勁。不知道大家有沒有同感。所以更多時候我還是喜歡使用開源的東西，更加方便簡潔，也穩定。省去自己的麻煩。今天就介紹一個非常精緻的.NET平臺開源的操作配置檔案(cfg/ini)的元件SharpConfig。走過路過，千萬不要錯過！上週我在這些.NET開源專案你知道嗎？讓.NET開源來得更加猛烈些吧一文中也介紹過專案。我將會重點對部分開源專案進行深入的研究，形成“.NET平臺開源專案速覽”系列文章，該系列文章沒有時間限制，會一直持續更新下去。

1.SharpConfig簡介

    SharpConfig是.NET平臺一個使用非常簡單的處理Cfg/ini配置檔案的類庫。

    1.支援的配置檔案型別有cfg,ini格式；

    2.支援註釋功能，使用 # 符號開頭；

    3.支援直接讀取和寫入指定節點的值；

    4.支援列舉，陣列，以及和實體的直接對映；

    5.支援記憶體的建立和使用，相對一個配置型別，直接在程式碼中初始化和使用；

2.SharpConfig基本使用

    下面通過一個簡單的Demo來大概知道如何使用。下載後，解壓，新建專案，新增dll引用，需要新增名稱空間:

using SharpConfig;

    我們新增一個如下格式的檔案，檔名稱為：example.ini，這個檔案可以手動建立放在專案中，設定屬性：“始終複製”即可，或者自己手動複製到bin目錄也行。方便呼叫，放在其他路徑也可以，最終都是fileName的路徑來找檔案的。example.ini的內容如下，這個例子也是專案主頁的例子，我稍微修改了下：

[General] #這代表Section，也就是節點

SomeString = Hello SharpConfig!

SomeInteger = 10 #這裡也是註釋

SomeFloat = 20.05

ABoolean = true

    下面使用程式碼直接讀取這個配置檔案的值：

static void Test1()
{
	//按檔名稱載入配置檔案
	Configuration config = Configuration.LoadFromFile("example.ini");
	//按照節的名稱讀取節
	Section section = config["General"];
	//依次根據每個配置項的名稱來讀取，如果配置檔案型別搞錯了，會報錯
	string someString = section["SomeString"].Value;
	var someInteger = section["SomeInteger"].GetValue<Boolean>();
	float someFloat = section["SomeFloat"].GetValue<float>();
	Boolean someBool = section["ABoolean"].GetValue<Boolean>();
	Console.WriteLine("當前節名稱:{0}",section.Name );
	Console.WriteLine("字串SomeString值:{0}", someString);
	Console.WriteLine("整數someInteger值:{0}", someInteger);
	Console.WriteLine("雙精度someFloat值:{0}", someFloat);
	Console.WriteLine("布林值someBool值:{0}", someBool);
}

結果如下：

儲存配置檔案有以下一些方法：

myConfig.Save( "myConfig.cfg" ); // 儲存到cfg格式的文字檔案
myConfig.Save( myStream ); //儲存到文字流中
myConfig.SaveBinary( "myConfig.cfg" ); //儲存到cfg格式的二進位制檔案
myConfig.SaveBinary( myStream ); // 儲存到二進位制檔案

    是不是很簡單，速度也很快。下面看看其他功能的使用。上面只是一個最基本的使用例子。

3.特殊資料型別的配置專案

3.1 列舉型別

    列舉型別的支援其實和上面的值型別差不多，也是直接使用泛型的型別引數類獲取列舉，而陣列是相對特殊一點的，所以單獨拿出來給大家介紹。

    假設有一個Section名稱為DateInfo，專案的Day有一個Monday值，是列舉型別DayOfWeek的一個值。如下面所示：

    [DateInfo]

    Day = Monday

    呼叫的時候，使用一個列舉型別DayOfWeek 來讀取：

DayOfWeek day = config["DateInfo"]["Day"].GetValue<DayOfWeek>();

3.2 陣列型別

    陣列型別的支援，首先是統一轉換為object陣列，然後根據自己的需求要手動轉換，其實可以寫一個擴充套件方法，很簡單，就不展開了。例如下面有一個節的專案是：

    [General]

    MyArray = {0,2,5,6}

    讀取的方法為：

object[] myArray = config["General"]["MyArray"].GetValue<object[]>();

4.動態建立配置檔案與使用

    動態在記憶體中建立配置檔案，其實就是把Configuration當作一個實體類一樣，在程式碼中建立和使用。例如下面的程式碼：

static void Test2()
{
	var myConfig = new Configuration();
	//節點Video
	myConfig["Video"]["Width"].Value = "1920";
	myConfig["Video"]["Height"].Value = "1080";
	//設定陣列
	myConfig["Video"]["Formats"].SetValue(new string[] { "RGB32", "RGBA32" });
	//可以使用迴圈獲取節點以及節點的所有專案，進行操作
	foreach ( var section in myConfig )
	{
		foreach ( var setting in section )
		{
			//TODO:
		}
	}
	//也可以直接使用節點和專案的名稱來訪問：
	Console.WriteLine("Width:{0}", myConfig["Video"]["Width"].GetValue<Int32>());
	Console.WriteLine("Height:{0}", myConfig["Video"]["Height"].GetValue<Int32>());
}

　　結果如下：

5.更簡單的應用-物件對映

　　在文章發表之前，我在“這些.NET開源專案你知道嗎？讓.NET開源來得更加猛烈些吧”一文中已經提到該專案，網友回覆如果字串中包括了#字元，可能會被認為是註釋的事情，這個的確是一個隱藏bug，不過應該很少會碰到，這個解決方案自己繞過彎吧，真的有，就在程式或者使用實體類對映的時候，單獨處理一下。

    這種情況在以前使用XCode元件時用的比較多。不過SharpConfig也支援，挺好用的。相當於把實體類的欄位和配置檔案對應起來，可以更加方便使用。型別和配置檔案對映後，可以直接操作物件了。不需要上面那些步驟。假設有一個Person物件，如下格式：

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public Gender Gender { get; set; }
}

Gender是一個性別的列舉型別，如下所示：

enum Gender
{
    Male,
    Female
}

假設配置檔案是這樣儲存的：

[Person]

Name = Peter

Age = 50

Gender = Male

    在實際使用的時候，使用下面的程式碼即可：

static void Test3()
{
	Configuration config = Configuration.LoadFromFile("example.ini");
	Person person = config["Person"].CreateObject<Person>();
	Console.WriteLine("Name:{0}",person.Name);
	Console.WriteLine("Age:{0}", person.Age);
	Console.WriteLine("Gender:{0}", person.Gender);
}

結果如下：

   當然也可以將config["Person"]節直接對映對一個已經存在的物件，會直接覆蓋原來的值。如下面程式碼：

config["Person"].MapTo(person);　　

6.資源

    我在這裡提供一個下載，以及我使用的案例Demo例子。官方提供了一個Winform的圖形介面，非常直觀，這裡截圖看看，如果大家要用，從我這裡下載也可以。

    Winform顯示配置檔案的圖形介面