Как десериализовать XML-документ - PullRequest
432 голосов
/ 13 декабря 2008

Как десериализовать этот XML-документ:

<?xml version="1.0" encoding="utf-8"?>
<Cars>
  <Car>
    <StockNumber>1020</StockNumber>
    <Make>Nissan</Make>
    <Model>Sentra</Model>
  </Car>
  <Car>
    <StockNumber>1010</StockNumber>
    <Make>Toyota</Make>
    <Model>Corolla</Model>
  </Car>
  <Car>
    <StockNumber>1111</StockNumber>
    <Make>Honda</Make>
    <Model>Accord</Model>
  </Car>
</Cars>

У меня есть это:

[Serializable()]
public class Car
{
    [System.Xml.Serialization.XmlElementAttribute("StockNumber")]
    public string StockNumber{ get; set; }

    [System.Xml.Serialization.XmlElementAttribute("Make")]
    public string Make{ get; set; }

    [System.Xml.Serialization.XmlElementAttribute("Model")]
    public string Model{ get; set; }
}

.

[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlArrayItem(typeof(Car))]
    public Car[] Car { get; set; }

}

.

public class CarSerializer
{
    public Cars Deserialize()
    {
        Cars[] cars = null;
        string path = HttpContext.Current.ApplicationInstance.Server.MapPath("~/App_Data/") + "cars.xml";

        XmlSerializer serializer = new XmlSerializer(typeof(Cars[]));

        StreamReader reader = new StreamReader(path);
        reader.ReadToEnd();
        cars = (Cars[])serializer.Deserialize(reader);
        reader.Close();

        return cars;
    }
}

это не похоже на работу: - (

Ответы [ 16 ]

418 голосов
/ 13 декабря 2008

Как насчет того, чтобы просто сохранить XML в файл и использовать xsd для генерации классов C #?

  1. Записать файл на диск (я назвал его foo.xml)
  2. Создать xsd: xsd foo.xml
  3. Генерация C #: xsd foo.xsd /classes

Et voila - и файл кода C #, который должен быть в состоянии прочитать данные через XmlSerializer:

    XmlSerializer ser = new XmlSerializer(typeof(Cars));
    Cars cars;
    using (XmlReader reader = XmlReader.Create(path))
    {
        cars = (Cars) ser.Deserialize(reader);
    }

(включить сгенерированный файл foo.cs в проект)

331 голосов
/ 13 декабря 2008

Вот рабочая версия. Я изменил метки XmlElementAttribute на XmlElement, потому что в xml значения StockNumber, Make и Model являются элементами, а не атрибутами. Также я удалил ридер. ReadToEnd (); (эта функция читает весь поток и возвращает строку, поэтому функция Deserialze () больше не может использовать устройство чтения ... позиция была в конце потока). Я также взял несколько привилегий с именами:).

Вот классы:

[Serializable()]
public class Car
{
    [System.Xml.Serialization.XmlElement("StockNumber")]
    public string StockNumber { get; set; }

    [System.Xml.Serialization.XmlElement("Make")]
    public string Make { get; set; }

    [System.Xml.Serialization.XmlElement("Model")]
    public string Model { get; set; }
}


[Serializable()]
[System.Xml.Serialization.XmlRoot("CarCollection")]
public class CarCollection
{
    [XmlArray("Cars")]
    [XmlArrayItem("Car", typeof(Car))]
    public Car[] Car { get; set; }
}

Функция десериализации:

CarCollection cars = null;
string path = "cars.xml";

XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));

StreamReader reader = new StreamReader(path);
cars = (CarCollection)serializer.Deserialize(reader);
reader.Close();

И слегка подправленный xml (мне нужно было добавить новый элемент для переноса ... Net требователен к десериализации массивов):

<?xml version="1.0" encoding="utf-8"?>
<CarCollection>
<Cars>
  <Car>
    <StockNumber>1020</StockNumber>
    <Make>Nissan</Make>
    <Model>Sentra</Model>
  </Car>
  <Car>
    <StockNumber>1010</StockNumber>
    <Make>Toyota</Make>
    <Model>Corolla</Model>
  </Car>
  <Car>
    <StockNumber>1111</StockNumber>
    <Make>Honda</Make>
    <Model>Accord</Model>
  </Car>
