如何獲取 C# 類中發生資料變化的屬性資訊

前言

在平時的開發中，當使用者修改資料時，一直沒有很好的辦法來記錄具體修改了那些資訊，只能暫時採用將類序列化成 json 字串，然後全塞入到日誌中的方式，此時如果我們想要知道使用者具體改變了哪幾個欄位的值的話就很困難了。因此，趁著這個假期，就來解決這個一直遺留的小問題，本篇文章記錄了我目前實現的方法，如果你有不同於文中所列出的方案的話，歡迎指出。

程式碼倉儲地址：github.com/Lanesra712/…

Step by Step

需求場景

一個經常遇到的使用場景，使用者 A 修改了某個表單頁面上的資料資訊，然後提交到我們的服務端完成資料的更新，對於具有某些許可權的使用者來說，則是期望可以看到所有使用者對於該表單進行操作前後的資料變更。

解決方法

既然想要得知使用者操作前後的資料差異，我們肯定需要去對使用者操作前後的資料進行比對，這裡就落到我們承接資料的類身上。

在我們定義類中的屬性時，更多的是使用自動屬性的方式來完成屬性的 getter、setter 宣告，而完整的屬性宣告方式則需要我們定義一個欄位用來承接對於該屬性的變更。

// 自動屬性宣告
public class Entity1
{
    public Guid Id { get; set; }
}

// 完整的屬性宣告
public class Entity2
{
    private Guid _id;

    public Guid Id
    {
        get => _id;
        set => _id = value;
    }
}
複製程式碼

因為在給屬性進行賦值的時候，需要呼叫屬性的 set 構造器，因此，在 set 構造器內部我們是不是就可以直接對新賦的值進行判斷，從而記錄下屬性的變更過程，改造後的類屬性宣告程式碼如下。

public class Sample
{
    private string _a;

    public string A
    {
        get => _a;
        set
        {
            if (_a == value)
                return;

            string old = _a;
            _a = value;
            propertyChangelogs.Add(new PropertyChangelog<Sample>(nameof(A), old, _a));
        }
    }

    private double _b;

    public double B
    {
        get => _b;
        set
        {
            if (_b == value)
                return;

            double old = _b;
            _b = value;
            propertyChangelogs.Add(new PropertyChangelog<Sample>(nameof(B), old.ToString(), _b.ToString()));
        }
    }

    private IList<PropertyChangelog<Sample>> propertyChangelogs = new List<PropertyChangelog<Sample>>();

    public IEnumerable<PropertyChangelog<Sample>> Changelogs() => propertyChangelogs;
}
複製程式碼

在改造後的類屬性宣告中，我們在屬性的 set 構造器中將新賦的值與原先的值進行判斷，當存在兩次值不一樣時，就寫入到變更記錄的集合中，從而實現記錄資料變更的目的。這裡對於變更記錄的實體類屬性定義如下所示。

public class PropertyChangelog<T>
{
    /// <summary>
    /// ctor
    /// </summary>
    public PropertyChangelog()
    { }

    /// <summary>
    /// ctor
    /// </summary>
    /// <param name="propertyName">屬性名稱</param>
    /// <param name="oldValue">舊值</param>
    /// <param name="newValue">新值</param>
    public PropertyChangelog(string propertyName, string oldValue, string newValue)
    {
        PropertyName = propertyName;
        OldValue = oldValue;
        NewValue = newValue;
    }

    /// <summary>
    /// ctor
    /// </summary>
    /// <param name="className">類名</param>
    /// <param name="propertyName">屬性名稱</param>
    /// <param name="oldValue">舊值</param>
    /// <param name="newValue">新值</param>
    /// <param name="changedTime">修改時間</param>
    public PropertyChangelog(string className, string propertyName, string oldValue, string newValue, DateTime changedTime)
        : this(propertyName, oldValue, newValue)
	{
		ClassName = className;
		ChangedTime = changedTime;
	}

    /// <summary>
    /// 類名稱
    /// </summary>
    public string ClassName { get; set; } = typeof(T).FullName;

    /// <summary>
    /// 屬性名稱
    /// </summary>
    public string PropertyName { get; set; }

    /// <summary>
    /// 舊值
    /// </summary>
    public string OldValue { get; set; }

