在WCF中使用共享数据类型作为DataContract

Question

从我所看到的,我必须为我想通过WCF传输的每种数据创建一个"特殊"数据类型,所以如果我有一个像这样的共享类

public class District
{
    public long Id { get; set; }
    public string Name { get; set; }
}

我想使用WCF发送一个District对象,我必须创建一个datacontract,因此我必须创建一个新的WCF类

[DataContract]
public class WCFDistrict
{
    [DataMember]
    public long Id { get; set; }

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

然后当我在我的实现中的WCF服务中使用它时,我必须将数据从一个对象解析到另一个对象

public WCFDistrict GetDistrict(long id)
{
    var district = _districtRepository.GetDistrict(id);
    return new WCFDistrict {Id = district.Id, Name = district.Name};
}

有没有办法只重用共享类作为DataContract,而没有这些属性？或者我应该在他们可以共享的类上创建一个接口,以便我可以在它们之间进行转换？还是第三种？

Answer 1

首先,您并不是严格要求提供DataContract; 只要您使用.Net 3.5 SP1或更高版本,WCF就会正确序列化普通旧类对象(PO​​CO).

其次,您可以在服务器和客户端的项目中共享相同的物理类文件; 我们拥有数百个以这种方式直接共享的类(和代码)的项目,它在开发和测试中节省了大量的时间和精力.

启动并运行需要几个步骤(从内存中执行此操作,因此我可能需要调整答案):

1)在客户端,如果您使用VB,则在与要在客户端使用的类相同的默认命名空间中创建项目(对于C#,这并不重要,因为命名空间嵌入在类中).

2)将类文件作为链接添加到项目中,以便您拥有该类的一个物理副本.

3)如果您还没有一个dataContractSerializer,请添加一个dataContractSerializer.

4)在客户端,右键单击该服务,然后选择"配置服务引用"...在出现的对话框中,确保Reuse types in all referenced assemblies选中该Reuse types in all referenced assemblies选项并选择该选项.

5)使这项工作最棘手的部分是收藏.

a)使用CollectionDataContract属性装饰集合.

B)加入该集合到一个条目reference.svcmap的CollectionMappings表.要查找reference.svcmap,请显示项目中的所有文件,然后展开该服务.要编辑它,只需双击该文件即可.您将在此处为要序列化的每个特定集合添加一个条目,并且需要区分具有List <> base的项和具有Dictionary <> base的项.如果您不采取此步骤,WCF将自动将这些类序列化为基础通用签名,您将失去对类的使用.

此表中的条目如下所示:

<CollectionMappings>
  <CollectionMapping TypeName="System.Collections.Generic.Dictionary`2" Category="Dictionary" />
  <CollectionMapping TypeName="System.Collections.Generic.List`1" Category="List" />
  <CollectionMapping TypeName="System.Collections.Specialized.StringCollection" Category="List" />
  <CollectionMapping TypeName="My.Namespace.MyDictionaryCollection" Category="Dictionary" />

添加这些条目并保存文件时,WCF客户端生成器将根据您使用的语言重建reference.cs或reference.vb文件.通过查看生成的代码,可以判断是否没有正确配置引用:如果该代码包含类定义,则WCF代码生成器由于某种原因无法映射到复制的类中.

最后要注意的是:有时WCF代码生成器完全无法生成代码,这总是由于服务中的问题(通常一个类不够独特,或者由于某种原因无法对类型进行序列化) .

为了调试这类问题,最简单的方法是添加WCF诊断日志记录,它将生成一个可以通过特殊工具打开的文件(忘记它的名称),它允许您深入查看错误消息和确切地发现了什么问题.这为我们节省了无数的工作时间.要配置此日志记录,请在以下<configuration>部分的任何位置将以下内容添加到web.config :

  <system.diagnostics>
    <sources>
      <source name="System.ServiceModel"
              switchValue="Information, ActivityTracing"
              propagateActivity="true">
        <listeners>
          <add name="traceListener"
              type="System.Diagnostics.XmlWriterTraceListener"
              initializeData="c:\log\WcfTrace.svclog"  />
        </listeners>
      </source>
    </sources>
  </system.diagnostics>

添加完并保存web.config后,尝试更新客户端中的服务引用,然后双击指定的日志文件,该工具将打开.