Serializace XML s webovými službami XML

Serializace XML je základní transportní mechanismus používaný v architektuře webových služeb XML prováděné XmlSerializer třídou. Chcete-li řídit XML vygenerované webovou službou XML, můžete použít atributy uvedené v atributech, které řídí serializaci XML a atributy, které řídí kódované serializace SOAP třídy, návratové hodnoty, parametry a pole souboru sloužící k vytvoření webové služby XML (.asmx). Další informace o vytvoření webové služby XML naleznete v tématu XML Webové služby pomocí ASP.NET.

Literální a kódované styly

Xml vygenerovaný webovou službou XML lze formátovat jedním ze dvou způsobů, buď literálem nebo kódováním, jak je vysvětleno v tématu Přizpůsobení formátování zprávy SOAP. Proto existují dvě sady atributů, které řídí serializaci XML. Atributy uvedené v Atributy, které řídí XML serializaci jsou navrženy pro řízení doslovného stylu XML. Atributy uvedené v atributech, které řídí kódované SOAP Serializace řídí kódovaný styl. Selektivním použitím těchto atributů můžete aplikaci přizpůsobit tak, aby vracela buď nebo oba styly. Kromě toho lze tyto atributy použít (podle potřeby) k vrácení hodnot a parametrů.

Příklad použití obou stylů

Při vytváření webové služby XML můžete v metodách použít obě sady atributů. V následujícím příkladu kódu obsahuje pojmenovaná MyService třída dvě metody MyLiteralMethod webové služby XML a MyEncodedMethod. Obě metody provádějí stejnou funkci: vrací instanci Order třídy. Ve třídě Order se na pole XmlTypeAttribute aplikují oba atributy, SoapTypeAttribute i OrderID, a každý z nich má vlastnost ElementName nastavenou na jinou hodnotu.

Pokud chcete tento příklad spustit, vložte kód do souboru s příponou .asmx a umístěte ho do virtuálního adresáře spravovaného internetovou informační službou (IIS). Ve webovém prohlížeči zadejte název počítače, virtuálního adresáře a souboru.

<%@ WebService Language="VB" Class="MyService" %>  
Imports System  
Imports System.Web.Services  
Imports System.Web.Services.Protocols  
Imports System.Xml.Serialization  
Public Class Order  
    ' Both types of attributes can be applied. Depending on which type  
    ' the method used, either one will affect the call.  
    <SoapElement(ElementName:= "EncodedOrderID"), _  
    XmlElement(ElementName:= "LiteralOrderID")> _  
    public OrderID As String  
End Class  
  
Public Class MyService  
    <WebMethod, SoapDocumentMethod> _  
    public Function MyLiteralMethod() As Order
        Dim myOrder As Order = New Order()  
        return myOrder  
    End Function  
    <WebMethod, SoapRpcMethod> _  
    public Function MyEncodedMethod() As Order
        Dim myOrder As Order = New Order()  
        return myOrder  
    End Function  
End Class  

<%@ WebService Language="C#" Class="MyService" %>  
using System;  
using System.Web.Services;  
using System.Web.Services.Protocols;  
using System.Xml.Serialization;  
public class Order {  
    // Both types of attributes can be applied. Depending on which type  
    // the method used, either one will affect the call.  
    [SoapElement(ElementName = "EncodedOrderID")]  
    [XmlElement(ElementName = "LiteralOrderID")]  
    public String OrderID;  
}  
public class MyService {  
    [WebMethod][SoapDocumentMethod]  
    public Order MyLiteralMethod(){  
        Order myOrder = new Order();  
        return myOrder;  
    }  
    [WebMethod][SoapRpcMethod]  
    public Order MyEncodedMethod(){  
        Order myOrder = new Order();  
        return myOrder;  
    }  
}  

Následující příklad kódu volá MyLiteralMethod. Název elementu se změní na LiteralOrderID.

<?xml version="1.0" encoding="utf-8"?>  
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
    <soap:Body>  
        <MyLiteralMethodResponse xmlns="http://tempuri.org/">  
            <MyLiteralMethodResult>  
                <LiteralOrderID>string</LiteralOrderID>  
            </MyLiteralMethodResult>  
        </MyLiteralMethodResponse>  
    </soap:Body>  
</soap:Envelope>  

Následující příklad kódu volá MyEncodedMethod. Název elementu je EncodedOrderID.

<?xml version="1.0" encoding="utf-8"?>  
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://tempuri.org/" xmlns:types="http://tempuri.org/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
    <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">  
        <tns:MyEncodedMethodResponse>  
            <MyEncodedMethodResult href="#id1" />  
        </tns:MyEncodedMethodResponse>  
        <types:Order id="id1" xsi:type="types:Order">  
            <EncodedOrderID xsi:type="xsd:string">string</EncodedOrderID>  
        </types:Order>  
    </soap:Body>  
</soap:Envelope>  

Použití atributů na vrácené hodnoty

Atributy můžete také použít k vrácení hodnot pro řízení oboru názvů, názvu elementu atd. Následující příklad kódu použije XmlElementAttribute atribut na návratové MyLiteralMethod hodnoty metody. Tímto způsobem vám umožňuje řídit jmenný prostor a název elementu.

