Преобразовать строку XML в объект - PullRequest
Новая
       75

Преобразовать строку XML в объект

154 голосов
/ 06 июля 2010

Я получаю строки XML через сокет и хочу преобразовать их в объекты C #.

Сообщения имеют вид: 

<msg>
   <id>1</id>
   <action>stop</action>
</msg>

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

Ответы [ 12 ]

250 голосов
/ 06 июля 2010

Вам необходимо использовать инструмент xsd.exe, который устанавливается вместе с Windows SDK в каталог, похожий на: 

C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin

И на 64-битных компьютерах: 

C:\Program Files (x86)\Microsoft SDKs\Windows\v6.0A\bin

И на компьютерах с Windows 10: 

C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin

При первом запуске вы используете xsd.exe и преобразуете свой образец XML в файл XSD (файл схемы XML): 

xsd yourfile.xml

Это дает вам yourfile.xsd, который на втором шаге вы можете снова преобразовать с помощью xsd.exe в класс C #: 

xsd yourfile.xsd /c

Это должно дать вам файл yourfile.cs, который будет содержать класс C #, который вы можете использовать для десериализации получаемого вами XML-файла - что-то вроде: 

XmlSerializer serializer = new XmlSerializer(typeof(msg));
msg resultingMessage = (msg)serializer.Deserialize(new XmlTextReader("yourfile.xml"));

В большинстве случаев должно работать очень хорошо.

Обновление: XML-сериализатор будет принимать любой поток в качестве входных данных - либо файл, либо поток памяти будет в порядке: 

XmlSerializer serializer = new XmlSerializer(typeof(msg));
MemoryStream memStream = new MemoryStream(Encoding.UTF8.GetBytes(inputString));
msg resultingMessage = (msg)serializer.Deserialize(memStream);

или используйте StringReader: 

XmlSerializer serializer = new XmlSerializer(typeof(msg));
StringReader rdr = new StringReader(inputString);
msg resultingMessage = (msg)serializer.Deserialize(rdr);
196 голосов
/ 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+ с .Net Framework> = 4.5 в качестве цели проекта

  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>();
45 голосов
/ 06 июля 2010

Попробуйте этот метод для преобразования Xml в объект.Это сделано именно для того, что вы делаете: 

protected T FromXml<T>(String xml)
{
    T returnedXmlClass = default(T);

    try
    {
        using (TextReader reader = new StringReader(xml))
        {
            try
            {
                returnedXmlClass = 
                    (T)new XmlSerializer(typeof(T)).Deserialize(reader);
            }
            catch (InvalidOperationException)
            {
                // String passed is not XML, simply return defaultXmlClass
            }
        }
    }
    catch (Exception ex)
    {
    }

    return returnedXmlClass ;        
}

Позвоните, используя этот код: 

YourStrongTypedEntity entity = FromXml<YourStrongTypedEntity>(YourMsgString);
11 голосов
/ 12 июня 2014

Просто запустите Visual Studio 2013 от имени администратора ... Скопируйте содержимое вашего XML-файла. Перейдите в Visual Studio 2013> Правка> Специальная вставка> Вставить XML как классы C # Он создаст ваши классы c # в соответствии с содержимым вашего XML-файла.

6 голосов
/ 02 февраля 2017

На всякий случай, если кто-нибудь найдет это полезным: 

public static class XmlConvert
{
    public static string SerializeObject<T>(T dataObject)
    {
        if (dataObject == null)
        {
            return string.Empty;
        }
        try
        {
            using (StringWriter stringWriter = new System.IO.StringWriter())
            {
                var serializer = new XmlSerializer(typeof(T));
                serializer.Serialize(stringWriter, dataObject);
                return stringWriter.ToString();
            }
        }
        catch (Exception ex)
        {
            return string.Empty;
        }
    }

    public static T DeserializeObject<T>(string xml)
         where T : new()
    {
        if (string.IsNullOrEmpty(xml))
        {
            return new T();
        }
        try
        {
            using (var stringReader = new StringReader(xml))
            {
                var serializer = new XmlSerializer(typeof(T));
                return (T)serializer.Deserialize(stringReader);
            }
        }
        catch (Exception ex)
        {
            return new T();
        }
    }
}

