La sérialisation XML avec .NET

Version imprimable

17/02/2009, 16h17
tomlev

La sérialisation XML avec .NET

Cette discussion est consacrée à l'article intitulé La sérialisation XML avec .NET. Vous pouvez y poster vos commentaires concernant l'article.

Synopsis :

Citation:

Ce tutoriel explique comment sérialiser et désérialiser des objets en XML à l'aide des fonctionnalités du .NET Framework. On verra notamment comment contrôler très finement le schéma des documents XML générés par la sérialisation.
26/02/2009, 13h02
zax-tfh

Excellent tuto !
pdf aussitot enregistré dans mes documents ;)
Merci !
26/02/2009, 16h26
roster

Merci bien!
01/03/2009, 17h12
B.AF

+1 !
01/04/2009, 19h58
AJemni

Franchement ce Tuto ma beaucoup aider et il m’a clarifié beaucoup d’ambiguité, mais en contre partie, la gestion d’héritage n’était pas trop claire pour moi.

+1
02/04/2009, 00h36
tomlev

Citation:

Envoyé par AJemni

mais en contre partie, la gestion d’héritage n’était pas trop claire pour moi.

En fait, c'est un problème qui n'est pas forcément évident à comprendre si on ne l'a pas déjà rencontré sur un cas concret... En tous cas, si tu veux des éclaircissements là-dessus, n'hésite pas à demander ;)
06/08/2009, 16h31
sylvain114d

Très bon article. :ccool:

Une petite remarque cependant à propos de l'attribut Flags sur l'énumération :

Citation:

Remarquez l'attribut Flags sur l'énumération : il indique que les valeurs peuvent être combinées par un OU binaire (opérateur |). Cet attribut n'est habituellement pas obligatoire, mais il l'est dès lors qu'on veut sérialiser cette énumération en XML. Si l'attribut Flags n'est pas présent, une exception sera levée si on cherche à sérialiser une valeur qui ne fait pas explicitement partie de l'énumération.

J'ai essayé de mettre ou supprimer l'attribut Flags au dessus de mon enum et cela n'a rien changé : j'ai quand même une exception lorsque je sérialise une valeur en dehors de l'enum.
J'ai fait mes tests en .Net 2.0. Peut-être cela est-il différent pour les nouvelles versions mais cela m'étonnerais.
06/08/2009, 17h00
tomlev

Citation:

Envoyé par sylvain114d

J'ai fait mes tests en .Net 2.0. Peut-être cela est-il différent pour les nouvelles versions mais cela m'étonnerais.

Bizarre... peux-tu montrer le code qui pose problème ?
(par contre je pars en WE donc je ne pourrai pas regarder avant dimanche soir)

J'ai une exception lors de la sérialisation :

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
    [Flags]
    public enum AddressType
    {
        None = 0,
        Ship = 1,
        Bill = 2
    }
 
    public class Address
    {
        [XmlElement("TypeAdresse")]
        public AddressType Type;
        public string AdrLine1;
    }
 
    class XMLSerialTest
    {
        public static void Test()
        {
            Address a1 = new Address();
            a1.Type = (AddressType)10;
            a1.AdrLine1 = "Hello World!";
 
            XmlSerializer xs = new XmlSerializer(typeof(Address));
            using (StreamWriter wr = new StreamWriter("c:\\test.xml"))
            {
                xs.Serialize(wr, a1);
            }
            using (StreamReader rd = new StreamReader("c:\\test.xml"))
            {
                Address a2 = xs.Deserialize(rd) as Address;
                Console.WriteLine("Type : " + a2.Type);
                Console.WriteLine("Line1 : " + a2.AdrLine1);
            }
        }
    }

10/08/2009, 00h29
tomlev

Le problème est ici :

Code:

a1.Type = (AddressType)10;

10 n'est pas une valeur valide de AddressType. Ca ne correspond à aucune combinaison de valeurs de AddressType... On peut sérialiser des valeurs qui ne font pas explicitement partie de l'enumération, mais il faut quand même que ce soit une combinaison de valeurs existantes...
10/08/2009, 12h05
sylvain114d

OK merci.
Donc la sérialisation XML d'une enum avec l'attribut Flags fonctionne de façon intuitive et cohérente avec le reste du framework.
Dans ton article j'avais l'impression que l'attribut Flags avait un comportement spécial lors de sérialisation XML.

Les phrases :

Citation:

Cet attribut n'est habituellement pas obligatoire, mais il l'est dès lors qu'on veut sérialiser cette énumération en XML.

et

Citation:

