Utiliser l’attribut XmlSchemaProvider
Récemment j’ai eu besoin de retourner un objet non serializable via un WebService. Afin de réaliser cela, j’ai implémenté l’interface IXmlSerializable.
Prenons par exemple ce service :
[ServiceContract]
public interface IMyService
{
[OperationContract]
Person Get(int personId);
}
[DataContract]
public class Person : IXmlSerializable
{
// ...
public void WriteXml(XmlWriter writer)
{
writer.WriteStartDocument();
writer.WriteStartElement("Person",
"http://schemas.itelios.com/sample/Person");
writer.WriteAttributeString("PersonID", this._personId.ToString());
writer.WriteElementString("FirstName", this._firstName);
writer.WriteEndElement();
}
}
Si l’on rajoute une référence à ce service et que l’on ne partage pas le type Person alors le type de retour sera DataSet !
Si l’on regarde le WSDL (WebService Description Language) c’est à dire la description du service, alors on voit ceci :
<xs:complexType name="Person">
<xs:sequence>
<xs:element ref="xs:schema" />
<xs:any />
</xs:sequence>
</xs:complexType>
L’élément xs:any indique que le noeud que l’on retourne peut contenir n’importe quel élément XML.
Ce comportement est normal, nous spécifions nulle part le schéma du XML que l’on retourne. Avant de spécifier un schéma nous allons créer le type XSD que l’on va retourner :
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
targetNamespace="http://schemas.itelios.com/sample/Person"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="Person">
<xs:sequence>
<xs:element name="FirstName" type="xs:string" />
</xs:sequence>
<xs:attribute name="PersonID" type="xs:int" use="required" />
</xs:complexType>
</xs:schema>
Puis, utilisons l’attribut XmlSchemaProviderAttribute, cet attribut prend en paramètre le nom d’une méthode static devant avoir la signature suivante :
public static XmlQualifiedName XXX(XmlSchemaSet xss)
L’objet de type XmlSchemaSet est la collection de schema associée à notre WebService, nous allons rajouter notre schema dans cette collection. Il reste alors à indiquer quel type XSD notre objet va retourner, c’est le but du XmlQualifiedName.
public class Person
{
// ...
public static XmlQualifiedName GetPersonSchema(XmlSchemaSet xss)
{
// on stock notre fichier XSD en ressource de notre assembly
using (Stream fs = Assembly.GetExecutingAssembly()
.GetManifestResourceStream("Contract.Person.xsd"))
{
XmlSchema schema = XmlSchema.Read(fs, (sender, e) => {
Console.WriteLine(e.Message);
});
xss.Add(schema);
}
// nom du type XSD et namespace de l'objet que notre serialization va utiliser
return new XmlQualifiedName("Person", @"http://schemas.itelios.com/sample/Person");
}
}
Ainsi, notre schéma sera correctement ajouté au niveau du WSDL et le type retourné sera associé avec le type
Person du namespace spécifié.
Cet attribut fonctionne aussi bien pour les services WCF que pour les services web classique (asmx).
Pour information, j’ai déjà expliqué comment utiliser l’interface IXmlSerializable ici : WCF : serialiser un objet non serialisable lorsque l'on n'a pas accès au type