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

我正在开发的项目需要在用户更改电子邮件、帐单地址等时进行一些简单的审核日志记录。我们正在使用的对象来自不同的来源，一个是 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);

“[地址] StateProvince 更改自 'MyAccountService.StateProvince' 至 'MyAccountService.StateProvince'"

它是 StateProvince 类的两个不同实例，但属性值相同（在本例中均为 null）。我们不会重写 equals 方法。

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 and address2仍然有非空值StateProvince属性和每个实例都是不同的。所以，address1 and 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 and address2字面上有相同的StateProvince参考，它实际上会检查语义相等性。

另一种方法是扩展跟踪代码以实际下降到子对象。换句话说，对于每个属性，检查Type.IsClass以及可选的Type.IsInterface财产，并且如果true，然后递归地调用属性本身的更改跟踪方法，并使用属性名称作为递归返回的任何审核结果的前缀。所以你最终会得到改变StateProvinceCode.

我有时也使用上述方法，但覆盖更容易Equals在您想要比较语义相等性（即审计）的对象上并提供适当的ToStringoverride 可以清楚地表明发生了什么变化。它不能扩展深层嵌套，但我认为以这种方式进行审核是不寻常的。

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