Si l'attribut Flags n'est pas présent, une exception sera levée si on cherche à sérialiser une valeur qui ne fait pas explicitement partie de l'énumération.

m'ont induit en erreur.
:oops:
10/08/2009, 12h08
tomlev

Ce que j'ai voulu dire, c'est que si tu essaies de combiner des valeurs d'enum alors que l'enum n'a pas l'attribut Flags, ça plante à la sérialisation
25/02/2015, 15h32
Lyonsbanner
Le tutoriel est intéressant et complet, mais il manque de clarté à certains endroits.

Par exemple, dans la section : I-A-2. Membres de type non-primitif.
Lorsqu'il faut ajouter cette ligne :

Code:

public Address Address { get; set; }

Ce passage du tuto n'est pas assez explicite car elle n'indique pas assez précisément où il faut insérer le code.
J'ai passé plusieurs minutes avant de comprendre qu'il fallait l'intégrer dans la classe Person à la suite des autres propriétés de la classe.

Ensuite, dans la section : I-A-3. Sérialisation d'une collection.
Il faut ajouter et remplacer du code.
Code:

1 2 3 4 5 6 7 8 public List<Address> Addresses { get; set; } // Et on n'oublie pas de l'initialiser dans le constructeur : public Person() { this.Addresses = new List<Address>(); }
Même chose ici, non seulement ce n'est pas assez explicite, mais en plus juste après cette phrase me laisse pantois :

Citation:

Je ne m'attarde pas sur le code de sérialisation, qui est identique à ce qu'on a déjà utilisé plus haut.

Le code de sérialisation n'est visiblement pas identique, puisqu'on a changé les propriétés et pour ainsi dire l'utilisation de la classe Person. Du coup, je me retrouve non pas face à un tutoriel, mais face à une énigme : Comment doit-on réécrire l'utilisation de l'objet pour espérer obtenir le même résultat que dans le tutoriel ?

Et cela m'amène à une autre problématique qui fait que je dois attendre une réponse avant de pouvoir suivre le reste du tutoriel car tous les exemples se basent sur les exemples précédents. L'idéal serait, à la fin de chaque section, de fournir le code complet afin d'être sûr de ne pas faire d'erreur.

Merci d'avance.
25/02/2015, 17h46
tomlev
Citation:

Envoyé par Lyonsbanner

Lorsqu'il faut ajouter cette ligne :

Code:

public Address Address { get; set; }

Ce passage du tuto n'est pas assez explicite car elle n'indique pas assez précisément où il faut insérer le code.
J'ai passé plusieurs minutes avant de comprendre qu'il fallait l'intégrer dans la classe Person à la suite des autres propriétés de la classe.

J'ai beau relire, je ne vois vraiment pas en quoi ce n'est pas clair. Le paragraphe au dessus du code explique sans ambigüité qu'on ajoute une nouvelle propriété Address à la classe Person.

Citation:

Dans notre exemple précédent, la classe Person est très simple, et n'a que des propriétés de type primitif (nombres et chaîne de caractères). Compliquons maintenant un peu les choses et voyons ce qu'il se passe lorsque notre classe a des propriétés de type plus complexe, par exemple une propriété Address :

C'est vrai que je n'ai pas dit explicitement qu'on ajoute la propriété à la classe, mais tel que c'est formulé, je ne vois vraiment pas ce qu'on peut comprendre d'autre...
Citation:
Envoyé par Lyonsbanner

Ensuite, dans la section : I-A-3. Sérialisation d'une collection.
Il faut ajouter et remplacer du code.

Code:

1 2 3 4 5 6 7 8 public List<Address> Addresses { get; set; } // Et on n'oublie pas de l'initialiser dans le constructeur : public Person() { this.Addresses = new List<Address>(); }

Même chose ici, non seulement ce n'est pas assez explicite,
Là encore, je ne vois pas le problème. Cette phrase décrit clairement la modification :

Citation:

on va remplacer la propriété Address par une propriété Addresses, de type List<Address>

Et pour le constructeur qui a effectivement été ajouté, le commentaire dans le code n'est il pas suffisamment clair ?

Comme indiqué au début, ce tuto s'adresse à des gens qui connaissent les bases de C#, et qui devraient donc reconnaitre un constructeur quand ils en voient un ; je ne décris pas chaque ligne de code, sinon le tuto serait interminable (et super ch***t à lire en plus...)

Citation:

Envoyé par Lyonsbanner