<WebMethod, SoapDocumentMethod> _  
public Function MyLiteralMethod() As _  
<XmlElement(Namespace:="http://www.cohowinery.com", _  
ElementName:= "BookOrder")> _  
Order
    Dim myOrder As Order = New Order()  
    return myOrder  
End Function  

[return: XmlElement(Namespace = "http://www.cohowinery.com",  
ElementName = "BookOrder")]  
[WebMethod][SoapDocumentMethod]  
public Order MyLiteralMethod(){  
    Order myOrder = new Order();  
    return myOrder;  
}  

Při vyvolání kód vrátí kód XML, který se podobá následující.

<?xml version="1.0" encoding="utf-8"?>  
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
    <soap:Body>  
        <MyLiteralMethodResponse xmlns="http://tempuri.org/">  
            <BookOrder xmlns="http://www.cohowinery.com">  
                <LiteralOrderID>string</LiteralOrderID>  
            </BookOrder>  
        </MyLiteralMethodResponse>  
    </soap:Body>  
</soap:Envelope>  

Atributy použité na parametry

Můžete také použít atributy na parametry k určení oboru názvů, názvu elementu atd. Následující příklad kódu přidá parametr do MyLiteralMethodResponse metody a použije XmlAttributeAttribute atribut na parametr. Název elementu i obor názvů jsou pro parametr nastaveny.

<WebMethod, SoapDocumentMethod> _  
public Function MyLiteralMethod(<XmlElement _  
("MyOrderID", Namespace:="http://www.microsoft.com")>ID As String) As _  
<XmlElement(Namespace:="http://www.cohowinery.com", _  
ElementName:= "BookOrder")> _  
Order
    Dim myOrder As Order = New Order()  
    myOrder.OrderID = ID  
    return myOrder  
End Function  

[return: XmlElement(Namespace = "http://www.cohowinery.com",  
ElementName = "BookOrder")]  
[WebMethod][SoapDocumentMethod]  
public Order MyLiteralMethod([XmlElement("MyOrderID",
Namespace="http://www.microsoft.com")] string ID){  
    Order myOrder = new Order();  
    myOrder.OrderID = ID;  
    return myOrder;  
}

Požadavek SOAP by vypadal podobně jako následující.

<?xml version="1.0" encoding="utf-8"?>  
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
    <soap:Body>  
        <MyLiteralMethod xmlns="http://tempuri.org/">  
            <MyOrderID xmlns="http://www.microsoft.com">string</MyOrderID>  
        </MyLiteralMethod>  
    </soap:Body>  
</soap:Envelope>  

Použití atributů na třídy

Pokud potřebujete řídit obor názvů prvků, které korelují s třídami, můžete použít XmlTypeAttribute, XmlRootAttributea SoapTypeAttribute, podle potřeby. Následující příklad kódu aplikuje všechny tři na Order třídu.

<XmlType("BigBookService"), _  
SoapType("SoapBookService"), _  
XmlRoot("BookOrderForm")> _  
Public Class Order  
    ' Both types of attributes can be applied. Depending on which  
    ' the method used, either one will affect the call.  
    <SoapElement(ElementName:= "EncodedOrderID"), _  
    XmlElement(ElementName:= "LiteralOrderID")> _  
    public OrderID As String  
End Class  

[XmlType("BigBooksService", Namespace = "http://www.cpandl.com")]  
[SoapType("SoapBookService")]  
[XmlRoot("BookOrderForm")]  
public class Order {  
    // Both types of attributes can be applied. Depending on which  
    // the method used, either one will affect the call.  
    [SoapElement(ElementName = "EncodedOrderID")]  
    [XmlElement(ElementName = "LiteralOrderID")]  
    public String OrderID;  
}  

Výsledky použití XmlTypeAttribute a SoapTypeAttribute lze je vidět při prozkoumání popisu služby, jak je znázorněno v následujícím příkladu kódu.

<s:element name="BookOrderForm" type="s0:BigBookService" />
<s:complexType name="BigBookService">
  <s:sequence>
    <s:element minOccurs="0" maxOccurs="1" name="LiteralOrderID" type="s:string" />
  </s:sequence>

  <s:schema targetNamespace="http://tempuri.org/encodedTypes">
    <s:complexType name="SoapBookService">
      <s:sequence>
        <s:element minOccurs="1" maxOccurs="1" name="EncodedOrderID" type="s:string" />
      </s:sequence>
    </s:complexType>
  </s:schema>
</s:complexType>

Účinek XmlRootAttribute lze také spatřit ve výsledcích HTTP GET a HTTP POST následujícím způsobem.

<?xml version="1.0" encoding="utf-8"?>  
<BookOrderForm xmlns="http://tempuri.org/">  
    <LiteralOrderID>string</LiteralOrderID>  
</BookOrderForm>  

Viz také

• Serializace XML a SOAP
• Atributy, které řídí zakódované serializace SOAP
• Postupy: Serializace objektu jako datového proudu XML SOAP-Encoded
• Postupy: Jak přepsat serializaci XML s kódováním SOAP
• Představujeme serializaci XML
• Postupy: Serializace objektu
• Postupy: Deserializace objektu