XMLSerializer 示例

XmlSerializer 示例演示如何序列化和反序列化与XmlSerializer兼容的类型。 默认的 Windows Communication Foundation (WCF) 格式化程序是 DataContractSerializer 类。 若无法使用XmlSerializer类时,可以使用DataContractSerializer类来序列化和反序列化类型。 通常,当需要对 XML 进行精确控制时(例如,如果数据片段必须是 XML 属性而不是 XML 元素)。 此外,在为非 WCF 服务创建客户端时,XmlSerializer 通常会被自动选择。

在此示例中,客户端是一个控制台应用程序 (.exe),服务是由 Internet 信息服务 (IIS) 承载的。

注释

本示例的设置过程和生成说明位于本主题末尾。

必须将ServiceContractAttributeXmlSerializerFormatAttribute应用于接口,如以下示例代码所示。

[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples"), XmlSerializerFormat]
public interface IXmlSerializerCalculator
{
    [OperationContract]
    ComplexNumber Add(ComplexNumber n1, ComplexNumber n2);
    [OperationContract]
    ComplexNumber Subtract(ComplexNumber n1, ComplexNumber n2);
    [OperationContract]
    ComplexNumber Multiply(ComplexNumber n1, ComplexNumber n2);
    [OperationContract]
    ComplexNumber Divide(ComplexNumber n1, ComplexNumber n2);
}

类的公共 ComplexNumber 成员被 XmlSerializer 序列化为 XML 属性。 DataContractSerializer不能用于创建此类 XML 实例。

public class ComplexNumber
{
    private double real;
    private double imaginary;

    [XmlAttribute]
    public double Real
    {
        get { return real; }
        set { real = value; }
    }

    [XmlAttribute]
    public double Imaginary
    {
        get { return imaginary; }
        set { imaginary = value; }
    }

    public ComplexNumber(double real, double imaginary)
    {
        this.Real = real;
        this.Imaginary = imaginary;
    }
    public ComplexNumber()
    {
        this.Real = 0;
        this.Imaginary = 0;
    }

}

服务实现会计算并返回相应的结果,即接受和返回ComplexNumber类型的值。

public class XmlSerializerCalculatorService : IXmlSerializerCalculator
{
    public ComplexNumber Add(ComplexNumber n1, ComplexNumber n2)
    {
        return new ComplexNumber(n1.Real + n2.Real, n1.Imaginary +
                                                      n2.Imaginary);
    }
    …
}

客户端实现还使用复数。 服务协定和数据类型都在generatedClient.cs源文件中定义,这是 由 ServiceModel 元数据实用工具工具(Svcutil.exe) 从服务元数据生成的。 Svcutil.exe 可以检测何时协定不能由 DataContractSerializer 序列化,在这种情况下转而发出 XmlSerializable 类型。 如果要强制使用该 XmlSerializer命令,可以将 /serializer:XmlSerializer(使用 XmlSerializer)命令选项传递给 Svcutil.exe 工具。

// Create a client.
XmlSerializerCalculatorClient client = new
                         XmlSerializerCalculatorClient();

// Call the Add service operation.
ComplexNumber value1 = new ComplexNumber();
value1.Real = 1;
value1.Imaginary = 2;
ComplexNumber value2 = new ComplexNumber();
value2.Real = 3;
value2.Imaginary = 4;
ComplexNumber result = client.Add(value1, value2);
Console.WriteLine("Add({0} + {1}i, {2} + {3}i) = {4} + {5}i",
    value1.Real, value1.Imaginary, value2.Real, value2.Imaginary,
    result.Real, result.Imaginary);
    …
}

运行示例时,操作请求和响应将显示在客户端控制台窗口中。 在客户端窗口中按 Enter 关闭客户端。

Add(1 + 2i, 3 + 4i) = 4 + 6i
Subtract(1 + 2i, 3 + 4i) = -2 + -2i
Multiply(2 + 3i, 4 + 7i) = -13 + 26i
Divide(3 + 7i, 5 + -2i) = 0.0344827586206897 + 1.41379310344828i

Press <ENTER> to terminate client.

设置、生成和运行示例

  1. 确保已为 Windows Communication Foundation 示例 执行One-Time 安装过程。

  2. 若要生成解决方案的 C# 或 Visual Basic .NET 版本,请按照 生成 Windows Communication Foundation 示例中的说明进行操作。

  3. 若要在单台计算机或跨计算机配置中运行示例,请按照 运行 Windows Communication Foundation 示例中的说明进行操作。