DataContractSerializer用于自定义值类型

时间:2018-05-03 09:00:00

标签: c# wcf datacontractserializer

我有一个WCF服务,它公开了一个类型TestTypeOne,它当前有一个名为ProductId的字符串属性:

public class TestTypeOne
{
    [DataMember(Name = "ProductId")]
    public string ProductId { get; set; } //note it's a string at the moment
}

我想将此属性的类型从string更改为名为ProductId的自定义值类型,但不违反WCF合同(这仅适用于服务器端,客户端应该看到ProductId仍为字符串。)

public class TestTypeOne
{
    [DataMember(Name = "ProductId")]
    public ProductId ProductId { get; set; }
}

自定义类型是这样的(大多数代码都是为了简洁而删除):

public struct ProductId : IEquatable<ProductId>
{
    readonly string productId;

    public ProductId(string productId)
    {
        this.productId = productId
    }

    public override string ToString() => productId ?? string.Empty;
}

使用以下测试代码:

var sb = new StringBuilder();
using (var writer = new XmlTextWriter(new StringWriter(sb)))
{
    var dto = new TestTypeOne {
        ProductId = new ProductId("1234567890123")
    };

    var serializer = new DataContractSerializer(typeof(TestTypeOne));
    serializer.WriteObject(writer, dto);
    writer.Flush();
}

Console.WriteLine(sb.ToString());

序列化时的预期输出应为:

<Scratch.TestTypeOne xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tests">
    <ProductId>1234567890123</ProductId>
</Scratch.TestTypeOne>

我尝试过实现ISerializable,但这似乎只让我控制ProductId xml标记的内容,而不是标记本身(因此我可以使<ProductId><something>1234113</something></ProductId>之类的内容发生)

理想情况下,我正在追求ProductId类型本身可以做的事情,因为这种类型在许多地方使用,并且许多合同。

2 个答案:

答案 0 :(得分:2)

我认为最简单的方法是实施IXmlSerializable

public struct ProductId : IXmlSerializable
{
    readonly string productId;

    public ProductId(string productId)
    {
        this.productId = productId;
    }

    public override string ToString() => productId ?? string.Empty;

    XmlSchema IXmlSerializable.GetSchema() {
        return null;
    }

    void IXmlSerializable.ReadXml(XmlReader reader) {
        this = new ProductId(reader.ReadString());
    }

    void IXmlSerializable.WriteXml(XmlWriter writer) {
        writer.WriteString(this.productId);
    }
}

要针对这种情况调整WCF xsd生成(强制它生成xs:string) - 您可以使用数据协定代理生成xsd。例如,你可以有这样的结果:

public class ProductIdSurrogate : IDataContractSurrogate {
    public Type GetDataContractType(Type type) {
        if (type == typeof(ProductId))
            return typeof(string);
        return type;
    }

    public object GetObjectToSerialize(object obj, Type targetType) {
        throw new NotImplementedException();
    }

    public object GetDeserializedObject(object obj, Type targetType) {
        throw new NotImplementedException();
    }

    public object GetCustomDataToExport(MemberInfo memberInfo, Type dataContractType) {
        return null;
    }

    public object GetCustomDataToExport(Type clrType, Type dataContractType) {
        return null;
    }

    public void GetKnownCustomDataTypes(Collection<Type> customDataTypes) {
        throw new NotImplementedException();
    }

    public Type GetReferencedTypeOnImport(string typeName, string typeNamespace, object customData) {
        throw new NotImplementedException();
    }

    public CodeTypeDeclaration ProcessImportedType(CodeTypeDeclaration typeDeclaration, CodeCompileUnit compileUnit) {
        throw new NotImplementedException();
    }
}

其唯一的目的是说ProductId类型的数据合同真的是string

然后您可以使用此代理生成模式:

var exporter = new XsdDataContractExporter();
exporter.Options = new ExportOptions();
exporter.Options.DataContractSurrogate = new ProductIdSurrogate();
exporter.Export(typeof(TestTypeOne));

您可以使用此方法进行序列化,但我发现它更复杂。

您可以阅读有关代理和WCF here的更多信息,最底层有一个示例,说明如何将代理用于WSDL生成端点(“使用代理进行元数据导出”一节)。 / p>

答案 1 :(得分:0)

您是否尝试过将DataContract / DataMember属性添加到此ProductId类?

即:

[DataContract]
public struct ProductId : IEquatable<ProductId>
{

[DataMember]
readonly string productId;

public ProductId(string productId)
{
    this.productId = productId
}

public override string ToString() => productId ?? string.Empty;

}

此外,不需要名称属性(Name =“ProductId”),因为变量名称与您覆盖它的名称相同。