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

472

Как я могу десериализовать этот документ 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;
    }
}

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

Alex
источник
Я думаю, вам нужно избежать угловых скобок в вашем образце документа.
Harpo
4
Этот ответ действительно хорош: stackoverflow.com/a/19613934/196210
Revious

Ответы:

359

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

Вот классы:

[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 (мне нужно было добавить новый элемент для переноса <Cars> ... 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>
Кевин Тиг
источник
68
Это [Serializable]избыточно при использовании XmlSerializer; XmlSerializerпросто никогда не проверяет это. Аналогично, большинство [Xml...]атрибутов являются избыточными, поскольку они просто имитируют поведение по умолчанию; то есть по умолчанию свойство с именем StockNumberсохраняется как элемент с именем <StockNumber>- для этого не нужны атрибуты.
Марк Гравелл
3
Обратите внимание, что XmlElementAttribute = XmlElement (это языковая функция, в которой вы можете опустить суффикс «Атрибут»). Реальным решением здесь является удаление вызова ReadToEnd () и добавление корневого узла. Но лучше используйте код от Еримски, который решает вопрос (
разберите
2
Спасибо Кевину, но что, если я удалил CarsCollection из образца XML. Я удалил Carscollection из классов и отменил реализацию кода, но безуспешно.
Викрант
441

Как насчет того, чтобы просто сохранить 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 в проект)

Марк Гравелл
источник
6
Ты мужчина! Спасибо. для любого, кому это необходимо, «путь» может быть потоком, который вы создаете из веб-ответа, например: var resp = response.Content.ReadAsByteArrayAsync (); var stream = new MemoryStream (соответственно. Результат);
Induster
1
Потрясающая идея, но я не смог заставить ее работать правильно для моей немного более сложной модели с пакетами вложенных массивов. Я продолжал получать ошибки преобразования типов для вложенных массивов - плюс сгенерированная схема именования оставляла желать лучшего. Поэтому я закончил свой путь.
GotDibbs
9
Как добраться до xsd.exe
jwillmer
2
Файл xsd.exe доступен из командной строки Visual Studio, а не из командной строки Windows. Посмотрите, можете ли вы открыть командную строку из Visual Studio в разделе Инструменты. Если нет, попробуйте получить к нему доступ из папки visual studio. Для VS 2012 он находился здесь: C: \ Program Files (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ Tools \ Shortcuts. В Windows 8 попробуйте поискать «Инструменты Visual Studio».
goku_da_master
2
Для всех, кто ищет XSD. Вот SO поток: stackoverflow.com/questions/22975031/…
SOReader
229

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

Способ 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
    введите описание изображения здесь

И это все!

Применение


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

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>();
Дамиан Дрыгель
источник
16
+1 хороший ответ. Но Paste XML As Classesкоманда нацелена только на .NET 4.5
ravy amiry
1
Это отличный способ создания модели, если у вас установлен vs2012 +. После этого я запустил очистку кода ReSharper, чтобы использовать автоматические свойства, а затем выполнил некоторые другие операции. Вы можете создать с помощью этого метода, а затем скопировать в старый проект, если это будет необходимо.
Scotty.NET
4
Таргетинг .net4.5 не является проблемой. Просто запустите временный проект с помощью dotnet4.5, сделайте там копию-вставку и скопируйте исходный код в ваш реальный проект.
LosManos
2
где находится "каталог" объекта или класса?
CB4
3
Чтобы «Вставить XML как классы» для отображения в этом меню в сообществе VS 2017, необходимо установить «ASP.NET и веб-разработка». В случае отсутствия просто запустите установщик VS еще раз, чтобы изменить вашу установку.
Слион
89

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

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);
}

источник
14
На самом деле это единственный ответ. Принятый ответ имеет несколько недостатков, которые могут запутать новичков.
Flamefire
24

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

[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

Я не думаю, что .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>
janbak
источник
7

попробуйте этот блок кода, если ваш 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. Вы можете изменить его для своих нужд.

Shealal Nainwal
источник
6

Аноним Кевина хорош, если не считать того факта, что в реальном мире вы часто не можете изменить исходный 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));
Ким Хоманн
источник
Спасибо! Ваш ответ - именно то, что мне было нужно, так как я не хотел изменять файлы журналов в гигабайтах.
Колин
Хотя стоит упомянуть, что решение XmlSerializer очень элегантно, но по общему признанию также не очень быстро и чутко реагирует на неожиданные данные XML. Поэтому, если ваша проблема не требует полной десериализации, вам следует рассмотреть возможность использования только более прагматичного и производительного класса XmlReader и циклически проходить по элементам <Car>.
Ким Хоманн
5

