将 XML 字符串转换为对象

Question

我正在通过套接字接收 XML 字符串，并希望将它们转换为 C# 对象。

消息的形式如下：

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

这怎么办？

Answer 1

您需要使用 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，在第二步中，您可以再次转换该文件在 C# 类中使用 xsd.exe：

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

Answer 2

你有两种可能性。

方法1.XSD工具

---

Suppose that you have your XML file in this location C:\path\to\xml\file.xml

1. 打开开发者命令提示符
   您可以在开始菜单>中找到它节目>微软 Visual Studio 2012 > Visual Studio 工具
   或者，如果您使用的是 Windows 8，只需在“开始”屏幕中输入“开发人员命令提示符”，即可
2. 通过输入 cd /D "C:\path 将位置更改为 XML 文件目录\to\xml"
3. 通过键入 xsd file.xml 从 xml 文件创建 XSD 文件
4. 通过键入 创建 C# 类 >xsd /c file.xsd

就是这样！您已从 C:\path\to\xml\file.cs 中的 xml 文件生成了 C# 类

方法 2 - 粘贴特殊

---

Required Visual Studio 2012+ with .Net Framework >= 4.5 as project target and 'Windows Communication Foundation' individual component installed

1. 内容 将 XML 文件的内容复制到剪贴板
2. 添加到您的解决方案 新的空类文件(Shift+Alt+C)
3. 打开该文件，然后在菜单中单击 Edit >粘贴特殊>将 XML 粘贴为类
   

就是这样！

使用

---

这个辅助类的用法非常简单：

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

Answer 3

尝试使用此方法将 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);

Answer 4

只需以管理员身份运行 Visual Studio 2013 ...
复制 Xml 文件的内容。
转到 Visual Studio 2013 >编辑>选择性粘贴>将 Xml 粘贴为 C# 类
它将根据您的 Xml 文件内容创建您的 C# 类。

Answer 5

以防万一有人可能会发现这很有用：

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

Answer 6

您可以按照上面的描述生成类，或者手动编写它们：

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

然后您可以使用 ExtendedXmlSerializer 进行序列化和反序列化。

安装
您可以从 nuget 安装 ExtendedXmlSerializer 或运行以下命令：

Install-Package ExtendedXmlSerializer

序列化：

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

反序列化

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

此序列化器支持：

• 从标准 XMLSerializer 反序列化 xml
• 序列化类、结构、泛型类、基元类型、泛型列表和字典、数组、枚举
• 具有属性接口
• 序列化 的序列化类循环引用和引用 Id
• 旧版本 xml 的反序列化
• 属性加密
• 自定义序列化程序
• 支持 XmlElementAttribute 和 XmlRootAttribute
• POCO - 所有配置（迁移、自定义序列化程序...）均位于类之外

ExtendedXmlSerializer 支持 .NET 4.5 或更高版本和.NET Core。您可以将其与 WebApi 和 AspCore 集成。

Answer 7

您可以使用 xsd.exe 在 .Net 中创建架构绑定类，然后使用 XmlSerializer 反序列化字符串：http://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.deserialize.aspx

Answer 8

简化达米安的精彩答案，

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

Answer 9

我已经浏览了截至目前（2020-07-24）的所有答案，并且必须有一种更简单更熟悉的方法来解决这个问题，如下所示。

两种情况... 一种情况是 XML 字符串格式良好，即它以 ）之前，输入“utf-16”？> 或其类似内容。另一种是如果它格式不正确，即只有根元素（例如问题中的）及其子节点。

首先，只是一个简单的类，其中包含与 XML 中根节点的子节点（不区分大小写的名称）相匹配的属性。所以，从问题来看，它会是这样的......

public class TheModel
{
    public int Id { get; set; }
    public string Action { get; set; }
}

以下是代码的其余部分......

// These are the key using statements to add.
using Newtonsoft.Json;
using System.Xml;

