XML 序列化(Serialization) 转贴51dotnet

发表于:2007-06-30来源:作者:点击数: 标签:
XML 序列化(Serialization) 原著:Matthew Reynold (www.asptoday.com) 翻译整理:51DOTNET 俱乐部 会员:Lookuptable 本文得分:2000 (译者注:本文介绍了.NET中XML Serialization的概念和一个相应的简单的例子,同时也涉及了很多.NET中比较重要的概念,
XML 序列化(Serialization)


原著:Matthew Reynold (www.asptoday.com)

翻译整理:51DOTNET 俱乐部 会员:Lookuptable 本文得分:2000

    (译者注:本文介绍了.NET中XML Serialization的概念和一个相应的简单的例子,同时也涉及了很多.NET中比较重要的概念,如Stream,Reflection,服务器端控件的使用等,虽然并没有很详细地说明XML Serialization的实际用途,但我们也可以从文章和它的例子中得到很多启示。本文所带的例子用VS.NET打开时可能会有问题,所以最好是按照本文的讲述自己创建一个例子,以加深理解)

    在本文中,我们将一起了解一下XML的序列化(Serialization)。它是这样一个过程:得到一个对象,把对象转换为一个XML文档,并且保存它以供使用,或者把它传到网络上其他地方以供使用。在.NET中,XML serialization通过检查类的属性是否被标志为read/write来工作。只要有其中一个属性,该类的值就会被取出并插入到一个XML文档里去。反序列化(De-serialization)则是一个相反的过程。


    毫无疑问,.NET可以很方便的使用XML。在.NET中,使用XML Serialization需要做的就是把对象转化为一块XML,然后把它当作“流”(stream)传出去。随着对.NET的了解,你将会发现“流”这个比喻很贴切。比如如果要向磁盘写一个文件,需要打开一个文件流;也可以通过打开了一个网络流发送字节到另一台机器上。“流”的方法很简捷并且可以用在.NET开发中的很多方面,一旦你知道了一种“流”的使用办法,那么你就会很容易的掌握其他的使用方法。

.NET Framework中的XML Serialization

    当第一次看到XML Serialization的时候,我觉得它看起来很复杂。把一个对象转换为一个XML块,需要实例化一个XmlSerializer对象并把要转换的对象传给他。同样,把一个XML块转换为一个对象,我们也需要用XmlSerializer,只是这次我们需要传入一个XML而不是对象。

    多数情况下,你不必对要做序列化(serialize)的对象作任何改动。XmlSerializer检查对象的属性,并假设对象中任何可以read/write的属性都应该被包括在序列化过程中。然后它将像一个典型的客户程序一样调用这些属性。

    比如如果你的对象实现了一个read/write的属性叫做Name,那么XMLSerializer将调用该属性并把返回值插入到XML块中。当用XmlSerializer从一个XML块建立一个对象时,它将取出保存在XML块中的值并将其设置为对象的属性值。(这个过程是通过reflection实现的,我们在后面会谈到)

    作为一个典型的开发人员,当我第一次看到XML Serialization时,我觉得并不是很舒服。因为我觉得这就像个杂牌电脑一样。我认为它的过程应该是这样的:比如,XmlSerializer应该调用一个接口中的方法,该方法要求我提供需要插入到XML中的信息。事实上这的确是System.Runtime.Serialization名字空间中的ISerializable接口所做的工作。而实现ISerializable并不麻烦,相反使用XMLSerializer却是很繁琐的事。

    直到现在,我已经对XML Serialization有了很长时间的了解,我认识到它的功能确实很强大而且很值得去使用。对一个有经验的开发者来说,不用担心对其缺少控制,XML serialization为我们提供了一个很快捷的方法可以把对象压成一个流然后再把他们抽出来。

Reflection

    对于没有接触过的人来说,你会看到reflection是一个很强大的功能,在这个过程里,.NET Framework中的任何对象可以被检查并且可以决定它的属性,方法和事件。任何.NET中的对象都是从Object类中派生出来的,Object类包含了一个叫做GetType的方法,这个方法返回一个System.Type类型的对象,这个对象包含了一些方法如GetProperties和GetMethods,他们可以用来得到更多的关于对象的信息。
XmlSerializer简单的调用GetProperties方法返回一个PropertyInfo对象数组,数组中每一个值都描述了对象的一个属性。如果属性是read/write的,它就可以被包含在序列化中。

    ASPToday中有专门关于reflection的文章,此外如果感兴趣的话,你也可以在其他地方找到相关的资料。当然你也可以自己试一下Framework SDK中的ClsView例子。Reflection中最让人头疼的地方是emitting功能,它让你可以在运行时创建一个类然后在你的程序中使用这个类,就好像他们是正常的类一样。

试序列化

    为了测试一下我们的序列化,我们需要一个应用程序,其中应该包含一个用来转化为XML的类,并且可以再转化回来。我们用VB.NET/ASP.NET来做,首先创建一个新的Visual Basic – Web Application项目,针对本文,项目命名为Serialization,如果看一下代码,你会发现这会是一个很好的名字

    为了显示结果,我们在项目中创建一个包括一个text area的web form。我们要使用一个叫Book的对象,该对象包括name, ISBN Number以及author列表等属性。这个text area将用来显示由XmlSerializer产生的XML。 然后我们还可以修改产生的XML并且通过这个XML创建一个新的对象。(比如我们可以通过Public Beta把书的标题从Beginning E-commerce改成VB .NET Programming)。一旦我们得到了新的对象,我们要用一个简单的服务器端控件处理一下这个对象并显示。

创建Form


    首先我们需要创建一个form,打开ASPX页面的HTML视图做以下修改:
<%@ Page Language="vb" AutoEventWireup="false" Codebehind="WebForm1.vb"
Inherits="Serialization.WebForm1"%>
<html><head>
<meta name="GENERATOR" content="Microsoft Visual Studio .NET 7.0">
<meta name="CODE_LANGUAGE" content="Visual Basic 7.0"></head>
<body>

<form id="WebForm1" method="post" runat="server">
<textarea runat="server" id="xmlarea" cols="60" rows="15"></textarea>
<br>
<input runat="server" type="submit" value="Turn XML into an object!">
</form>

</body></html>

    请注意我们把text area元素的id属性设置为xmlarea。这将允许我们在VB代码中操纵该元素。通常我们用Value属性来得到或者设置元素所包含的文本内容。如果运行页面,我们可以得到以下结果:



    VS.NET的开发环境中有个问题:尽管我们已经把text area加入到页面中了,但有时候对xmlarea的引用并不会加入到WebForm1类的定义中。如果没有这个引用,我们将不能使用和处理该字段,因此我们也不能得到或者设置它的值。如果你打开WebForm1.vb的代码,应该可以看到下面这样的代码行
Public Class WebForm1
Inherits System.Web.UI.Page
Protected WithEvents xmlarea As System.Web.UI.HtmlControls.HtmlTextArea

如果这一行不在,那么你自己加上它。

创建Book类

    我们要使用的类叫做Book。开始我们先简单的使用类中的Name和ISBN属性。这里没什么特殊的,所以创建一个叫做Book的新类。
Imports System
Imports System.Collections

Public Class Book

Private m_Name As String
Private m_ISBN As String

Public Property Name() As String
Get
Return m_Name
End Get
Set
m_Name = Value
End Set
End Property

Public Property ISBN() As String
Get
Return m_ISBN
End Get
Set
m_ISBN = value
End Set
End Property
End Class



处理PreRender

    在处理输出页面上的窗体前,我们要确定xmlarea字段中包含了XML块。因此我们需要创建一个Book类的实例,设置Name和ISBN属性的默认值并调用XmlSerializer来序列化该对象。
当然我们需要先把对XmlSerializer的引用加到我们的项目中来。在Solution Explorer中,右击Reference并选择Add Reference。找到System.Xml.Serialization.dll,选中点击OK。




    在使用对象前,我们需要在WebForm1.vb的顶部再加上必要的引用:
Imports System
Imports System.ComponentModel.Design
Imports System.Data
Imports System.Drawing
Imports System.Web
Imports System.Web.SessionState
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.HtmlControls
Imports Microsoft.VisualBasic
Imports System.IO
Imports System.Xml.Serialization

    在IDE中打开WebForm1.vb,从左上角选择对象,拖放,实例化WebForm1对象,从右边的列表中选择PreRender方法。把下面的代码加入其中来检查我们是否能够从xmlarea中得到值:
Public Sub WebForm1_PreRender(ByVal sender As Object, _
ByVal e As System.EventArgs) Handles WebForm1.PreRender

@# if we don@#t already have a value, create a default book...
If xmlarea.Value = "" Then

    如果form已经被提交,xmlarea中将有一个值。其中会包含用户想加入的任何信息。接下来我们创建一个Book对象的实例并且设置属性值:
@# create an instance of a book...
Dim MyBook As New Book()
MyBook.Name = "Beginning E-commerce"
MyBook.ISBN = "1861003986"
接下来我们需要一个System.IO.Tex

    tWriter,XmlSerializer会把数据产生给它。一个TextWriter通常用来提供对数据流的访问,比如一个磁盘文件或者网络连接。在我们的例子中,我们使用System.IO.TextWriter。这是一个TextWriter对象,表示字符串中已经存在的部分,不论何时新的数据加入都会被连接到已存在数据的末尾。
@# create a new string writer...
Dim writer As New StringWriter()

    接着我们创建XmlSerializer对象,这需要我们要进行序列化的事物的Type对象了。一旦有了这个,我们要求它来把对象序列化为StringWriter对象。
[TABLE][TR][TD]@# create a serializer...
Dim serializer As New XmlSerializer(MyBook.GetType)
serializer.Serialize(writer, MyBook)

最后我们可以用StringWriter的ToString方法得到XML块的内容,我们把text area元素的value值设成该字符串:

@# set the value in the form...
xmlarea.Value = writer.ToString

End If

End Sub

如果运行代码,我们可以看到默认的Book对象所代表的XML Serialization字符串





把XML传回对象

原文转自:http://www.ltesting.net