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

Question

据我所知，我必须为要通过 WCF 传输的每种数据创建一个“特殊”数据类型，所以如果我有一个共享类，例如

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

我想使用 WCF 发送 District 对象，我必须创建一个数据契约(Contract)，因此我必须创建一个新的 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 重用，而无需在其上添加这些属性？或者我应该在它们可以共享的类上创建一个接口(interface)，以便我可以在它们之间转换它吗？还是第三种东西？

Answer 1

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

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

启动和运行它需要几个步骤(凭内存执行此操作，因此我可能需要调整答案):

1) 在客户端，如果您使用的是 VB，请在与您要在客户端使用的类相同的默认命名空间中创建一个项目(对于 C#，这并不重要，因为命名空间是嵌入式的在类里面)。

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

3) 添加dataContractSerializer到您的 WCF 配置(如果您还没有的话)。

4) 在客户端，右键单击该服务并选择配置服务引用...在出现的对话框中，确保Reuse types in all referenced assemblies已检查并且 Reuse types in all referenced assemblies选项被选中。

5) 实现此功能最棘手的部分是集合。

a) 用 CollectionDataContract 装饰集合属性。

b) 将此集合的条目添加到 reference.svcmap的 CollectionMappings table 。要找到 reference.svcmap，请显示项目中的所有文件，然后展开服务。要编辑它，只需双击该文件。您将在此处为您正在序列化的每个特定集合添加一个条目，您需要区分那些具有 List<> 基础的项目和那些具有 Dictionary<> 基础的项目。如果您不执行此步骤，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诊断日志记录，它会生成一个可以用特殊工具(忘了名字)打开的文件，可以让你深入到错误消息并准确发现问题所在。这为我们节省了数不清的工作时间。要配置此日志记录，请将以下内容添加到您的 web.config 中的 <configuration> 中的任意位置部分:

  <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 后，尝试更新客户端中的服务引用，然后双击您指定的日志文件，该工具将打开。