</Cars>
</CarCollection>
216 голосов
/ 27 октября 2013

У вас есть две возможности.

Метод 1. XSD Инструмент

<ч /> Предположим, что у вас есть XML-файл в этом месте C:\path\to\xml\file.xml

  1. Открыть Командная строка разработчика
    Вы можете найти его в Start Menu > Programs > Microsoft Visual Studio 2012 > Visual Studio Tools Или, если у вас Windows 8, просто начните набирать Командная строка разработчика в Стартовый экран
  2. Измените местоположение на каталог файлов XML, набрав cd /D "C:\path\to\xml"
  3. Создайте XSD-файл из вашего xml-файла, набрав xsd file.xml
  4. Создать C # классы , набрав xsd /c file.xsd

И это все! Вы создали классы C # из XML-файла в C:\path\to\xml\file.cs

Метод 2 - Специальная паста

<ч /> Требуется Visual Studio 2012 +

  1. Копировать содержимое вашего XML-файла в буфер обмена
  2. Добавьте в свое решение новый пустой файл класса ( Shift + Alt + C )
  3. Откройте этот файл и в меню нажмите Edit > Paste special > Paste XML As Classes
    enter image description here

И это все!

Использование

<ч />

Использование этого вспомогательного класса очень просто:

using System;
using System.IO;
using System.Web.Script.Serialization; // Add reference: System.Web.Extensions
using System.Xml;
using System.Xml.Serialization;

namespace Helpers
{
    internal static class ParseHelpers
    {
        private static JavaScriptSerializer json;
        private static JavaScriptSerializer JSON { get { return json ?? (json = new JavaScriptSerializer()); } }

        public static Stream ToStream(this string @this)
        {
            var stream = new MemoryStream();
            var writer = new StreamWriter(stream);
            writer.Write(@this);
            writer.Flush();
            stream.Position = 0;
            return stream;
        }


        public static T ParseXML<T>(this string @this) where T : class
        {
            var reader = XmlReader.Create(@this.Trim().ToStream(), new XmlReaderSettings() { ConformanceLevel = ConformanceLevel.Document });
            return new XmlSerializer(typeof(T)).Deserialize(reader) as T;
        }

        public static T ParseJSON<T>(this string @this) where T : class
        {
            return JSON.Deserialize<T>(@this.Trim());
        }
    }
}

Все, что вам нужно сделать сейчас, это:

    public class JSONRoot
    {
        public catalog catalog { get; set; }
    }
    // ...

    string xml = File.ReadAllText(@"D:\file.xml");
    var catalog1 = xml.ParseXML<catalog>();

    string json = File.ReadAllText(@"D:\file.json");
    var catalog2 = json.ParseJSON<JSONRoot>();
80 голосов
/ 23 декабря 2008

Следующий фрагмент должен помочь (и вы можете игнорировать большинство атрибутов сериализации):

public class Car
{
  public string StockNumber { get; set; }
  public string Make { get; set; }
  public string Model { get; set; }
}

[XmlRootAttribute("Cars")]
public class CarCollection
{
  [XmlElement("Car")]
  public Car[] Cars { get; set; }
}

...

using (TextReader reader = new StreamReader(path))
{
  XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));
  return (CarCollection) serializer.Deserialize(reader);
}
22 голосов
/ 13 декабря 2008

Посмотрите, поможет ли это:

[Serializable()]
[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlArrayItem(typeof(Car))]
    public Car[] Car { get; set; }
}

.

[Serializable()]
public class Car
{
    [System.Xml.Serialization.XmlElement()]
    public string StockNumber{ get; set; }

    [System.Xml.Serialization.XmlElement()]
    public string Make{ get; set; }

    [System.Xml.Serialization.XmlElement()]
    public string Model{ get; set; }
}

И если это не удалось, используйте программу xsd.exe, поставляемую с Visual Studio, для создания документа схемы на основе этого файла XML, а затем снова используйте его для создания класса на основе документа схемы.

9 голосов
/ 26 января 2012

