谈谈对象和XML文件的转换

开发
本文介绍三种方式操作XML,普通的XDocument的API操作,方便的XmlSerializer对象序列化及反序列化操作,加密XML对象序列化操作。

很多时候,我们开发程序都需要使用到对象的XML序列化和反序列化,对象的XML序列化和反序列化,既可以使用XML对象(XmlDocument )进行操作,也可以使用XmlSerializer进行操作,两个各有优点,就操作性而已,我倾向于使用后者来操作XML。

本文介绍三种方式操作XML,普通的XDocument的API操作,方便的XmlSerializer对象序列化及反序列化操作,加密XML对象序列化操作。

1、普通的XML对象操作,利用XML对象(XmlDocument )。

一个典型的利用XmlDocument对象操作XML的例子代码如下。

  1. public static void RunSnippet()  
  2.     {  
  3.         XmlDocument xmldoc = new XmlDocument ( ) ;  
  4.     //加入XML的声明段落  
  5.     XmlNode xmlnode = xmldoc.CreateNode ( XmlNodeType.XmlDeclaration , "" , "" ) ;  
  6.     xmldoc.AppendChild (xmlnode ) ;  
  7.     //加入一个根元素  
  8.     XmlElement xmlelem = xmldoc.CreateElement ( "" , "ROOT" , "" ) ;  
  9.     XmlText xmltext = xmldoc.CreateTextNode ( "Root Text" ) ;  
  10.     xmlelem.AppendChild ( xmltext ) ;  
  11.     xmldoc.AppendChild ( xmlelem ) ;  
  12.     //加入另外一个元素  
  13.     XmlElement xmlelem2 = xmldoc.CreateElement ("SampleElement" ) ;  
  14.     xmlelem2 = xmldoc.CreateElement ( "" , "SampleElement" , "" ) ;  
  15.     xmltext = xmldoc.CreateTextNode ( "The text of the sample element" ) ;  
  16.     xmlelem2.AppendChild ( xmltext ) ;  
  17.     xmldoc.ChildNodes.Item(1).AppendChild ( xmlelem2 ) ;  
  18.     //保存创建好的XML文档  
  19.     try 
  20.     {  
  21.       xmldoc.Save ( "c:\\data.xml" ) ;  
  22.     }  
  23.     catch ( Exception e )  
  24.     {  
  25.       //显示错误信息  
  26.       Console.WriteLine ( e.Message ) ;  
  27.     }  
  28.     Console.ReadLine ( ) ;  
  29.     } 

得到的输出结果如下所示。

  1. <?xml version="1.0"?>  
  2. <ROOT>Root Text  
  3.     <SampleElement>The text of the sample element</SampleElement>  
  4. </ROOT> 

#p#

2、使用XmlSerializer进行XML操作

