在 C# 中填充 Web 服务上的任何元素

Question

有人可以向我指出一个 C# 示例，在该示例中，他们填充请求并接收 Web 服务的响应，其中架构主要实现为 ANY 元素？

我已向我的项目添加了 Web 服务引用。 Web 服务的 WSDL/schema 将服务请求和响应的大部分正文作为"ANY"元素。 我知道基于在 Java 中实现此 Web 服务请求的客户端的底层模式。 提前感谢您的帮助。

ServiceGenericRequest_Type requestBody = <init>
GenericRequestData_Type genericRequest = <init>;
// here is where the ANY element starts
genericRequest.Any = new System.Xml.XmlElement[1];
// receive error that I can not create abstract type
System.Xml.XmlNode inqNode = new System.Xml.XmlNode();
genericRequest.Any[0].AppendChild(inqNode);`

Answer 1

你的问题相当笼统，所以我要把它缩小到以下情况： 您有一个带有[XmlAnyElement]成员的类型，如下所示：

public class GenericRequestData_Type
{
    private System.Xml.XmlElement[] anyField;
    [System.Xml.Serialization.XmlAnyElementAttribute()]
    public System.Xml.XmlElement[] Any
    {
        get
        {
            return this.anyField;
        }
        set
        {
            this.anyField = value;
        }
    }
}

并且您希望将Any字段初始化为以下 XML：

<Contacts>
  <Contact>
    <Name>Patrick Hines</Name>
    <Phone>206-555-0144</Phone>
    <Address>
      <Street1>123 Main St</Street1>
      <City>Mercer Island</City>
      <State>WA</State>
      <Postal>68042</Postal>
    </Address>
  </Contact>
</Contacts>

如何做到这一点？

有几种选择，所以我将它分解为几个不同的答案。

首先，您可以使用代码生成工具(如 http://xmltocsharp.azurewebsites.net/或 Visual Studio 的"将 XML 粘贴为类"(设计与所需 XML 相对应的 c# 类。 然后，可以使用XmlSerializer与XmlDocument.CreateNavigator().AppendChild()结合使用将这些类直接序列化到XmlNode层次结构。

首先，介绍以下扩展方法：

public static class XmlNodeExtensions
{
    public static XmlDocument AsXmlDocument<T>(this T o, XmlSerializerNamespaces ns = null, XmlSerializer serializer = null)
    {
        XmlDocument doc = new XmlDocument();
        using (XmlWriter writer = doc.CreateNavigator().AppendChild())
            new XmlSerializer(o.GetType()).Serialize(writer, o, ns ?? NoStandardXmlNamespaces());
        return doc;
    }
    public static XmlElement AsXmlElement<T>(this T o, XmlSerializerNamespaces ns = null, XmlSerializer serializer = null)
    {
        return o.AsXmlDocument(ns, serializer).DocumentElement;
    }
    public static T Deserialize<T>(this XmlElement element, XmlSerializer serializer = null)
    {
        using (var reader = new ProperXmlNodeReader(element))
            return (T)(serializer ?? new XmlSerializer(typeof(T))).Deserialize(reader);
    }
    /// <summary>
    /// Return an XmlSerializerNamespaces that disables the default xmlns:xsi and xmlns:xsd lines.
    /// </summary>
    /// <returns></returns>
    public static XmlSerializerNamespaces NoStandardXmlNamespaces()
    {
        var ns = new XmlSerializerNamespaces();
        ns.Add("", ""); // Disable the xmlns:xsi and xmlns:xsd lines.
        return ns;
    }
}
public class ProperXmlNodeReader : XmlNodeReader
{
    // Bug fix from this answer https://stackoverflow.com/a/30115691/3744182
    // To http://stackoverflow.com/questions/30102275/deserialize-object-property-with-stringreader-vs-xmlnodereader
    // By https://stackoverflow.com/users/8799/nathan-baulch
    public ProperXmlNodeReader(XmlNode node) : base(node) { }
    public override string LookupNamespace(string prefix)
    {
        return NameTable.Add(base.LookupNamespace(prefix));
    }
}

接下来，定义与<Contacts>层次结构对应的类型：

[XmlRoot(ElementName = "Address")]
public class Address
{
    [XmlElement(ElementName = "Street1")]
    public string Street1 { get; set; }
    [XmlElement(ElementName = "City")]
    public string City { get; set; }
    [XmlElement(ElementName = "State")]
    public string State { get; set; }
    [XmlElement(ElementName = "Postal")]
    public string Postal { get; set; }
}
[XmlRoot(ElementName = "Contact")]
public class Contact
{
    [XmlElement(ElementName = "Name")]
    public string Name { get; set; }
    [XmlElement(ElementName = "Phone")]
    public string Phone { get; set; }
    [XmlElement(ElementName = "Address")]
    public Address Address { get; set; }
}
[XmlRoot(ElementName = "Contacts")]
public class Contacts
{
    [XmlElement(ElementName = "Contact")]
    public Contact Contact { get; set; }
}
[XmlRoot("GenericRequestData_Type")]
public class Person
{
    public string Name { get; set; }
    public DateTime BirthDate { get; set; }
    [XmlArray("Emails")]
    [XmlArrayItem("Email")]
    public List<string> Emails { get; set; }
    [XmlArray("Issues")]
    [XmlArrayItem("Id")]
    public List<long> IssueIds { get; set; }
}

最后，按如下方式初始化GenericRequestData_Type：

var genericRequest = new GenericRequestData_Type();
var contacts = new Contacts
{
    Contact = new Contact
    {
        Name = "Patrick Hines",
        Phone = "206-555-0144",
        Address = new Address
        {
            Street1 = "123 Main St",
            City = "Mercer Island",
            State = "WA",
            Postal = "68042",
        },
    }
};
genericRequest.Any = new[] { contacts.AsXmlElement() };

样品小提琴。

Answer 2

XmlNode是一个抽象的基类型。 您可以创建具体的XmlElement对象，然后按照在 DOM 中创建新节点中的说明添加到Any数组中：

• 首先，创建一个XmlDocument。 虽然文档未显式显示在 XmlElement [] Any 数组中，但随后需要它来创建元素。
• 使用XmlDocument.CreateElement()创建元素
• 使用XmlNode.AppendChild根据需要将创建的元素添加到其父元素
• 使用 XmlElement.InnerText 设置文本值。

因此，以下内容将起作用：

var dom = new XmlDocument();
var contacts = dom.CreateElement("Contacts");
dom.AppendChild(contacts);
var contact = dom.CreateElement("Contact");
contacts.AppendChild(contact);
var name = dom.CreateElement("Name");
contact.AppendChild(name);
name.InnerText = "Patrick Hines";
var phone = dom.CreateElement("Phone");
contact.AppendChild(phone);
phone.InnerText = "206-555-0144";
var address = dom.CreateElement("Address");
contact.AppendChild(address);
var street1 = dom.CreateElement("Street1");
address.AppendChild(street1);
street1.InnerText = "123 Main St";
var city = dom.CreateElement("City");
address.AppendChild(city);
city.InnerText = "Mercer Island";
var state = dom.CreateElement("State");
address.AppendChild(state);
state.InnerText = "WA";
var postal = dom.CreateElement("Postal");
address.AppendChild(postal);
postal.InnerText = "68042";
var genericRequest = new GenericRequestData_Type();
genericRequest.Any = new[] { dom.DocumentElement };

样品小提琴。

Answer 3

XmlNode是旧 XML 文档对象模型中的一种类型，可追溯到 c# 1.1。 它已被更容易使用的 LINQ to XML 对象模型所取代。 鲜为人知的是，[XmlAnyElementAttribute]实际上支持此API。 因此，在GenericRequestData_Type类型中，您可以手动将Any属性更改为类型System.Xml.Linq.XElement[]：

public class GenericRequestData_Type
{
    private System.Xml.Linq.XElement[] anyField;
    [System.Xml.Serialization.XmlAnyElementAttribute()]
    public System.Xml.Linq.XElement[] Any
    {
        get
        {
            return this.anyField;
        }
        set
        {
            this.anyField = value;
        }
    }
}

然后，您可以按照在 C# 中创建 XML 树(LINQ to XML(中的说明轻松地初始化数组，如下所示：

// Taken from 
// https://msdn.microsoft.com/en-us/library/mt693096.aspx
var contacts =
    new XElement("Contacts",
        new XElement("Contact",
            new XElement("Name", "Patrick Hines"),
            new XElement("Phone", "206-555-0144"),
            new XElement("Address",
                new XElement("Street1", "123 Main St"),
                new XElement("City", "Mercer Island"),
                new XElement("State", "WA"),
                new XElement("Postal", "68042")
            )
        )
    );
var genericRequest = new GenericRequestData_Type();
genericRequest.Any = new[] { contacts };

样品小提琴。