bool isWellFormed = false;
string xml =  = @"
<msg>
   <id>1</id>
   <action>stop</action>
</msg>
";

var xmlDocument = new XmlDocument();
xmlDocument.LoadXml(xml);
if (isWellFormed)
{
    xmlDocument.RemoveChild(xmlDocument.FirstChild); 
    /* i.e. removing the first node, which is the declaration part. 
    Also, if there are other unwanted parts in the XML, 
    write another similar code to locate the nodes 
    and remove them to only leave the desired root node 
    (and its child nodes).*/
}

var serializedXmlNode = JsonConvert.SerializeXmlNode(
            xmlDocument, 
            Newtonsoft.Json.Formatting.Indented, 
            true
            );
var theDesiredObject = JsonConvert.DeserializeObject<TheModel>(serializedXmlNode);

Answer 10

我知道这个问题很老了，但是我偶然发现了它，并且我有一个与其他人不同的答案:-)

通常的方法（正如上面的评论者提到的）是生成一个类并反序列化你的xml。

但是（警告：这里无耻的自我推销）我刚刚发布了一个 nuget 包，这里，您不必这样做。你只需走：

string xml = System.IO.File.ReadAllText(@"C:\test\books.xml");
var book = Dandraka.XmlUtilities.XmlSlurper.ParseText(xml);

就是这样，不需要其他任何东西。而且，最重要的是，如果您的 xml 发生更改，您的对象也会自动更改。

如果您希望直接下载 dll，则 github 页面位于此处。

Answer 11

创建 DTO 作为 CustomObject

使用以下方法使用 JAXB 将 XML 字符串转换为 DTO

private static CustomObject getCustomObject(final String ruleStr) {
    CustomObject customObject = null;
    try {
        JAXBContext jaxbContext = JAXBContext.newInstance(CustomObject.class);
        final StringReader reader = new StringReader(ruleStr);
        Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
        customObject = (CustomObject) jaxbUnmarshaller.unmarshal(reader);
    } catch (JAXBException e) {
        LOGGER.info("getCustomObject parse error: ", e);
    }
    return customObject;
}

Answer 12

如果您有 xml 消息的 xsd，则可以使用 .Net xsd.exe 工具生成 C# 类。

然后可以使用该 .Net 类生成 xml。

Answer 13

除了此处的其他答案之外，您自然可以使用 XmlDocument< /a> 类，用于类似 XML DOM 的读取，或 XmlReader，仅快进阅读器，“手动”完成。

Answer 14

另一种使用高级 xsd 到 c# 类生成工具的方法：xsd2code.com。这个工具非常方便且功能强大。它比 Visual Studio 中的 xsd.exe 工具具有更多的自定义功能。 Xsd2Code++ 可以自定义为使用列表或数组，并支持具有大量 Import 语句的大型模式。

注意一些功能，

• 从 XSD 架构或 XML 文件生成业务对象到灵活的 C#
  或 Visual Basic 代码。
• 支持 Framework 2.0 到 4.x
• 支持强类型集合（List、ObservableCollection、MyCustomCollection）。
• 支持自动属性。
• 生成XML读写方法（序列化/反序列化）。
• 数据绑定支持（WPF、Xamarin）。
• WCF（数据成员属性）。
• XML 编码支持（UTF-8/32、ASCII、Unicode、自定义）。
• 支持驼峰式/帕斯卡式。
• 限制支持（[StringLengthAttribute=true/false]、[RegularExpressionAttribute=true/false]、
  [RangeAttribute=true/false]）。
• 支持大型且复杂的 XSD 文件。
• 支持 DotNet Core 和 DotNet Core标准

Answer 15

public string Serialize<T>(T settings)
{
    XmlSerializer serializer = new XmlSerializer(typeof(T));
    StringWriter outStream = new StringWriter();
    serializer.Serialize(outStream, settings);
    return outStream.ToString();
}