Можно ли десериализовать XML в список <T>?

Question

С учетом следующего XML:

<?xml version="1.0"?>
<user_list>
   <user>
      <id>1</id>
      <name>Joe</name>
   </user>
   <user>
      <id>2</id>
      <name>John</name>
   </user>
</user_list>

И следующий класс:

public class User {
   [XmlElement("id")]
   public Int32 Id { get; set; }

   [XmlElement("name")]
   public String Name { get; set; }
}

Можно ли использовать XmlSerializer для десериализации xml в List<User>? Если да, то какой тип дополнительных атрибутов мне нужно использовать, или какие дополнительные параметры мне нужно использовать для создания экземпляра XmlSerializer?

Массив (User[]) будет приемлемым, если будет немного менее предпочтительным.

Answer 1

Вы можете инкапсулировать список тривиально:

using System;
using System.Collections.Generic;
using System.Xml.Serialization;

[XmlRoot("user_list")]
public class UserList
{
    public UserList() {Items = new List<User>();}
    [XmlElement("user")]
    public List<User> Items {get;set;}
}
public class User
{
    [XmlElement("id")]
    public Int32 Id { get; set; }

    [XmlElement("name")]
    public String Name { get; set; }
}

static class Program
{
    static void Main()
    {
        XmlSerializer ser= new XmlSerializer(typeof(UserList));
        UserList list = new UserList();
        list.Items.Add(new User { Id = 1, Name = "abc"});
        list.Items.Add(new User { Id = 2, Name = "def"});
        list.Items.Add(new User { Id = 3, Name = "ghi"});
        ser.Serialize(Console.Out, list);
    }
}

Answer 2

Если вы украсите класс User с помощью XmlType в соответствии с необходимой заглавной буквой:

[XmlType("user")]
public class User
{
   ...
}

Тогда XmlRootAttribute на XmlSerializer ctor может обеспечить желаемый корень и разрешить прямое чтение в List <>:

    // e.g. my test to create a file
    using (var writer = new FileStream("users.xml", FileMode.Create))
    {
        XmlSerializer ser = new XmlSerializer(typeof(List<User>),  
            new XmlRootAttribute("user_list"));
        List<User> list = new List<User>();
        list.Add(new User { Id = 1, Name = "Joe" });
        list.Add(new User { Id = 2, Name = "John" });
        list.Add(new User { Id = 3, Name = "June" });
        ser.Serialize(writer, list);
    }

...

    // read file
    List<User> users;
    using (var reader = new StreamReader("users.xml"))
    {
        XmlSerializer deserializer = new XmlSerializer(typeof(List<User>),  
            new XmlRootAttribute("user_list"));
        users = (List<User>)deserializer.Deserialize(reader);
    }

Кредит: на основе ответа из YK1 .

Answer 3

Я думаю, что нашел лучший способ. Вам не нужно помещать атрибуты в ваши классы. Я сделал два метода для сериализации и десериализации, которые принимают общий список в качестве параметра.

Посмотрите (у меня работает):

private void SerializeParams<T>(XDocument doc, List<T> paramList)
    {
        System.Xml.Serialization.XmlSerializer serializer = new System.Xml.Serialization.XmlSerializer(paramList.GetType());

        System.Xml.XmlWriter writer = doc.CreateWriter();

        serializer.Serialize(writer, paramList);

        writer.Close();           
    }

private List<T> DeserializeParams<T>(XDocument doc)
    {
        System.Xml.Serialization.XmlSerializer serializer = new System.Xml.Serialization.XmlSerializer(typeof(List<T>));

        System.Xml.XmlReader reader = doc.CreateReader();

        List<T> result = (List<T>)serializer.Deserialize(reader);
        reader.Close();

        return result;
    }

Таким образом, вы можете сериализовать любой список, который вы хотите! Вам не нужно каждый раз указывать тип списка.

        List<AssemblyBO> list = new List<AssemblyBO>();
        list.Add(new AssemblyBO());
        list.Add(new AssemblyBO() { DisplayName = "Try", Identifier = "243242" });
        XDocument doc = new XDocument();
        SerializeParams<T>(doc, list);
        List<AssemblyBO> newList = DeserializeParams<AssemblyBO>(doc);

Answer 4

Да, он будет сериализовать и десериализовать список <>. Просто убедитесь, что вы используете атрибут [XmlArray], если сомневаетесь.

[Serializable]
public class A
{
    [XmlArray]
    public List<string> strings;
}

Работает как с Serialize (), так и с Deserialize ().

Answer 5

Да, он десериализуется в список <>. Не нужно хранить его в массиве и оборачивать / инкапсулировать в список.

public class UserHolder
{
    private List<User> users = null;

    public UserHolder()
    {
    }

    [XmlElement("user")]
    public List<User> Users
    {
        get { return users; }
        set { users = value; }
    }
}

код десериализации,

XmlSerializer xs = new XmlSerializer(typeof(UserHolder));
UserHolder uh = (UserHolder)xs.Deserialize(new StringReader(str));

Answer 6

Не уверен насчет Списка , но Массивы, безусловно, выполнимы. И немного магии позволяет действительно легко снова попасть в Список.

public class UserHolder {
   [XmlElement("list")]
   public User[] Users { get; set; }

   [XmlIgnore]
   public List<User> UserList { get { return new List<User>(Users); } }
}

Answer 7

Как насчет

XmlSerializer xs = new XmlSerializer(typeof(user[]));
using (Stream ins = File.Open(@"c:\some.xml", FileMode.Open))
foreach (user o in (user[])xs.Deserialize(ins))
   userList.Add(o);    

Не особенно необычно, но должно работать.