VS2022中调用WCF Web Service时DateTime格式传递控制问题

背景信息 #

• 对接的WCF Web Service提供ShipmentsListRequestRequest方法，调用时需指定DateFrom和DateTo参数，要求格式为YYYY-mm-dd
• 服务有对应的WSDL定义和文档说明

问题 #

通过自动生成的客户端类传入DateTime实例时，DateFrom和DateTo参数被忽略，无法正常生效，请问如何控制DateTime格式的传递方式？

代码示例 #

ShipmentsListRequestRequest request = new ShipmentsListRequestRequest();
ShipmentsListRequestResponse shipmentsListResponseResponse;

request.RequestContainer = new ShipmentsListRequestType();
request.RequestContainer.System = SystemType.DE;
request.RequestContainer.Credentials = credentials;
request.RequestContainer.InternalReferenceID = "1";
request.RequestContainer.StoreID = "0000";
request.RequestContainer.DateFrom = DateTime.Today;
request.RequestContainer.DateFromSpecified = true;
request.RequestContainer.DateTo = new DateTime(2022, 8, 20);
request.RequestContainer.DateToSpecified = true;

shipmentsListResponseResponse = await client.ShipmentsListRequestAsync(request);

解决方案 #

1. 调整自动生成类的序列化特性

找到自动生成的ShipmentsListRequestType类中DateFrom、DateTo的属性定义，添加[XmlElement(DataType="date")]特性，强制序列化时输出符合要求的日期格式（需引用System.Xml.Serialization命名空间）：

[XmlElement(DataType="date")]
public DateTime DateFrom { get; set; }
[XmlElement(DataType="date")]
public DateTime DateTo { get; set; }

如果是通过SvcUtil或添加服务引用生成类，可在生成时指定/serializer:XmlSerializer参数，使用XmlSerializer而非DataContractSerializer，更易控制序列化规则。

2. 手动传递格式化后的字符串

若允许修改请求结构，将DateFrom和DateTo改为字符串类型，直接传入格式化后的日期字符串：

request.RequestContainer.DateFrom = DateTime.Today.ToString("yyyy-MM-dd");
request.RequestContainer.DateTo = new DateTime(2022, 8, 20).ToString("yyyy-MM-dd");

3. 配置WCF客户端绑定

在客户端配置文件中调整序列化行为，指定日期格式：

<configuration>
  <system.runtime.serialization>
    <dataContractSerializer>
      <dateTimeFormat mode="RoundtripKind" />
    </dataContractSerializer>
  </system.runtime.serialization>
  <system.serviceModel>
    <bindings>
      <basicHttpBinding>
        <binding name="YourBindingName">
          <textMessageEncoding writeEncoding="utf-8" messageVersion="Soap11" />
        </binding>
      </basicHttpBinding>
    </bindings>
  </system.serviceModel>
</configuration>

内容的提问来源于stack exchange，提问作者Paul Muaddib