Le code de sérialisation n'est visiblement pas identique, puisqu'on a changé les propriétés et pour ainsi dire l'utilisation de la classe Person. Du coup, je me retrouve non pas face à un tutoriel, mais face à une énigme : Comment doit-on réécrire l'utilisation de l'objet pour espérer obtenir le même résultat que dans le tutoriel ?

Non, je maintiens, le code de sérialisation n'a pas changé ; c'est la classe elle-même qui a changé, pas le code à écrire pour en sérialiser une instance. Juste pour être sûr qu'on se comprenne bien, c'est de ce code que je parle :
Code:

1 2 3 4 5 XmlSerializer xs = new XmlSerializer(typeof(Person)); using (StreamWriter wr = new StreamWriter("person.xml")) { xs.Serialize(wr, p); }
Le reste du code ne s'occupe pas de la sérialisation, c'est juste la structure de la classe.

Citation:

Envoyé par Lyonsbanner

Et cela m'amène à une autre problématique qui fait que je dois attendre une réponse avant de pouvoir suivre le reste du tutoriel car tous les exemples se basent sur les exemples précédents.

En fait je pense qu'il y a un malentendu sur la nature de l'article : tu essaies de le suivre comme si c'était un tuto "pas-à-pas", alors que ce n'est pas le cas. J'explique simplement comment faire telle ou telle chose, mais il n'y a pas vraiment de progression pour arriver à un résultat final ; chaque section décrit un scénario différent.

Citation:

Envoyé par Lyonsbanner

L'idéal serait, à la fin de chaque section, de fournir le code complet afin d'être sûr de ne pas faire d'erreur.

Ça aurait un sens si c'était un tuto pas-à-pas, mais comme dit plus haut, ce n'est pas le cas. Peut-être que j'aurais du faire ça, mais j'ai écrit ça il y a 6 ans, et très franchement je n'ai pas la motivation pour le retravailler...

Si tu es bloqué sur un point précis, dis moi ce que c'est, je pourrai essayer de te débloquer.
25/02/2015, 21h07
mermich

Juste histoire d'enfoncer le clou:

Merci tomlev pour ce tuto, je m'en sers souvent pour me souvenir de la syntaxe lors de serialisation. :D

Effectivement tu n'abordes pas toutes les possibilites, mais tu vas a l'essentiel, et de mon point de vue personnel c'est l'un des tuto avec celui xpath et celui sur SOLID dont je me sers le plus souvent.

Citation:

Non, je maintiens, le code de sérialisation n'a pas changé ;
Code:

1 2 3 4 5 XmlSerializer xs = new XmlSerializer(typeof(Person)); using (StreamWriter wr = new StreamWriter("person.xml")) { xs.Serialize(wr, p); }
Oui, effectivement. Cette partie du code de sérialisation n'a pas changé depuis le début, ça j'avais bien compris. Mais c'est dans la partie où on utilise les instances de classes que ça se gâte.

Dans la section "I-A-2. Membres de type non-primitif", il y a ceci :
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 Person p = new Person { Id = 123, LastName = "Dupond", FirstName = "Jean", Address = new Address { Street = "1, rue du petit pont", ZipCode = "75005", City = "Paris", Country = "France" } };
Pas de problème de ce côté là.

Ensuite, on a ce code :
Code:

1 2 3 4 5 6 7 List<Person> contactBook = new List<Person>(); Person jean = ... // inutile de s'appesantir sur l'initialisation des objets... Person jacques = ... contactBoox.Add(jean); contactBoox.Add(jacques);
Là encore c'est simple, il suffit de créer une nouvelle instance de Person avec les informations de Jacques.

Mais après, lorsqu'on arrive au moment il faut mettre un type collection dans la classe Person, il n'y a pas d'exemple du tout. J'ai considéré qu'il suffisait de laisser le code que j'ai bidouillé (et dont je n'étais pas sûr), mais ça n'a pas marché car j'ai obtenu une erreur à ce niveau là :

Code:

Address = new Address { [...] }

Évidement, la propriété a changé et Address n'existe plus. Le gros problème, c'est que je ne savais pas quoi mettre à la place. J'ai donc dû travailler dessus et on m'a expliqué que la structure lors de l'utilisation des instances de classes était complètement différente. J'étais loin d'être sur la bonne voie.

@mermich : Des possibilités, il y en a une infinité. Mais dès qu'on en présente une, et qu'on se retrouve face à une impasse insoupçonnée, l'essentiel d'un tutoriel ne suffit plus.

02/03/2015, 16h14
tomlev

En fait, je suis passé rapidement sur tout ce qui n'était pas directement lié à la sérialisation (par exemple l'initialisation des objets), parce que ce n'était pas le sujet...