Вы можете позвонить, используя: 

MyCustomObject myObject = new MyCustomObject();
string xmlString = XmlConvert.SerializeObject(myObject)
myObject = XmlConvert.DeserializeObject<MyCustomObject>(xmlString);
2 голосов
/ 16 февраля 2017

Вы можете создать класс, как описано выше, или написать их вручную: 

[XmlRoot("msg")]
public class Message
{
    [XmlElement("id")]
    public string Id { get; set; }
    [XmlElement("action")]
    public string Action { get; set; }
}

Затем вы можете использовать ExtendedXmlSerializer для сериализации и десериализации.

Установка Вы можете установить ExtendedXmlSerializer из nuget или выполнить следующую команду: 

Install-Package ExtendedXmlSerializer

Сериализация: 

var serializer = new ConfigurationContainer().Create();
var obj = new Message();
var xml = serializer.Serialize(obj);

Десериализация 

var obj2 = serializer.Deserialize<Message>(xml);

Эта поддержка сериализатора:

  • Десериализация XML из стандартного XMLSerializer
  • Класс сериализации, структура, универсальныйкласс, тип примитива, общий список и словарь, массив, перечисление
  • класс сериализации с интерфейсом свойств
  • циклическая ссылка сериализации и идентификационный номер ссылки
  • десериализация старой версии xml
  • Шифрование свойств
  • Пользовательский сериализатор
  • Поддержка XmlElementAttribute и XmlRootAttribute
  • POCO - все конфигурации (миграции, пользовательский сериализатор ...) отсутствуютПоддержка класса

ExtendedXmlSerializer .NET 4.5 или выше и .NET Core .Вы можете интегрировать его с WebApi и AspCore.

2 голосов
/ 06 июля 2010

Вы можете использовать xsd.exe для создания классов с привязкой к схеме в .Net, а затем XmlSerializer для десериализации строки: http://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.deserialize.aspx

0 голосов
/ 27 февраля 2019

Другой способ с расширенными инструментами генерации классов xsd to c #: xsd2code.com. Этот инструмент очень удобный и мощный. Он имеет гораздо больше настроек, чем инструмент xsd.exe из Visual Studio. Xsd2Code ++ может быть настроен для использования списков или массивов и поддерживает большие схемы с большим количеством операторов импорта.

Примечание о некоторых функциях,

  • Генерирует бизнес-объекты из схемы XSD или файла XML для гибкого C # или код Visual Basic.
  • Поддержка Framework 2.0 до 4.x
  • Поддержка строго типизированной коллекции (List, ObservableCollection, MyCustomCollection).
  • Поддержка автоматических свойств.
  • Создание методов чтения и записи XML (сериализация / десериализация).
  • Поддержка привязки данных (WPF, Xamarin).
  • WCF (атрибут DataMember).
  • Поддержка кодировки XML (UTF-8/32, ASCII, Unicode, Custom).
  • Чехол для верблюда / Pascal Case.
  • поддержка ограничений ([StringLengthAttribute = true / false], [RegularExpressionAttribute = true / false], [RangeAttribute = истина / ложь]).
  • Поддержка большого и сложного файла XSD.
  • Поддержка ядра DotNet и стандарта
0 голосов
/ 08 августа 2018

Упрощение великого ответа Дамиана, 

public static T ParseXml<T>(this string value) where T : class
{
    var xmlSerializer = new XmlSerializer(typeof(T));
    using (var textReader = new StringReader(value))
    {
        return (T) xmlSerializer.Deserialize(textReader);
    }
}
0 голосов
/ 14 ноября 2011 
public string Serialize<T>(T settings)
{
    XmlSerializer serializer = new XmlSerializer(typeof(T));
    StringWriter outStream = new StringWriter();
    serializer.Serialize(outStream, settings);
    return outStream.ToString();
}
Страница:
...