如何在使用 DataContractSerializer 进行序列化期间替换属性？

Question

我有一个可以正常工作的 ChangeTrackingList 实现，它可以很好地完成它的工作，但我想在将它从客户端发送回服务器时“过滤”它的内容，以便它只包含更改。获取更改很容易，因为我的列表为此目的公开了一个 GetChanges 方法。如何中断 DataContractSerializer 并替换 List 曾经所在的 List.GetChanges()？

更多细节： 考虑一个父/子关系，其中我有一个父级和多个子级，每个子级都有一个对父级的引用，例如客户/订单。将整个子列表序列化到客户端应用程序很好，因为我需要显示所有订单。当我保存时，我不想将所有订单都带回服务器，但是，只是更改。

难度： 我已经研究过实现 ISerializable 和实现我自己的 GetObjectData，如果不是因为我还需要保留对象引用这一事实，这不会很难。如果我将 DataContractSerializer 指向我的图表，并启用 PreserveObjectReferences（通过添加行为或显式通过构造函数），我将得到一个非常漂亮的图表，没有重复，但它需要包含我的整个 ChangeTrackingList。如果我实现 ISerializable，我可以手动写出我的 ChangeTrackingList，并且只包含更改，但那些子对象将不再知道它们的父引用。

说明： 这是一个高度简化的示例，旨在说明问题。我不是在寻找这个特定问题的替代解决方案。我的实际问题不以任何方式涉及客户、订单或订单项。客户/订单问题的替代解决方案不是我要寻找的答案。

很简单，我正在寻找一种仅序列化对象图“有趣”部分的方法。识别和过滤到“有趣”的机制已经完成，我只需要在序列化期间将这些部分替换到对象图中。

另一个例子： 假设我们有一个“Person”实体，它下面有一组“Phone”实体。电话没有父母是无效的，业务规则说一个人没有至少一部电话是无效的。我不能简单地保存这个人，然后在两个单独的电话中保存电话，因为每个电话都会出错。我必须在一次调用中将它们保存为图表。稍后，如果我更新 Person 以更改其存储在 Person 上的地址，并添加新的电话号码，我需要将更新后的人员以及对电话列表的更改发送。我不想发送原来的手机，因为它没有改变。

这又是一个人为的例子，但更接近于现实生活中的问题。我的父母至少没有一个孩子是无效的，没有父母的孩子是无效的。

更新： 看起来我想要执行的“替换”可以通过 DataContractSurrogate 类来完成。我见过一些这样的例子，它们相对简单，但那是因为它们的例子也是如此。它们通常属于“Swap EmployeeSurrogate for Employee”种类，其中“Employee”是一些不可序列化的类。就我而言，事情变得更奇怪了，因为我要交换的类是泛型类型。

所以，问题的一个更简单的版本可能是这样的。假设我有一个完全不可序列化的 MyList 类。 （在有人提出建议之前，替换 MyList 类也不是一个有效的解决方案。请记住，这只是一个示例。）我想设置一个 DataContractSurrogate ，以便每当 MyList 出现在我的对象图中，我想转换将其转换为一个简单的数组进行序列化。

这听起来对任何人来说都是一个有效的方向吗？有没有人尝试过代理泛型类型？考虑到它我是不是疯了？

Answer 1

解决方案是认识到您有两个不同的图：原始对象图和变化图。这些不是同一类型。原始的将有一个客户类型的对象，但另一个将有一个 ChangedCustomer 类型的对象。 Customer 可能有一个 Orders 集合，但 ChangedCustomer 会有一个 ChangedOrders 集合等。

您的 GetChanges 操作将返回 ChangedCustomer 列表，而不是 Customer 列表。

Answer 2

您以错误的方式处理此问题。您希望在将列表发送到客户端时具有一组序列化行为，并在将列表发送回服务器时具有另一组行为。

您应该在客户端上有明确的代码，该代码将调用 GetChanges，然后将修剪后的列表发送回服务器。

---

由于您似乎有一个根只更改了一小部分子项，并且您只想发回那些已更改的子项，因此您需要创建一个新类型，其中包含您要更改的子项列表, 而不是整个对象图。

换句话说，您需要创建一个List<T>（或其他适当的容器）并将其序列化回服务器。问题是，你不会有完全再水化的对象，只有被改变的孩子。