    /// <summary>
    /// 新值
    /// </summary>
    public string NewValue { get; set; }

    /// <summary>
    /// 修改時間
    /// </summary>
    public DateTime ChangedTime { get; set; } = DateTime.Now;
}
複製程式碼

可以看到，在我們對 Sample 類進行初始化賦值時，記錄了兩次關於類屬性的資料變更記錄，而當我們進行重新賦值時，只有屬性 A 發生了資料改變，因此只記錄了屬性 A 的資料變更記錄。

雖然這裡已經達到我們的目的，但是如果採用這種方式的話，相當於原先專案中需要實現資料記錄功能的類的屬性宣告方式全部需要重寫，同時，基於 C# 本身已經提供了自動屬性的方式來簡化屬性宣告，結果現在我們又回到了傳統屬性的宣告方式，似乎顯得有些不太聰明的樣子。因此，既然通過一個個屬性進行比較的方式過於繁瑣，這裡我們通過反射的方式直接對比修改前後的兩個實體類，批量獲取發生資料變更的屬性資訊。

我們最終想要實現的是使用者可以看到關於某個表單的欄位屬性資料變化的過程，而我們定義在 C# 類中的屬性有時候需要與實際頁面上顯示的欄位名稱進行對映，以及某些屬性其實沒有必要記錄資料變化的情況，這裡我通過新增自定義特性的方式，完善功能的實現。

/// <summary>
/// 為指定的屬性設定資料變更記錄
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public class PropertyChangeTrackingAttribute : Attribute
{
    /// <summary>
    /// 指定 PropertyChangeTrackingAttribute 屬性的預設值
    /// </summary>
    public static readonly PropertyChangeTrackingAttribute Default = new PropertyChangeTrackingAttribute();

    /// <summary>
    /// 構造一個新的 PropertyChangeTrackingAttribute 特性例項
    /// </summary>
    public PropertyChangeTrackingAttribute()
    { }

    /// <summary>
    /// 構造一個新的 PropertyChangeTrackingAttribute 特性例項
    /// </summary>
    /// <param name="ignore">是否忽略該欄位的資料變化</param>
    public PropertyChangeTrackingAttribute(bool ignore = false)
    {
        IgnoreValue = ignore;
    }

    /// <summary>
    /// 構造一個新的 PropertyChangeTrackingAttribute 特性例項
    /// </summary>
    /// <param name="displayName">屬性對應頁面顯示名稱</param>
    public PropertyChangeTrackingAttribute(string displayName)
        : this(false)
        {
            DisplayNameValue = displayName;
        }

    /// <summary>
    /// 構造一個新的 PropertyChangeTrackingAttribute 特性例項
    /// </summary>
    /// <param name="displayName">屬性對應頁面顯示名稱</param>
    /// <param name="ignore">是否忽略該欄位的資料變化</param>
    public PropertyChangeTrackingAttribute(string displayName, bool ignore)
        : this(ignore)
        {
            DisplayNameValue = displayName;
        }

    /// <summary>
    /// 獲取特性中的屬性對應頁面上顯示名稱引數資訊
    /// </summary>
    public virtual string DisplayName => DisplayNameValue;

    /// <summary>
    /// 獲取特性中的是否忽略該欄位的資料變化引數資訊
    /// </summary>
    public virtual bool Ignore => IgnoreValue;

    /// <summary>
    /// 修改屬性對應頁面顯示名稱引數值
    /// </summary>
    protected string DisplayNameValue { get; set; }

    /// <summary>
    /// 修改是否忽略該欄位的資料變化
    /// </summary>
    protected bool IgnoreValue { get; set; }
}
複製程式碼

考慮到我們的類中可能會包含很多的屬性資訊，如果一個個的給屬性新增特性會很麻煩，因此這裡可以直接針對類新增該特性。同時，針對我們可能會排除類中的某些屬性，或者設定屬性在頁面中顯示的名稱，這裡我們可以針對特定的類屬性進行單獨新增特性。

完成了自定義特性之後，考慮到我們後續使用的方便，這裡我採用建立擴充套件方法的形式來宣告我們的函式方法，同時我在 PropertyChangelog 類中新增了 DisplayName 屬性用來存放屬性對應於頁面上存放的名稱，最終完成後的程式碼如下所示。