Попробуйте этот общий класс для сериализации и десериализации 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;
    }
}
Хасан Явид
источник
4

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

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

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);
            }
        }
    }
}

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

SlowLearner
источник
1
Это сработало для меня. Это отлично работающее решение для данного ввода XML (как в примере с OP). [XmlElement ("Car")] является правильным атрибутом. В других примерах они использовали XmlArray и т. Д., Которые не нужны, если у нас есть свойство, определенное как public Car [] Cars {get; набор; } и это правильно десериализовало бы. Спасибо.
Дивакар Падмараджа
3

Как насчет универсального класса для десериализации XML-документа

//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Generic class to load any xml into a class
// used like this ...
// YourClassTypeHere InfoList = LoadXMLFileIntoClass<YourClassTypeHere>(xmlFile);

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

public static T LoadXMLFileIntoClass<T>(string xmlFile)
{
    T returnThis;
    XmlSerializer serializer = new XmlSerializer(typeof(T));
    if (!FileAndIO.FileExists(xmlFile))
    {
        Console.WriteLine("FileDoesNotExistError {0}", xmlFile);
    }
    returnThis = (T)serializer.Deserialize(new StreamReader(xmlFile));
    return (T)returnThis;
}

Эта часть может или не может быть необходимой. Откройте документ XML в Visual Studio, щелкните правой кнопкой мыши на XML, выберите свойства. Затем выберите файл схемы.

