文档章节

C# XML序列化方法和常用特性

深圳大道
 深圳大道
发布于 2016/12/29 15:38
字数 990
阅读 5
收藏 0
/*
C#对象XML序列化(一):序列化方法和常用特性

.Net Framework提供了对应的System.Xml.Seriazliation.XmlSerializer负责把对象序列化到XML,和从XML中反序列化为对象。Serializer的使用比较直观,需要多注意的是XML序列化相关的Attribute,怎么把这些attribute应用到我们的对象,以及对象公共属性上面去,生成满足预期格式的XML。
本文列出了最常用的方法和特性,涵盖日常大部分的转换工作,希望大家在工作中快速上手。为了给大家直观的印象,这里给出具体的使用代码,为了节省篇幅,代码异常处理没有添加,各位同学使用的时候酌情添加。

1. Serializer方法
下面的方法封装了XmlSerializer的调用,这里列出了参数最全的一个版本,具体使用的时候需适当添加重载:
*/
public static class XmlSerializer
{
	public static void SaveToXml(string filePath, object sourceObj, Type type, string xmlRootName)
	{
		if (!string.IsNullOrWhiteSpace(filePath) && sourceObj != null)
		{
			type = type != null ? type : sourceObj.GetType();

			using (StreamWriter writer = new StreamWriter(filePath))
			{
				System.Xml.Serialization.XmlSerializer xmlSerializer = string.IsNullOrWhiteSpace(xmlRootName) ?
					new System.Xml.Serialization.XmlSerializer(type) :
					new System.Xml.Serialization.XmlSerializer(type, new XmlRootAttribute(xmlRootName));
				xmlSerializer.Serialize(writer, sourceObj);
			}
		}
	}

	public static object LoadFromXml(string filePath, Type type)
	{
		object result = null;

		if (File.Exists(filePath))
		{
			using (StreamReader reader = new StreamReader(filePath))
			{
				System.Xml.Serialization.XmlSerializer xmlSerializer = new System.Xml.Serialization.XmlSerializer(type);
				result = xmlSerializer.Deserialize(reader);
			}
		}

		return result;
	}
}

/*
2. 序列化常用Attribute讲解说明:
*/
[XmlRootAttribute("MyCity", Namespace="abc.abc", IsNullable=false)]     // 当该类为Xml根节点时,以此为根节点名称。
public class City

[XmlAttribute("AreaName")]    // 表现为Xml节点属性。<... AreaName="..."/>
public string Name

[XmlElementAttribute("AreaId", IsNullable = false)]    // 表现为Xml节点。<AreaId>...</AreaId>
public string Id

[XmlArrayAttribute("Areas")]    // 表现为Xml层次结构,根为Areas,其所属的每个该集合节点元素名为类名。<Areas><Area ... /><Area ... /></Areas>
public Area[] Areas

[XmlElementAttribute("Area", IsNullable = false)]    // 表现为水平结构的Xml节点。<Area ... /><Area ... />...
public Area[] Areas

[XmlIgnoreAttribute]    // 忽略该元素的序列化。

/*
3. 详细举例说明
这里用简单的城市,区域和街区作为例子,具体示范一下上面的规则。
*/
[XmlRootAttribute("MyCity", Namespace = "abc.abc", IsNullable = false)]
public class City
{
	[XmlAttribute("CityName")] 
	public string Name
	{
		get;
		set;
	}

	[XmlAttribute("CityId")] 
	public string Id
	{
		get;
		set;
	}

	[XmlArrayAttribute("Areas")]
	public Area[] Areas
	{
		get;
		set;
	}
}

[XmlRootAttribute("MyArea")]
public class Area
{
	[XmlAttribute("AreaName")] 
	public string Name
	{
		get;
		set;
	}

	[XmlElementAttribute("AreaId", IsNullable = false)]
	public string Id
	{
		get;
		set;
	}

	[XmlElementAttribute("Street", IsNullable = false)]
	public string[] Streets
	{
		get;
		set;
	}
}

/*
根据以上类型,我们mock一些数据,然后用步骤1给出的Util方法输出:
*/
static void Main(string[] args)
{
	Area area1 = new Area();
	area1.Name = "Pudong";
	area1.Id = "PD001";
	area1.Streets = new string [] { "street 001", "street 002" };
	Area area2 = new Area();
	area2.Name = "Xuhui";
	area2.Id = "XH002";
	area2.Streets = new string [] { "street 003", "street 004" };

	City city1 = new City();
	city1.Name = "Shanghai";
	city1.Id = "SH001";
	city1.Areas = new Area[] { area1, area2 };

	XmlSerializer.SaveToXml(@"C:\temp\XML\output003.xml", city1);
}