/// <summary>
/// 獲取類屬性資料變化記錄
/// </summary>
/// <typeparam name="T">監聽的類型別</typeparam>
/// <param name="oldObj">包含原始值的類</param>
/// <param name="newObj">變更屬性值後的類</param>
/// <param name="propertyName">指定的屬性名稱</param>
/// <returns></returns>
public static IEnumerable<PropertyChangelog<T>> GetPropertyLogs<T>(this T oldObj, T newObj, string propertyName = null)
{
    IList<PropertyChangelog<T>> changelogs = new List<PropertyChangelog<T>>();

    // 1、獲取需要新增資料變更記錄的屬性資訊
    //
    IList<PropertyInfo> properties = new List<PropertyInfo>();

    // PropertyChangeTracking 特性的型別
    var attributeType = typeof(PropertyChangeTrackingAttribute);

    // 對應的類中包含的屬性資訊
    var classProperties = typeof(T).GetProperties();

    // 獲取類中需要新增變更記錄的屬性資訊
    //
    bool flag = Attribute.IsDefined(typeof(T), attributeType);

    foreach (var i in classProperties)
    {
        // 獲取當前屬性新增的特性資訊
        var attributeInfo = (PropertyChangeTrackingAttribute)i.GetCustomAttribute(attributeType);

        // 類未新增特性，並且該屬性也未新增特性
        if (!flag && attributeInfo == null)
            continue;

        // 類新增特性，該屬性未新增特性
        if (flag && attributeInfo == null)
            properties.Add(i);

        // 不管類有沒有新增特性，只要類中的屬性新增特性，並且 Ignore 為 false
        if (attributeInfo != null && !attributeInfo.Ignore)
            properties.Add(i);
    }

    // 2、判斷指定的屬性資料是否發生變更
    //
    foreach (var property in properties)
    {
        var oldValue = property.GetValue(oldObj) ?? "";
        var newValue = property.GetValue(newObj) ?? "";

        if (oldValue.Equals(newValue))
            continue;

        // 獲取當前屬性在頁面上顯示的名稱
        //
        var attributeInfo = (PropertyChangeTrackingAttribute)property.GetCustomAttribute(attributeType);
        string displayName = attributeInfo == null ? property.Name
            : attributeInfo.DisplayName;

        changelogs.Add(new PropertyChangelog<T>(property.Name, displayName, oldValue.ToString(), newValue.ToString()));
    }

    return string.IsNullOrEmpty(propertyName) ? changelogs
        : changelogs.Where(i => i.PropertyName.Equals(propertyName));
}
複製程式碼

在下面的這個測試案例中，Entity 類實際上只會記錄 5 個屬性的資料變化，我們手動建立兩個 Entity 類例項，同時改變兩個類例項對應的屬性值。從我們執行的示意圖中可以看到，雖然兩個類例項的 Id 屬性值不同，但是因為被我們手動忽略了，所以最終只顯示我們設定的幾個屬性的變化資訊。

[PropertyChangeTracking]
public class Entity
{
    [PropertyChangeTracking(ignore: true)]
    public Guid Id { get; set; }

    [PropertyChangeTracking(displayName: "序號")]
    public string OId { get; set; }

    [PropertyChangeTracking(displayName: "第一個欄位")]
    public string A { get; set; }

    public double B { get; set; }

    public bool C { get; set; }

    public DateTime Date { get; set; } = DateTime.Now;
}
複製程式碼

總結

這一章是針對我之前在工作中遇到的一個問題，趁著假期考慮的一個解決方法，雖然只是一個小問題，但是還是挺有借鑑意義的，如果能夠給你在日常的開發中提供些許的幫助，不勝榮幸。

佔坑

        作者：墨墨墨墨小宇
        個人簡介：96年生人，出生於安徽某四線城市，畢業於Top 10000000 院校。.NET程式設計師，槍手死忠，喵星人。於2016年12月開始.NET程式設計師生涯，微軟.NET技術的堅定堅持者，立志成為雲養貓的少年中面向谷歌程式設計最厲害的.NET程式設計師。
        個人部落格：yuiter.com
        部落格園部落格：www.cnblogs.com/danvic712