Дэвид С Фукс
источник
1
Это позволило мне немного сократить код бизнес-логики и централизовать функциональность вспомогательного класса со всеми сгенерированными классами <T>. У меня уже был XML в строке, поэтому я мог бы сжать его следующим образом: `public static T LoadXMLFileIntoClass <T> (string xmlData)` {`XmlSerializer serializer = new XmlSerializer (typeof (T)); `return (T) serializer.Deserialize (new StringReader (xmlData)); `} Спасибо!
pwrgreg007
3

Один лайнер:

var object = (Cars)new XmlSerializer(typeof(Cars)).Deserialize(new StringReader(xmlString));
Андре М
источник
2

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

<?xml version="1.0" ?> 
 <TRANSACTION_RESPONSE>
    <TRANSACTION>
        <TRANSACTION_ID>25429</TRANSACTION_ID> 
        <MERCHANT_ACC_NO>02700701354375000964</MERCHANT_ACC_NO> 
        <TXN_STATUS>F</TXN_STATUS> 
        <TXN_SIGNATURE>a16af68d4c3e2280e44bd7c2c23f2af6cb1f0e5a28c266ea741608e72b1a5e4224da5b975909cc43c53b6c0f7f1bbf0820269caa3e350dd1812484edc499b279</TXN_SIGNATURE> 
        <TXN_SIGNATURE2>B1684258EA112C8B5BA51F73CDA9864D1BB98E04F5A78B67A3E539BEF96CCF4D16CFF6B9E04818B50E855E0783BB075309D112CA596BDC49F9738C4BF3AA1FB4</TXN_SIGNATURE2> 
        <TRAN_DATE>29-09-2015 07:36:59</TRAN_DATE> 
        <MERCHANT_TRANID>150929093703RUDZMX4</MERCHANT_TRANID> 
        <RESPONSE_CODE>9967</RESPONSE_CODE> 
        <RESPONSE_DESC>Bank rejected transaction!</RESPONSE_DESC> 
        <CUSTOMER_ID>RUDZMX</CUSTOMER_ID> 
        <AUTH_ID /> 
        <AUTH_DATE /> 
        <CAPTURE_DATE /> 
        <SALES_DATE /> 
        <VOID_REV_DATE /> 
        <REFUND_DATE /> 
        <REFUND_AMOUNT>0.00</REFUND_AMOUNT> 
    </TRANSACTION>
  </TRANSACTION_RESPONSE> 

Приведенный выше XML обрабатывается в два уровня

  [XmlType("TRANSACTION_RESPONSE")]
public class TransactionResponse
{
    [XmlElement("TRANSACTION")]
    public BankQueryResponse Response { get; set; }

}

Внутренний уровень

public class BankQueryResponse
{
    [XmlElement("TRANSACTION_ID")]
    public string TransactionId { get; set; }

    [XmlElement("MERCHANT_ACC_NO")]
    public string MerchantAccNo { get; set; }

    [XmlElement("TXN_SIGNATURE")]
    public string TxnSignature { get; set; }

    [XmlElement("TRAN_DATE")]
    public DateTime TranDate { get; set; }

    [XmlElement("TXN_STATUS")]
    public string TxnStatus { get; set; }


    [XmlElement("REFUND_DATE")]
    public DateTime RefundDate { get; set; }

    [XmlElement("RESPONSE_CODE")]
    public string ResponseCode { get; set; }


    [XmlElement("RESPONSE_DESC")]
    public string ResponseDesc { get; set; }

    [XmlAttribute("MERCHANT_TRANID")]
    public string MerchantTranId { get; set; }

}

Таким же образом, вам нужно многоуровневое с car as array Проверьте этот пример для многоуровневой десериализации

makdu
источник
1

Если вы получаете ошибки при использовании xsd.exe для создания файла xsd, используйте класс XmlSchemaInference, как указано в msdn . Вот тестовый модуль для демонстрации:

using System.Xml;
using System.Xml.Schema;

[TestMethod]
public void GenerateXsdFromXmlTest()
{
    string folder = @"C:\mydir\mydata\xmlToCSharp";
    XmlReader reader = XmlReader.Create(folder + "\some_xml.xml");
    XmlSchemaSet schemaSet = new XmlSchemaSet();
    XmlSchemaInference schema = new XmlSchemaInference();

    schemaSet = schema.InferSchema(reader);


    foreach (XmlSchema s in schemaSet.Schemas())
    {
        XmlWriter xsdFile = new XmlTextWriter(folder + "\some_xsd.xsd", System.Text.Encoding.UTF8);
        s.Write(xsdFile);
        xsdFile.Close();
    }
}

// now from the visual studio command line type: xsd some_xsd.xsd /classes
goku_da_master
источник
1

Вы можете просто изменить один атрибут для вашего автомобиля Cars с XmlArrayItem на XmlElment. То есть из

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

в

[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlElement("Car")]
    public Car[] Car { get; set; }
}
Сюй Вэйцзян
источник
1

Мое решение:

  1. использование Edit > Past Special > Paste XML As Classes чтобы получить класс в вашем коде
  2. Попробуйте что-то вроде этого: создайте список этого класса ( List<class1>), а затем используйте XmlSerializerдля сериализации этого списка в xmlфайл.
  3. Теперь вы просто заменяете тело этого файла вашими данными и пытаетесь сделать deserializeэто.

Код:

StreamReader sr = new StreamReader(@"C:\Users\duongngh\Desktop\Newfolder\abc.txt");
XmlSerializer xml = new XmlSerializer(typeof(Class1[]));
var a = xml.Deserialize(sr);
sr.Close();

ПРИМЕЧАНИЕ: вы должны обратить внимание на корневое имя, не меняйте его. Шахта "ArrayOfClass1"

haiduong87
источник
1
async public static Task<JObject> XMLtoNETAsync(XmlDocument ToConvert)
{
    //Van XML naar JSON
    string jsonText = await Task.Run(() => JsonConvert.SerializeXmlNode(ToConvert));

    //Van JSON naar .net object
    var o = await Task.Run(() => JObject.Parse(jsonText));

    return o;
}
Zoidbergseasharp
источник
1
Пожалуйста, ставьте свой ответ всегда в контексте, а не просто вставляйте код. Смотрите здесь для более подробной информации.
gehbiszumeis