C#使用Objects Comparer進行物件比較

介紹

Objects Comparer 是用於物件比較的工具，C# 常見的資料結構都可以用這個第三方程式庫進行比對，比較複雜的物件也可以比較。

簡而言之，Objects Comparer 是一個物件對物件的比較器，它允許逐個成員遞迴地比較物件，並為某些屬性、欄位或類型定義自訂比較規則。

安裝

nuget 搜尋 ObjectsComparer：

使用

首先我們定義一個簡單類別：

public class UserInfomation
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Sex { get; set; }
}

實例化兩個 UserInfomation 物件並賦予不同的值，再實例化 ObjectsComparer.Comparer 比較器：

var comparer1 = new ObjectsComparer.Comparer<UserInfomation>();

然後我們將實例化的兩個物件傳入到 ObjectsComparer.Comparer 方法中：

IEnumerable<Difference> differences1;
var isEqual1 = comparer1.Compare(userInfomationOld, userInfomationNew, out differences1);

透過回傳值判斷物件是否一致，如果不一致可以透過 differences1 取得不一致的值。

查看輸出，可以知道實例化的兩個物件是 age 屬性的值不一樣：

那我們再試試 List<T> 類型的：

List<UserInfomation> lstUserInfomationsOld=new List<UserInfomation>();
for (int i = 0; i < 3; i++)
{
    UserInfomation user=new UserInfomation();
    user.Name = "張三";
    user.Age = 30;
    user.Sex = "男";
    lstUserInfomationsOld.Add(user);
}
List<UserInfomation> lstUserInfomationsNew = new List<UserInfomation>();
for (int i = 0; i < 2; i++)
{
    UserInfomation user = new UserInfomation();
    user.Name = "李四";
    user.Age = 30;
    user.Sex = "男";
    lstUserInfomationsNew.Add(user);
}


var comparer = new ObjectsComparer.Comparer<List<UserInfomation>>();
IEnumerable<Difference> differences;
var isEqual = comparer.Compare(lstUserInfomationsNew, lstUserInfomationsOld, out differences);
string differencesMsg = string.Join(Environment.NewLine, differences);
Console.WriteLine(differencesMsg);

查看輸出可以看出是數量不一致的問題：

應用場景

像做過 .NET 客戶端開發的人都知道，我們在維護一些基礎資料的時候都避免不了要編輯資料！

有的時候我們打開編輯頁面，實際未修改資料，再去點擊儲存按鈕，要不一個一個欄位去比對有沒有修改資料，要不就直接暴力處理，不驗證有沒有修改資料，直接呼叫 update 介面。

那麼我們的 Objects Comparer 就派上用場了，我們首先封裝一個 BaseForm，然後在基底類別控制項中封裝一個比較方法：

protected Result ComPare<T>(T t, T s)
{
    Result result =new Result();
    var comparer = new ObjectsComparer.Comparer<T>();
    IEnumerable<Difference> differences;
    bool isEqual = comparer.Compare(t, s, out differences);
    result.IsEqual = isEqual;
    if (!isEqual)
    {
        string differencesMsg = string.Join(Environment.NewLine, differences);
        result.Msg=differencesMsg;
    }
    return result;
}

public class Result
{
    public bool IsEqual { get; set; }
    public string Msg { get; set; }
}

我們在打開編輯頁面的時候會載入當前頁面的資料，這時候我們可以取得未編輯之前的資料將它設為全域變數，然後儲存的時候我們可以取得編輯之後的物件，這時候我們再去呼叫基底類別的比較方法。

取得兩個物件之間的值是否有改變，如果沒有改變，我們就給出「資料未修改，請問是否關閉表單」等提示：

public partial class MainFrm : BaseForm
{
    Test _testOld;
    public MainFrm()
    {
        InitializeComponent();
        _testOld = LoadData();
        txtName.Text= _testOld.Name;
        txtAge.Text = _testOld.Age.ToString();
        txtSex.Text = _testOld.Sex;
    }
    private Test LoadData()
    {
        Test test = new Test();
        test.Name = "張三";
        test.Age = 30;
        test.Sex = "男";
        return test;


    }


    private void uiButton1_Click(object sender, EventArgs e)
    {
        Test test=new Test();
        test.Name =txtName.Text;
        test.Age =int.Parse( txtAge.Text);
        test.Sex=txtSex.Text;
            Result result=  ComPare(_testOld, test);
        if (result.IsEqual)
        {
            MessageBox.Show("資料未修改");
            return;
        }
        //然後再寫儲存邏輯
        MessageBox.Show("儲存成功");
    }
}
public class Test
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Sex { get; set; }
}

當然還有很多應用場景，我只是分享我常使用的場景罷了。

最後希望各位 neter 分享更多有用的工具，共同改善 .NET 環境！