c# - 查找两个 C# 对象之间的属性差异

Question

我正在从事的项目需要一些简单的审计日志记录，以记录用户何时更改他们的电子邮件、帐单地址等。我们正在处理的对象来自不同的来源，一个是 WCF 服务，另一个是 Web服务。

我已经使用反射实现了以下方法来查找两个不同对象的属性更改。这将生成具有差异的属性列表以及它们的旧值和新值。

public static IList GenerateAuditLogMessages(T originalObject, T changedObject)
{
    IList list = new List();
    string className = string.Concat("[", originalObject.GetType().Name, "] ");

    foreach (PropertyInfo property in originalObject.GetType().GetProperties())
    {
        Type comparable =
            property.PropertyType.GetInterface("System.IComparable");

        if (comparable != null)
        {
            string originalPropertyValue =
                property.GetValue(originalObject, null) as string;
            string newPropertyValue =
                property.GetValue(changedObject, null) as string;

            if (originalPropertyValue != newPropertyValue)
            {
                list.Add(string.Concat(className, property.Name,
                    " changed from '", originalPropertyValue,
                    "' to '", newPropertyValue, "'"));
            }
        }
    }

    return list;
}

我正在寻找 System.IComparable，因为“所有数值类型(例如 Int32 和 Double)都实现 IComparable，String、Char 和 DateTime 也是如此。”这似乎是查找非自定义类的任何属性的最佳方式。

利用 WCF 或 Web 服务代理代码生成的 PropertyChanged 事件听起来不错，但没有为我的审计日志(旧值和新值)提供足够的信息。

正在寻找关于是否有更好的方法来执行此操作的意见，谢谢!

@Aaronaught，这里是一些示例代码，它基于执行 object.Equals 生成正匹配:

Address address1 = new Address();
address1.StateProvince = new StateProvince();

Address address2 = new Address();
address2.StateProvince = new StateProvince();

IList list = Utility.GenerateAuditLogMessages(address1, address2);

"[Address] StateProvince changed from 'MyAccountService.StateProvince' to 'MyAccountService.StateProvince'"

它是 StateProvince 类的两个不同实例，但属性值相同(在本例中均为 null)。我们没有覆盖 equals 方法。

Answer 1

IComparable用于排序比较。要么使用 IEquatable相反，或者只使用静态 System.Object.Equals方法。如果对象不是原始类型但仍通过覆盖 Equals 定义自己的相等比较，后者的好处是也可以工作。 .

object originalValue = property.GetValue(originalObject, null);
object newValue = property.GetValue(changedObject, null);
if (!object.Equals(originalValue, newValue))
{
    string originalText = (originalValue != null) ?
        originalValue.ToString() : "[NULL]";
    string newText = (newText != null) ?
        newValue.ToString() : "[NULL]";
    // etc.
}

这显然不是完美的，但如果您只对您控制的类执行此操作，那么您可以确保它始终满足您的特定需求。

还有其他方法可以比较对象(例如校验和、序列化等)，但如果类没有始终如一地实现 IPropertyChanged，这可能是最可靠的方法。并且您想真正了解差异。

---

新示例代码的更新:

Address address1 = new Address();
address1.StateProvince = new StateProvince();

Address address2 = new Address();
address2.StateProvince = new StateProvince();

IList list = Utility.GenerateAuditLogMessages(address1, address2);

使用 object.Equals 的原因在您的审核方法中导致“命中”是因为实例实际上不相等!

当然，StateProvince在这两种情况下都可能为空，但是 address1和 address2 StateProvince 仍有非空值属性和每个实例都不同。因此，address1和 address2具有不同的属性。

我们反过来看，以这段代码为例:

Address address1 = new Address("35 Elm St");
address1.StateProvince = new StateProvince("TX");

Address address2 = new Address("35 Elm St");
address2.StateProvince = new StateProvince("AZ");

这些应该被认为是相等的吗？好吧，他们会用你的方法，因为StateProvince不执行 IComparable .这是您的方法报告两个对象在原始情况下相同的唯一原因。自 StateProvince类没有实现 IComparable ，跟踪器完全跳过该属性。但是这两个地址显然不相等!

这就是我最初建议使用 object.Equals 的原因，因为这样你就可以在 StateProvince 中覆盖它获得更好结果的方法:

public class StateProvince
{
    public string Code { get; set; }

    public override bool Equals(object obj)
    {
        if (obj == null)
            return false;

        StateProvince sp = obj as StateProvince;
        if (object.ReferenceEquals(sp, null))
            return false;

        return (sp.Code == Code);
    }

    public bool Equals(StateProvince sp)
    {
        if (object.ReferenceEquals(sp, null))
            return false;

        return (sp.Code == Code);
    }

    public override int GetHashCode()
    {
        return Code.GetHashCode();
    }

    public override string ToString()
    {
        return string.Format("Code: [{0}]", Code);
    }
}

完成此操作后，object.Equals代码将完美运行。而不是天真地检查是否 address1和 address2字面上有相同的StateProvince引用，它实际上会检查语义是否相等。

---

另一种方法是扩展跟踪代码以实际下降到子对象中。换句话说，对于每个属性，检查 Type.IsClass和可选的 Type.IsInterface属性(property)，如果true ，然后递归调用属性本身的更改跟踪方法，在递归返回的任何审计结果前加上属性名称。所以你最终会得到 StateProvinceCode 的变化.

我有时也会使用上面的方法，但是直接覆盖 Equals 会更容易在要比较语义相等性(即审计)的对象上并提供适当的 ToString override 清楚地表明发生了什么变化。它不能针对深度嵌套进行扩展，但我认为以这种方式进行审计是不寻常的。

最后一个技巧是定义你自己的接口(interface)，比如说IAuditable<T> ，它采用相同类型的第二个实例作为参数，并实际返回所有差异的列表(或可枚举的)。它类似于我们重写的 object.Equals上面的方法，但会返回更多信息。当对象图非常复杂并且您知道不能依赖反射或 Equals 时，这很有用。 .您可以将其与上述方法结合使用；实际上，您所要做的就是替代IComparable为你的IAuditable并调用 Audit方法(如果它实现了该接口(interface))。