/*
最终输出的XML为:
*/
<?xml version="1.0" encoding="utf-8"?>
<MyCity xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        CityName="Shanghai" CityId="SH001" xmlns="abc.abc">
  <Areas>
    <Area AreaName="Pudong">
      <AreaId>PD001</AreaId>
      <Street>street 001</Street>
      <Street>street 002</Street>
    </Area>
    <Area AreaName="Xuhui">
      <AreaId>XH002</AreaId>
      <Street>street 003</Street>
      <Street>street 004</Street>
    </Area>
  </Areas>
</MyCity>

/*
下面我们开始具体分析结果,其中包含一些很有用的结论和注意事项:
1. xml的版本,编码,以及命名空间xmlns:xsi,xmlns:xsd为Framework自动添加。

2. 因为我们用City对象作为根节点,所以根节点名称为我们定义的"MyCity"。
但是,注意!这里指的是用City自身直接做根节点,如果是City集合比如City[],此时,该名称失效,系统会自动生成名称ArrayOfCity作为根节点名称(ArrayOf+类名),或者我们手动指定名称,这个就是在给大家的SaveToXml()方法中,参数xmlRootName的作用。

3. 如果以City为根节点并在XmlRootAttribute特性中给定名称,同时也手动指定了xmlRootName,系统会以手动指定的名称为准。

4. AreaName,AreaId,同为Area类的公共属性,一个被解释成属性,一个被解释成子节点。
Areas集合被解释成了层次结构,Streets集合被解释成了水平结构。
这两组区别最能体现不同序列化Attribute的用法。
*/

本文转载自:http://blog.csdn.net/smartsmile2012/article/details/43791955

深圳大道
粉丝 3
博文 877
码字总数 0
作品 0
深圳
架构师
私信 提问
.NET对象的XML序列化和反序列化

序列化的概念 序列化是指一个对象的实例可以被保存,保存成一个二进制串,当然,一旦被保存成二进制串,那么也可以保存成文本串了。 比如,一个计数器,数值为2,我们可以用字符串“2”表示。...

王二狗子11
2017/12/26
0
0
C# xml和对象的序列化与反序列化

为什么要做序列化和反序列化? .Net程序执行时,对象都驻留在内存中;内存中的对象如果需要传递给其他系统使用;或者在关机时需要保存下来以便下次再次启动程序使用就需要序列化和反序列化。...

KavenSu
2014/02/21
659
0
.NET 中的序列化 & 反序列化

序列化:将对象的状态信息及类型信息,转换为一种易于传输或存储形式(流,即字节序列)的过程。 下图为序列化过程图示,图片来自微软官方文档: 反序列化:与序列化相反,将流转换为对象的过...

雪飞鸿
01/28
0
0
XmlSerializer 对象的Xml序列化和反序列化

这篇随笔对应的.Net命名空间是System.Xml.Serialization;文中的示例代码需要引用这个命名空间。 为什么要做序列化和反序列化? .Net程序执行时,对象都驻留在内存中;内存中的对象如果需要传...

长平狐
2012/06/08
227
0
C#强化系列文章七:序列化和反序列化

序列化和反序列化我们可能经常会听到,其实通俗一点的解释,序列化就是把一个对象保存到一个文件或数据库字段中去,反序列化就是在适当的时候把这个文件再转化成原来的对象使用。 我想最主要...

橘子红了呐
2017/11/05
0
0

没有更多内容

加载失败,请刷新页面

加载更多

前端面试题汇总

一. HTML常见的兼容性 1.HTML5 标签在低版本浏览器不兼容 解决办法:使用html5shiv库,引入下列语句 <!--[if lte IE 8]> <script src="https://cdn.bootcss.com/html5shiv/r29/html5.js"></sc......

蓝小驴
31分钟前
7
0
OSChina 周四乱弹 —— 我气的脸都黑了!

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 小小编辑推荐《Red Battle》- 高橋李依 / 豊崎愛生 《Red Battle》- 高橋李依 / 豊崎愛生 手机党少年们想听歌,请使劲儿戳(这里) @丶Lion ...

小小编辑
44分钟前
589
22
找OSG教程, B站就有

https://www.bilibili.com/video/av64849038?from=search&seid=11632913960900279653

洛克人杰洛
今天
5
0
学习记录(day07-Vue组件、自定义属性、自定义事件)

[TOC] 1.1.1什么是组件 一个vue文件就是一个组件 组件将html标签/css样式/对应JS打包成一个整体,也可以理解钻进一个具有样式和特效的自定义标签。 一、编写组件(提供方)<template> <di...

庭前云落
今天
5
0
使用Prometheus监控SpringBoot应用

通过之前的文章我们使用Prometheus监控了应用服务器node_exporter,数据库mysqld_exporter,今天我们来监控一下你的应用。(本文以SpringBoot 2.1.9.RELEASE 作为监控目标) 编码 添加依赖 使...

JAVA日知录
今天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部