避免序列化 REST 服务中的某些属性

Question

我在客户端和服务器端有一个 .Net 应用程序，服务器提供 REST 服务（使用 WCF）。我有这样的服务定义：

[WebGet(UriTemplate = "/Customers/{id}")]
Customer GetCustomerById(string id);

[WebGet(UriTemplate = "/Customers")]
List<Customer> GetAllCustomers();

使用 Fluent NHibernate 和延迟加载将 Customer 类及其朋友映射到数据库。如果我从会话范围之外的服务返回，则服务调用将失败，因为它无法序列化引用的延迟加载的 Orders 属性（请参阅最后的类 def）。问题是我需要延迟加载，因为我不希望我的GetAllCustomers-service 获取所有引用的订单。所以我想做的是以某种方式通知序列化程序，这样它就不会尝试在 GetAll 上序列化 Orders。但请注意，必须在 GetCustomerById 上序列化相同的属性 - 所以我必须在服务上指定它。这可以吗？！

类：

public class Customer
{
    public virtual int Id { get; set; }
    public virtual string Name { get; set; }
    public virtual IList<Order> Orders { get; set; }
}

public class Order
{
    public virtual int Id { get; set; }
    // ++ 
}

Answer 1

如果您使用 WCF 的默认序列化 - 我认为您会这样做 - 您将明确标记要通过网络发送的属性并保留其余的。这是使用[DataMember] 完成的，我假设您这样做：

[DataContract]
public class Customer
{
    [DataMember]
    public virtual int Id { get; set; }

    [DataMember]
    public virtual string Name { get; set; }

    // not decorate 
    public virtual IList<Order> Orders { get; set; }
} 

更新 好的，您需要有时发送，而不是其他时间发送。显然，您可以拥有 CustomerBase 类（没有订单），然后是 Customer（未装饰的订单）和 CustomerWithOrders（装饰的订单）。从您的每个操作中发送每个。

如果这不适合您，请在此处查看使用 DataContractSerializerOperationBehavior 和 IDataContractSurrogate 的自定义序列化：

http://msdn.microsoft.com/en-us/library/system.runtime.serialization.idatacontractsurrogate.aspx

http://msdn.microsoft.com/en-us/library/system.servicemodel.description.datacontractserializeroperationbehavior_members.aspx

Answer 2

为不同的场景使用不同的 DTO，然后使用 Automapper 将您的 nhib 对象传输到 DTO - 这样您就可以为每种情况创建一个专用的对象图，然后您就无法进行迭代，从而为您的集合补充水分不想。

Answer 3

我会为GetAllCustomers 服务返回不同的数据合同。例如，

[DataContract]
public class CustomerSummary
{
   // Have properties that represent the summary of the customer
}

WebGet(UriTemplate = "/Customers/{id}")]    
Customer GetCustomerById(string id);    

[WebGet(UriTemplate = "/Customers")]    
List<CustomerSummary> GetAllCustomers();

或者，在将DataMember 属性应用于Orders 属性时使用EmitDefaultValue：

[DataContract]       
public class Customer       
{       
   [DataMember]       
   public virtual int Id { get; set; }       

   [DataMember]
   public virtual string Name { get; set; }       

   [DataMember(IsRequired = false, EmitDefaultValue = false)]
   public virtual IList<Order> Orders { get; set; }       
}

然后在 GetAllCustomers 返回它的数据时将 Orders 属性保留为空。

Answer 4

延迟加载仅在休眠会话范围内有效。没有机会通过电线这样做。您需要急切地获取集合或使用 OOP 继承并从您的 Web 方法返回一个根本没有此集合的类，尤其是在消费者不需要它的情况下。