先提供两个对象的序列化和反序列化的封装函数,如下所示。

  1. /// <summary>  
  2.         /// 对象序列化XML到文件中  
  3.         /// </summary>  
  4.         /// <param name="path">文件路径</param>  
  5.         /// <param name="obj">对象</param>  
  6.         /// <param name="type">对象类型</param>  
  7.         private bool XmlSerialize(string path, object obj, Type type)  
  8.         {  
  9.             XmlSerializerNamespaces ns = new XmlSerializerNamespaces();  
  10.             ns.Add("""");  
  11.  
  12.             try 
  13.             {  
  14.                 //如果文件目录不存在,那么创建目录  
  15.                 if (!File.Exists(path))  
  16.                 {  
  17.                     FileInfo fi = new FileInfo(path);  
  18.                     if (!fi.Directory.Exists)  
  19.                     {  
  20.                         Directory.CreateDirectory(fi.Directory.FullName);  
  21.                     }  
  22.                 }  
  23.  
  24.                 using (Stream stream = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.None))  
  25.                 {  
  26.                     XmlSerializer format = new XmlSerializer(type);  
  27.  
  28.                     format.Serialize(stream, obj, ns);  
  29.                     stream.Close();  
  30.                 }  
  31.  
  32.                 return true;  
  33.             }  
  34.             catch (Exception ex)  
  35.             {  
  36.                 Console.WriteLine(ex.Message);  
  37.                 return false;  
  38.             }  
  39.         }  
  40.  
  41.         /// <summary>  
  42.         /// XML反序列化  
  43.         /// </summary>  
  44.         /// <param name="path">文件路径</param>  
  45.         /// <param name="type">对象类型</param>  
  46.         /// <returns></returns>  
  47.         private object XmlDeserialize(string path, Type type)  
  48.         {  
  49.             try 
  50.             {  
  51.                 using (Stream stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read))  
  52.                 {  
  53.                     XmlSerializer formatter = new XmlSerializer(type);  
  54.                     stream.Seek(0, SeekOrigin.Begin);  
  55.                     object obj = formatter.Deserialize(stream);  
  56.                     stream.Close();  
  57.                     return obj;  
  58.                 }  
  59.             }  
  60.             catch 
  61.             {  
  62.                 return null;  
  63.             }  
  64.         } 

注意其中代码       

  1. XmlSerializerNamespaces ns = new XmlSerializerNamespaces();  
  2. ns.Add("", ""); 

是把默认的xmlns命名空间多余的内容去掉,这样得到比较干净的XML。

在使用的时候,我们需要定义好对象的实体,这样才能给予对象进行操作,定义的实体类如下所示。

  1. [Serializable]  
  2.     public class UserInfo  
  3.     {                  
  4.         public string ID { get; set; }  
  5.         public string UserNo{ get; set; }  
  6.         public string UserName { get; set; }  
  7.         public string Sex { get; set; }  
  8.         public string Birthday { get; set; }  
  9.     }  
  10.  
  11.     [Serializable]  
  12.     public class DataOfUser  
  13.     {  
  14.         [XmlElement(ElementName = "m_User")]  
  15.         public List<UserInfo> list = new List<UserInfo>();  
  16.     } 

调用序列化函数的代码例子如下所示

  1. private void btnUserNormal_Click(object sender, EventArgs e)  
  2.         {  
  3.             DataOfUser obj = new DataOfUser();  
  4.             UserInfo user = new UserInfo();  
  5.             user.ID=Guid.NewGuid().ToString();  
  6.             user.Sex = "男";  
  7.             user.UserName = "张三";  
  8.             user.UserNo = "20010001";  
  9.             user.Birthday = "1999-1-1";  
  10.             obj.list.Add(user);  
  11.  
  12.             user = new UserInfo();  
  13.             user.ID = Guid.NewGuid().ToString();  
  14.             user.Sex = "女";  
  15.             user.UserName = "李氏";  
  16.             user.UserNo = "20020001";  
  17.             user.Birthday = "1998-1-1";  
  18.             obj.list.Add(user);  
  19.  
  20.             try 
  21.             {  
  22.                 XmlSerialize("C:\\User.xml", obj, obj.GetType());  
  23.                 MessageUtil.ShowTips("Ok");  
  24.             }  
  25.             catch (Exception ex)  
  26.             {  
  27.                 MessageUtil.ShowError(ex.Message);  
  28.             }  
  29.         } 

这样得到的XML内容如下所示。

  1. <?xml version="1.0"?> 
  2. <DataOfUser> 
  3.   <m_User> 
  4.     <ID>f8a8b323-5c56-4c21-9ddf-1cd30f78dfca</ID> 
  5.     <UserNo>20010001</UserNo> 
  6.     <UserName>张三</UserName> 
  7.     <Sex></Sex> 
  8.     <Birthday>1999-1-1</Birthday> 
  9.   </m_User> 
  10.   <m_User> 
  11.     <ID>bbb36378-ec27-4e20-ad4b-2d2dc7e142e4</ID> 
  12.     <UserNo>20020001</UserNo> 
  13.     <UserName>李氏</UserName> 
  14.     <Sex></Sex> 
  15.     <Birthday>1998-1-1</Birthday> 
  16.   </m_User> 
  17. </DataOfUser> 

反序列化的操作也比较简单,不再赘述。

#p#

3)把对象实例化到XML中并进行加密处理

首先我们定义两个序列化加密、解码并反序列化的函数如下所示。

  1. /// <summary> 
  2.         /// XML序列化并加密  
  3.         /// </summary> 
  4.         /// <param name="path">文件路径</param> 
  5.         /// <param name="obj">对象</param> 
  6.         /// <param name="type">对象类型</param> 
  7.         /// <returns></returns> 
  8.         private bool XmlSerializeEncrypt(string path, object obj, Type type)  
  9.         {  
  10.             XmlSerializerNamespaces ns = new XmlSerializerNamespaces();  
  11.             ns.Add("", "");  
  12.  
  13.             try  
  14.             {  
  15.                 if (!File.Exists(path))  
  16.                 {  
  17.                     FileInfo fi = new FileInfo(path);  
  18.                     if (!fi.Directory.Exists)  
  19.                     {  
  20.                         Directory.CreateDirectory(fi.Directory.FullName);  
  21.                     }  
  22.                 }  
  23.  
  24.                 using (Stream stream = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.None))  
  25.                 {         
  26.                     string content = "";  
  27.                     using(MemoryStream ms = new MemoryStream())  
  28.                     {  
  29.                         XmlSerializer format = new XmlSerializer(type);  
  30.                         format.Serialize(ms, obj, ns);  
  31.                         ms.Seek(0, 0);  
  32.                         content = Encoding.UTF8.GetString(ms.ToArray());  
  33.                     }  
  34.  
  35.                     string encrypt = EncodeHelper.EncryptString(content);  
  36.                     byte[] bytes = Encoding.UTF8.GetBytes(encrypt);  
  37.                     stream.Write(bytes, 0, bytes.Length);  
  38.                     stream.Close();  
  39.                 }  
  40.                   
  41.  
  42.                 return true;  
  43.             }  
  44.             catch (Exception ex)  
  45.             {  
  46.                 Console.WriteLine(ex.Message);  
  47.                 return false;  
  48.             }  
  49.         }  
  50.  
  51.         /// <summary> 
  52.         /// 解密并进行XML反序列化  
  53.         /// </summary> 
  54.         /// <param name="path">文件路径</param> 
  55.         /// <param name="type">对象类型</param> 
  56.         /// <returns></returns> 
  57.         private object XmlDeserializeDecrypt(string path, Type type)  
  58.         {  
  59.             try  
  60.             {  
  61.                 string encrypt = File.ReadAllText(path, Encoding.UTF8);  
  62.                 string content = EncodeHelper.DecryptString(encrypt, true);  
  63.                 byte[] bytes = Encoding.UTF8.GetBytes(content);  
  64.                 using (MemoryStream stream = new MemoryStream(bytes))  
  65.                 {                    
  66.                     XmlSerializer formatter = new XmlSerializer(type);  
  67.                       
  68.                     stream.Seek(0, SeekOrigin.Begin);  
  69.                     object obj = formatter.Deserialize(stream);  
  70.                     stream.Close();  
  71.                     return obj;  
  72.                 }  
  73.             }  
  74.             catch(Exception ex)  
  75.             {  
  76.                 Console.WriteLine(ex.Message);  
  77.                 return null;  
  78.             }  
  79.         } 

这样函数定义好后,调用和前面没有加密的差不多,如下所示。

  1. private void btnUserEncrypt_Click(object sender, EventArgs e)  
  2.         {  
  3.             DataOfUser obj = new DataOfUser();  
  4.             UserInfo user = new UserInfo();  
  5.             user.ID = Guid.NewGuid().ToString();  
  6.             user.Sex = "男";  
  7.             user.UserName = "张三";  
  8.             user.UserNo = "20010001";  
  9.             user.Birthday = "1999-1-1";  
  10.             obj.list.Add(user);  
  11.  
  12.             user = new UserInfo();  
  13.             user.ID = Guid.NewGuid().ToString();  
  14.             user.Sex = "女";  
  15.             user.UserName = "李氏";  
  16.             user.UserNo = "20020001";  
  17.             user.Birthday = "1998-1-1";  
  18.             obj.list.Add(user);  
  19.  
  20.             try  
  21.             {  
  22.                 XmlSerializeEncrypt("C:\\User-Encrypt.xml", obj, obj.GetType());  
  23.                 MessageUtil.ShowTips("Ok");  
  24.             }  
  25.             catch (Exception ex)  
  26.             {  
  27.                 MessageUtil.ShowError(ex.Message);  
  28.             }  
  29.         }  
  30.  
  31.         private void btnUserDecrypt_Click(object sender, EventArgs e)  
  32.         {  
  33.             string file = FileDialogHelper.OpenFile();  
  34.             if (!string.IsNullOrEmpty(file))  
  35.             {  
  36.                 DataOfUser info = XmlDeserializeDecrypt(file, typeof(DataOfUser)) as DataOfUser;  
  37.                 if (info != null)  
  38.                 {  
  39.                     MessageUtil.ShowTips("OK");  
  40.                 }  
  41.             }  
  42.         } 
 

原文链接:http://www.cnblogs.com/wuhuacong/archive/2012/06/29/2569388.html

责任编辑:张伟 来源: 伍华聪的博客
相关推荐

2009-08-13 09:33:07

JavaBean到XM

2009-09-14 19:11:20

XML和Java Be

2009-06-23 14:22:00

DOM文档XML文件Java

2011-04-22 14:01:58

Artech类型转换

2020-10-22 08:01:52

XMLJSON转换

2016-10-11 15:42:08

2021-01-12 08:20:51

AndroidActivity系统

2009-09-08 16:55:01

Linq实现XML转换

2009-11-06 16:35:56

WCF Stream对

2010-09-16 14:37:54

DataSetXML

2024-09-03 10:06:43

JavaMap项目

2009-08-18 16:30:41

C# 操作XML

2021-01-18 08:52:28

Java对象多态

2012-03-26 11:32:45

Java

2011-03-30 15:16:27

VB.NET.NETXML

2017-11-09 15:38:26

OpenRTB 3.0演化

2016-09-09 12:51:23

PhxSQL原则局限性

2010-09-01 08:57:27

jQueryDOM对象

2009-09-09 14:45:41

XML序列化和反序列化

2009-09-09 15:47:27

XML序列化和反序列化
点赞
收藏

51CTO技术栈公众号