Як десеріалізувати 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;
    }
}

які, здається, не працюють :-(


Я думаю, вам потрібно уникнути кутових дужок у вашому зразку док.
гарпо

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

Функція Deserialize:

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> ... Чистий прискіпливий щодо десеріалізації масивів):

<?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 (це мовна особливість, за якою ви можете опустити суфікс "Attribute"). Реальним рішенням тут є видалення виклику ReadToEnd () та додавання кореневого вузла. Але краще скористайтеся кодом від erymski, який вирішує питання (проаналізуйте даний xml)
Flamefire

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 = новий MemoryStream (resp.Result);
Індустр

1
Дивовижна ідея, але не змогла змусити її працювати правильно для моєї трохи складнішої моделі з партіями вкладених масивів. Я постійно отримував помилки перетворення типів для вкладених масивів - плюс створена схема імен залишала бажати кращого. Тому я врешті пройшов звичайний маршрут.
GotDibbs

9
Як дістатися до xsd.exe
jwillmer

2
xsd.exe доступний у командному рядку візуальної студії, а не командному рядку Windows. Перевірте, чи можете ви відкрити командний рядок із візуальної студії в розділі Інструменти. Якщо ні, спробуйте отримати доступ до нього з папки візуальної студії. Для VS 2012 він знаходився тут: C: \ Program Files (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ Tools \ ярлики. У Windows 8 спробуйте знайти "Visual Studio Tools".
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
яровий амірі

1
Це прекрасний спосіб генерувати модель, якщо у вас встановлено vs2012 +. Після цього я запустив очищення коду ReSharper, щоб використати автоматичні властивості, а потім також прибирав деякі інші. Ви можете генерувати за допомогою цього методу, а потім скопіювати у старіший програму, якщо потрібно.
Scotty.NET

4
Націлювання .net4.5 - це не проблема. Просто запустіть тимчасовий проект з dotnet4.5, зробіть свою копію-вставку та скопіюйте джерело у власний проект.
ЛосМанос

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
Це насправді одна і єдина відповідь. Прийнята відповідь має пару недоліків, які можуть бентежити початківців.
Полум'я полум'я

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, яка постачається разом із візуальною студією, створити документ-схему на основі цього файлу 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>

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. Ви можете змінити це для своїх потреб.


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

Сподіваюся, що це допомагає :-)


1
Це працювало для мене. Це ідеально працююче рішення для даного вводу xml (як у прикладі ОП). [XmlElement ("Автомобіль")] - правильний атрибут. В інших прикладах вони використовували XmlArray тощо, які не потрібні до тих пір, поки у нас властивість визначена як громадська машина [] Автомобілі {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 в рядку, тому я міг би його конденсувати до цього: `загальнодоступний статичний T LoadXMLFileIntoClass <T> (рядок xmlData)` {`XmlSerializer serializer = новий XmlSerializer (typeof (T)); `serializer return (T). Десеріалізація (новий 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 Перевірте цей приклад для багаторівневої десеріалізації


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

1

Ви можете просто змінити один атрибут власності автомобіля для автомобілів з 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"


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

1
Будь ласка, завжди вкладайте свою відповідь у контекст, а не просто вставляючи код. Дивіться тут для більш детальної інформації
gehbiszumeis
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.