.NET平臺開源專案速覽今天介紹一款小巧強大的物件比較元件。可以更詳細的獲取2個物件的差別，並記錄具體差別，比較過程和要求可以靈活配置。

1.Compare .NET Objects介紹

    Compare .NET Objects元件是.NET平臺用於深入比較2個.NET物件的開源元件，一直在更新，主要功能如名字所示就是深入比較2個.NET物件，是否相等或者是否有差異。可能很多.NET物件實現了一些.NET自帶的介面可以直接進行比較，但是這個元件比較的範圍和功能更加廣泛。例如：

    可以比較預設的子節點；可以比較結構體；

    可以比較IList物件；可以比較單維或者多維的陣列物件；

    可以比較列舉型別；可以比較IDictionary物件；

    可以比較資料集，資料表，字典等等；

    可以比較私有欄位或者屬性等等。。。。。。。。

    Compare .NET Objects支援.NET 3.5及更高版本，同時也支援 Silverlight 5+, Windows Phone 8+, Windows RT 8+, Xamarin iOS, and Xamarin Android等環境。

    還有很多，不一一列舉，可以去官網詳細瞭解。我們重點放在它的基本使用上面，本文就用幾個例子帶你走近它的世界。雖然簡單，但更多複雜的功能可能會用於不同的業務場景，也許是你要的哦。。。該元件唯一的缺點是案例和文件不全面，所以我研究了一下用法，把常規的一些用法程式碼敲出來，給大家分享一下吧。

2. Compare .NET Objects注意事項

    在更好的使用Compare .NET Objects之前，需要搞清楚以下幾個注意事項，可以讓你走不少彎路，這幾個要點也是翻譯的官方網站的內容：

1.考慮到效能因素，Compare .NET Objects預設僅僅是檢測第一個差異(就可以確認不是同一個物件)，如果要比較多個不同點，需要手動設定Config.MaxDifferences到你需要的不同點數量的最大值;

2.在比較完成之後，物件差異不同點在Differences 列表 或者從DifferencesString 屬性中獲取;

3.預設情況下，是進行深度比較，如果只需呀執行淺比較，需要手動設定CompareChildren =false;

4.預設情況下，私有屬性和私有欄位是不比較的，如果需要進行比較，在比較之前要設定Config.ComparePrivateProperties 和Config.ComparePrivateFields 為true;

5.預設情況下，如果比較的2個物件的型別不同，是會丟擲異常的，如果需要忽略這個因素，需要設定Config.IgnoreObjectTypes=true;

    可見該元件的功能不僅完善，而且相對靈活，把你想要的和不想要的都靈活進行了考慮，通過設定不同的開關進行比較。

3.一個簡單的使用案例

    為了使得下面的原始碼介紹更清晰，先看一個簡單使用的Demo，理解完Demo後，我們再反過來深入的介紹比較過程中的三大核心物件。理解了這三大核心物件，整個元件的邏輯和使用也基本清楚了。

3.1 首先定義一個Person型別

    為了簡單的比較，我們定義1個Person型別，包括名稱，年齡和建立日期3個屬性。如下面程式碼:

public class Person
{
	public String Name { get; set; }
	public Int32 Age { get; set; }
	public DateTime DateCreated { get; set; }
}

3.2 比較測試Demo

    首先要引用Compare-NET-Objects的dll，新增之後，要在Demo中新增名稱空間的引用：

using KellermanSoftware.CompareNetObjects;

    接下來就看核心的使用過程，看程式碼註釋：

//建立比較物件的型別
CompareLogic compareLogic = new CompareLogic();

//建立2個不同的Person型別
Person person1 = new Person();
person1.DateCreated = DateTime.Now;
person1.Name = "Jorn";
person1.Age = 25;

Person person2 = new Person();
person2.Name = "Greg";
person2.DateCreated = DateTime.Now;
person2.Age = 22;

//設定比較物件的配置檔案，最大不同點為3
compareLogic.Config.MaxDifferences = 3;            

//獲取比較結果，使用Compare方法
ComparisonResult result = compareLogic.Compare(person1, person2);

//如果不相等，輸出不同資訊字串
if (!result.AreEqual)
	Console.WriteLine(result.DifferencesString);

    如上面案例所示，整個過程有3個核心的相關物件和要點：

1. CompareLogic物件的初始化；

2. CompareLogic的配置設定的使用；實際上是ComparisonConfig類的設定

3. 直接獲取結果，並輸出不同資訊，實際是ComparisonResult的使用。

   上面只是一個簡單的案例，要想深入瞭解使用，還得看看這3個主要物件的作用。

