如何獲取 C# 類中發生數據變化的屬性信息

一、前言

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

代碼倉儲地址：https://github.com/Lanesra712/ingos-common/tree/master/sample/csharp/get-data-changed-properties

 

二、Step by Step

1、需求場景

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

2、解決方法

既然想要得知用戶操作前后的數據差異，我們肯定需要去對用戶操作前后的數據進行比對，這里就落到我們承接數據的類身上。

在我們定義類中的屬性時，更多的是使用自動屬性的方式來完成屬性的 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;
}

 

三、總結

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