如果您确实需要完全再水化的对象，那么无论如何您都应该发回整个对象图。

Answer 3

我一直在努力解决类似的问题。我认为@casperOne 是在正确的轨道上。从服务器到客户端的通信应该包含一大块完整的对象图。但是应该使用交换有限数据子集的小型辅助方法来更改完整的对象图。

例如，您将使用 ReadFullCustomer() 操作获取完整的客户/订单图，然后使用 AddOrder() 方法回调服务器，仅传递该任务所需的订单信息。让您的服务器的域逻辑处理有关保持父记录与其子记录一致的问题。

Rory Primrose 有一篇关于 WCF service contract design 的文章讨论了厚实与健谈的界面。在您的情况下，听起来您需要将两者结合起来：粗略的读取操作和繁琐的修改操作。

---

编辑：我不确定我是否完全掌握了您的情况，@Mel。听起来您想在序列化期间更改对象图。我知道这样做的唯一方法是让图形中的类实现IXmlSerializable 并滚动您自己的WriteXml 和ReadXml 方法。 DataContractSerializer 理解实现IXmlSerializable 的类，因此值得一试。

Answer 4

好的，我终于有了一些有用的东西，并想分享答案。不幸的是，我不能简单地分享代码，因为它是在客户的时间编写的。

解决方案的关键是 DataContractSurrogate 类，您可以阅读有关 here 和 here 的信息。通常，您会使用它来代替对象图中的不可序列化类。

假设我们有一个不可序列化的 MyList 类。我们需要创建一个代理类来充当它的“替身”。这里的命名约定非常糟糕，因为名为 MyListSurrogate 的命名约定实际上更像是一个工厂，而名为 MyListSurrogated 的命名约定是我认为的实际代理。无论如何，“代理”类公开了一个普通数组或列表，并被标记为 DataContract。这是将通过电线的课程。 MyListSurrogate 类实现了 IDataContractSurrogate，并实现了四个重要的方法。

GetDataContractType 方法返回给定实体类型的替代类型。当给定类型 MyList 时，它应该返回 MyListSurrogated。任何其他类型都应该只返回原始类型。这种方法涉及到一些混乱的反射，所以我将包含它的代码，而不是仅仅解释它。

public Type GetDataContractType(Type type)
{
    if(type.IsGenericType 
        && (type.GetGenericTypeDefinition() == typeof(MyList<>)))
    {
        var itemType = type.GetGenericArguments()[0];
        var result = typeof(MyListSurrogated<>)
            .GetGenericTypeDefinition().MakeGenericType(itemType);
        return result;
    }
    return type;
}

以类似的方式，GetObjectToSerialize 将 MyList instance 转换为 MyListSurrogated 实例。 GetDeserializedObject 将 MyListSurrogated 实例转换回 MyList 实例。 IDataContractSurrogate 包括其他几个我们不会使用的方法，我刚刚为它们中的大多数返回了 null。

然后可以将 MyListSurrogate 类的一个实例传递给 DataContractSerializer 构造函数，它会在序列化和反序列化过程中被调用以根据需要动态替换类型。不幸的是，没有简单的方法可以通过配置指定代理类，因此如果您不实例化自己的 DataContractSerializer，则必须实现 DataContractSerializerOperationBehavior，您可以阅读有关 here 的信息。应用操作行为类似于here描述的方法。

要使用代理，您必须处理一些已知的类型问题。在我的示例中，必须将 MyListSurrogated 类型添加到您尝试调用的服务的已知类型列表中。您可以手动执行此操作，也可以在我的情况下作为代码生成模板的一部分。

最后一件事。我最初的目标是创建一个 ChangeTrackingList，它将其全部内容从服务器传输到客户端，但仅从客户端到服务器的更改。一旦代理被映射，这实际上非常简单。我的 ChangeTrackingList 有一个名为“IncludeOriginalsWhenSerializing”的布尔属性，默认为 true。代理类的 GetObjectToSerialize 方法查看此标志以决定是否将原始项复制到替代项中。在该行的另一端，GetDeserializedObject 方法重新创建原始的 ChangeTrackingList，然后在反序列化期间将标志设置为 false。因此，将标志设置为 true 的列表进入一端，并在标志设置为 false 的另一端出现。很简单，它是自动的，它已经完成了。