4.三大核心物件介紹

    根據第3節的例子和過程，本節介紹3個核心型別的結構，在使用前搞懂他們的結構，可以更快的使用。由於本元件暫時沒有提供幫助文件，所以我將這3個核心類的註釋進行了翻譯，並根據文章的註釋手動製作一份CHM格式的幫助文件。

4.1 CompareLogic比較邏輯類

    CompareLogic就是比較物件主要物件。它只包括2個核心的東西：

1. 就是配置屬性Config，這是個進行比較前最重要的設定，同時在CompareLogic初始化時，也可以使用ComparisonConfig傳遞引數進行初始化，這樣就可以更簡單，在某些情況下，不需要重複設定。採用統一的配置就可以了。如下面是的部分原始碼：

   public class CompareLogic : ICompareLogic
   {
   	/// <summary>預設的比較設定檔案</summary>
   	public ComparisonConfig Config { get; set; }
   
   	/// <summary>預設建構函式</summary>
   	public CompareLogic()
   	{
   		Config = new ComparisonConfig();
   	}
   
   	/// <summary>使用外部的比較設定物件來進行初始化</summary>
   	/// <param name="config">外部設定物件</param>
   	public CompareLogic(ComparisonConfig config)
   	{
   		Config = config;
   	}
   	..........
   }

2. 比較方法。返回一個ComparisonResult物件，這裡設計到核心的比較方法的過程，就不追究了。

   所以上述Config屬性我們在執行比較方法前，需要根據自己的需求進行設定，比如設定最大的不同數目等等。。比較方法很簡單，核心在與返回的型別，接下來繼續看。

4.2 ComparisonConfig比較配置類

    比較配置類，在CompareLogic是作為一個屬性，可以在程式中比較前進行設定的。其核心方法就是配置專案，例如，我將其核心程式碼貼出來，看一下，就一目瞭然了，這個元件要實現的不同條件下進行比較的效果和功能，就是靠這個配置來進行的。

/// <summary>
/// 時間日期型別不同(間隔)的最大毫秒數,預設為0：
/// 意思就是比較2個時間物件，差別在這個值以下，就認為是相同的，類似Double處理相等時的精度
/// </summary>
public int MaxMillisecondsDateDifference { get; set; }

/// <summary>結構體比較的最大深度(比較子節點)，預設為2</summary>
public int MaxStructDepth { get; set; }

/// <summary>如果為true,遇到未知的物件型別時，將忽略，而不是直接丟擲異常,預設為false，也就是丟擲異常</summary>
public bool IgnoreUnknownObjectTypes { get; set; }

/// <summary>如果為true,將跳過無效的索引。預設為false</summary>
public bool SkipInvalidIndexers { get; set; }

/// <summary>在每個階段比較後都顯示記錄，預設為false.這在除錯很具有很深子節點的物件時非常有用</summary>
public bool ShowBreadcrumb { get; set; }

/// <summary>比較中需要忽略的型別列表.預設比較多有的型別</summary>
public List<Type> ClassTypesToIgnore { get; set; }

/// <summary>只需要比較的型別列表。預設是比較多有型別，如果設定這個列表，那將只比較這個列表中的型別</summary>
public List<Type> ClassTypesToInclude { get; set; }

/// <summary>比較期間需要忽略的資料表名稱，或者表列名稱，屬性，或者欄位。對大小寫敏感</summary>
/// <example>MembersToIgnore.Add("CreditCardNumber")</example>
public List<string> MembersToIgnore { get; set; }

/// <summary>只比較列表中的名稱，如資料表，列名稱，屬性或者欄位，大小寫敏感。和上面的型別處理類似。</summary>
/// <example>MembersToInclude.Add("FirstName")</example>
public List<string> MembersToInclude { get; set; }
...................

    其他還有很多，詳細看我提供的原始碼。我對幾個核心類進行了翻譯，可以更快的進行使用和理解。

4.3 ComparisonResult比較結果類

    比較結果也很重要，如果只是想簡單的返回相等和不相等其實太容易了，這也是這個功能元件不一樣的地方。它將結果和不同點都進行了考慮，可以在比較完成後查詢到不同點這個物件，或者直接 的字串，並將不同點的值也表現出來。使用它，主要注意3個 屬性：

/// <summary>比較發現的不同點</summary>
public List<Difference> Differences { get; set; }
/// <summary>比較不同點，以字串描述</summary>
public string DifferencesString{get ;}
/// <summary>如果相同則返回true</summary>
public bool AreEqual{get ;}

    這在Demo程式碼中也有用到。除錯的時候，大家看一看，如下圖所示：

今天的內容就介紹到此。

5.資源

　　我文中的演示Demo及專案的翻譯部分，這裡也提供一個下載，日期是在2015-5-22下載的基礎上修改的。

　　我手動製作了一個部分翻譯後的元件幫助文件，如下圖：