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 環境!