Я не думаю, что .net «требователен к десериализации массивов». Первый документ XML не очень хорошо сформирован. Корневого элемента нет, хотя, похоже, он есть. Канонический XML-документ имеет корень и как минимум 1 элемент (если есть). В вашем примере:

<Root> <-- well, the root
  <Cars> <-- an element (not a root), it being an array
    <Car> <-- an element, it being an array item
    ...
    </Car>
  </Cars>
</Root>
7 голосов
/ 07 октября 2013

попробуйте этот блок кода, если ваш XML-файл был сгенерирован где-то на диске и вы использовали List<T>:

//deserialization

XmlSerializer xmlser = new XmlSerializer(typeof(List<Item>));
StreamReader srdr = new StreamReader(@"C:\serialize.xml");
List<Item> p = (List<Item>)xmlser.Deserialize(srdr);
srdr.Close();`

Примечание: C:\serialize.xml - это путь к моему XML-файлу. Вы можете изменить его для своих нужд.

6 голосов
/ 13 января 2018

Хороший Кевин, кроме того факта, что в реальном мире вы часто не можете изменить исходный XML в соответствии с вашими потребностями.

Существует также простое решение для оригинального XML:

[XmlRoot("Cars")]
public class XmlData
{
    [XmlElement("Car")]
    public List<Car> Cars{ get; set; }
}

public class Car
{
    public string StockNumber { get; set; }
    public string Make { get; set; }
    public string Model { get; set; }
}

И тогда вы можете просто позвонить:

var ser = new XmlSerializer(typeof(XmlData));
XmlData data = (XmlData)ser.Deserialize(XmlReader.Create(PathToCarsXml));
4 голосов
/ 22 мая 2018

для начинающих

Я нашел ответы, которые были здесь очень полезными, и сказал, что я все еще изо всех сил пытался заставить это работать. Так что, если кому-то это поможет, я напишу рабочее решение:

XML из оригинального вопроса. XML находится в файле Class1.xml, path к этому файлу используется в коде для поиска этого XML-файла.

Я использовал ответ @erymski, чтобы заставить это работать, поэтому создал файл с именем Car.cs и добавил следующее:

using System.Xml.Serialization;  // Added

public class Car
{
    public string StockNumber { get; set; }
    public string Make { get; set; }
    public string Model { get; set; }
}

[XmlRootAttribute("Cars")]
public class CarCollection
{
    [XmlElement("Car")]
    public Car[] Cars { get; set; }
}

Другой фрагмент кода, предоставленный @erymski ...

using (TextReader reader = new StreamReader(path))
{
  XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));
  return (CarCollection) serializer.Deserialize(reader);
}

... входит в вашу основную программу (Program.cs), в static CarCollection XCar() вот так:

using System;
using System.IO;
using System.Xml.Serialization;

namespace ConsoleApp2
{
    class Program
    {

        public static void Main()
        {
            var c = new CarCollection();

            c = XCar();

            foreach (var k in c.Cars)
            {
                Console.WriteLine(k.Make + " " + k.Model + " " + k.StockNumber);
            }
            c = null;
            Console.ReadLine();

        }
        static CarCollection XCar()
        {
            using (TextReader reader = new StreamReader(@"C:\Users\SlowLearner\source\repos\ConsoleApp2\ConsoleApp2\Class1.xml"))
            {
                XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));
                return (CarCollection)serializer.Deserialize(reader);
            }
        }
    }
}

Надеюсь, это поможет: -)

4 голосов
/ 12 мая 2016

Попробуйте этот универсальный класс для сериализации и десериализации XML.

public class SerializeConfig<T> where T : class
{
    public static void Serialize(string path, T type)
    {
        var serializer = new XmlSerializer(type.GetType());
        using (var writer = new FileStream(path, FileMode.Create))
        {
            serializer.Serialize(writer, type);
        }
    }

    public static T DeSerialize(string path)
    {
        T type;
        var serializer = new XmlSerializer(typeof(T));
        using (var reader = XmlReader.Create(path))
        {
            type = serializer.Deserialize(reader) as T;
        }
        return type;
    }
}
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...