C#实现实体类和XML相互转换

让我来为大家详细讲解C#实现实体类和XML相互转换的完整攻略。

1. 为什么要进行实体类和XML转换

在许多实际开发中，我们需要将对象或实体类转换成XML格式，或者将XML转换成相应的对象或实体类。常见的场景包括将数据存储到XML文件中，或者将XML文件序列化为对象，以便于进行数据传输、存储和处理等操作。

2. 实现实体类和XML相互转换的核心模块

C#中提供了许多用于实体类和XML相互转换的工具和类库，其中最常用的即为System.Xml.Serialization命名空间和XmlSerializer类。

2.1 System.Xml.Serialization命名空间

System.Xml.Serialization命名空间用于将对象或实体类转换为XML格式数据，或者将XML格式数据转换成相应的对象或实体类。其中主要包括以下常用类：

• XmlSerializer：XmlSerializer类是实现XML序列化和XML反序列化的核心类，它提供了将对象序列化为XML字符串或将XML字符串反序列化为对象或实体类的功能。
• XmlAttribute：XmlAttribute类用于定义XML属性，它可应用于类、结构体、字段、属性和方法等元素，用于指定每个元素在XML序列化和反序列化时所对应的XML节点。
• XmlElement：XmlElement类用于定义XML元素，它可应用于类、结构体、字段、属性和方法等元素，用于指定每个元素在XML序列化和反序列化时所对应的XML节点。

2.2 XmlSerializer类

XmlSerializer类提供了XML序列化和反序列化的核心功能，它提供了如下重载方法：

• Serialize：将对象序列化为XML字符串；
• Deserialize：将XML字符串反序列化为对象或实体类。

常用的基本用法如下：

//创建XmlSerializer对象
XmlSerializer serializer = new XmlSerializer(typeof(对象或实体类类型));
//将对象序列化为XML字符串
using (StringWriter writer = new StringWriter())
{
    serializer.Serialize(writer, 对象或实体类对象);
    string xmlString = writer.ToString();
}
//将XML字符串反序列化为对象或实体类
using (StringReader reader = new StringReader(xmlString))
{
    对象或实体类对象 = (对象或实体类类型)serializer.Deserialize(reader);
}

3. 示例说明

下面分别通过实体类和XML字符串相互转换的两个示例来具体说明以上内容。

3.1 示例1：实体类与XML字符串相互转换

假设我们有一个Person类，包含了姓名(string)、年龄(int)和地址(string)属性，如下：

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Address { get; set; }
}

现在我们需要将该类实例序列化为XML字符串并输出，再将该XML字符串反序列化为Person对象。

//创建Person对象
Person person = new Person
{
    Name = "张三",
    Age = 23,
    Address = "上海市黄浦区南京东路1号"
};
//创建XmlSerializer对象
XmlSerializer serializer = new XmlSerializer(typeof(Person));
//将Person对象序列化为XML字符串
using (StringWriter writer = new StringWriter())
{
    serializer.Serialize(writer, person);
    string xmlString = writer.ToString();
    Console.WriteLine(xmlString);
}
//将XML字符串反序列化为Person对象
using (StringReader reader = new StringReader(xmlString))
{
    Person newPerson = (Person)serializer.Deserialize(reader);
    Console.WriteLine(newPerson.Name + " " + newPerson.Age + " " + newPerson.Address);
}

代码执行结果如下：

<?xml version="1.0" encoding="utf-16"?>
<Person xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>张三</Name>
  <Age>23</Age>
  <Address>上海市黄浦区南京东路1号</Address>
</Person>
张三 23 上海市黄浦区南京东路1号

从上述示例中，可以看出实体类和XML字符串之间的转换过程：先创建一个XmlSerializer对象，然后通过其Serialize方法将实体类序列化为XML字符串，再通过其Deserialize方法将XML字符串反序列化为实体类。

3.2 示例2：XML字符串与实体类相互转换

假设现在我们已经获得一个Person实体类对应的XML字符串，如下：

<Person xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><Name>李四</Name><Age>27</Age><Address>北京市东城区王府井大街</Address></Person>

我们需要将该XML字符串反序列化为Person对象。

//创建XmlSerializer对象
XmlSerializer serializer = new XmlSerializer(typeof(Person));
//将XML字符串反序列化为Person对象
using (StringReader reader = new StringReader(xmlString))
{
    Person newPerson = (Person)serializer.Deserialize(reader);
    Console.WriteLine(newPerson.Name + " " + newPerson.Age + " " + newPerson.Address);
}

代码执行结果如下：

李四 27 北京市东城区王府井大街

从上述示例中，可以看出XML字符串和实体类之间的转换过程：先创建一个XmlSerializer对象，然后通过其Deserialize方法将XML字符串反序列化为实体类。

4. 总结

通过上述示例，我们可以看出C#实现实体类和XML相互转换的过程非常简单。我们需要使用System.Xml.Serialization命名空间下的XmlSerializer类，通过其Serialize和Deserialize方法将实体类和XML字符串相互转换。其中，实体类需要满足可序列化的要求，即类需要声明为public、有一个无参构造函数、每个字段、属性或事件需要用Serializable属性标注等。