詳解F#對象序列化為XML的實現(xiàn)方法
本文將從F#對象開始,詳細描述F#對象序列化為XML的實現(xiàn)方法,期間還與C#進行了對比。希望通過本文,能讓大家更好的理解F#。
#T#
這兩天在用F#寫一小段代碼,需要把一些對象存到外部文件中去。這個功能很容易,因為.NET本身就內(nèi)置了序列化功能。方便起見,我打算將這個F#對象序列化成XML而不是二進制數(shù)據(jù)流。這意味著我需要使用XmlSerializer而不是BinaryFormatter。這本應沒有問題,但是在使用時候還是發(fā)生了一些小插曲。
定義類型
在F#中有多種定義方式。除了F#特有的Record類型外,在F#中也可以定義普通的“類”,如:
- #light
- module XmlSerialization
- type Post() =
- [<DefaultValue>]
- val mutable Title : string
- [<DefaultValue>]
- val mutable Content : string
- [<DefaultValue>]
val mutable Tags : string array上面的代碼在XmlSerialization模塊中定義了一個Post類,其中包含三個公開字段。簡單地說,它和C#中的如下定義等價:
- public class Post
- {
- public string Title;
- public string Content;
- public string[] Tags;
- }
可見,在定義這種簡單類型時,F(xiàn)#并沒有什么優(yōu)勢,反而需要更多的代碼。
使用XmlSerializer進行序列化
原本我以為使用XmlSerializer來序列化一個對象非常容易,寫一個簡單的(泛型)函數(shù)就可以了:
- let byXmlSerializer (graph: 'a) =
- let serializer = new XmlSerializer(typeof<'a>)
- let writer = new StringWriter()
- serializer.Serialize(writer, graph)
- writer.ToString()
使用起來更加不在話下:
- let post = new XmlSerialization.Post()
- post.Title <- "Hello"
- post.Content <- "World"
- post.Tags <- [| "Hello"; "World" |]
- let xml = XmlSerialization.byXmlSerializer(post)
但是,在運行的時候,XmlSerializer的構造函數(shù)卻拋出了InvalidOperationException:
XmlSerialization cannot be serialized. Static types cannot be used as parameters or return types.
這句話的提示似乎是在說XmlSerialization是一個靜態(tài)類型——但這其實是F#的模塊啊。不過使用.NET Reflector查看編譯后的程序集便會發(fā)現(xiàn),其實Post類是這樣定義的:
- public static class XmlSerialization
- {
- public class Post { ... }
- }
雖然.NET中也有“模塊”的概念,但是它和F#中的模塊從各方面來講幾乎沒有相同之處。F#的模塊會被編譯為靜態(tài)類,自然模塊中的方法或各種函數(shù)便成為靜態(tài)類中的內(nèi)嵌類型及方法。這本沒有問題,從理論上來說XmlSerializer也不該有問題,不是嗎?
可惜XmlSerializer的確有這樣的問題,我認為這是個Bug——但就算這是個Bug也無法解決目前的狀況。事實上,互聯(lián)網(wǎng)上也有人提出這個問題,可惜半年來都沒有人回應。
手動序列化
那么我又該怎么做呢?我想,算了,既然如此,我們進行手動序列化吧。反正就是簡單的對象,寫起來應該也不麻煩。例如在C#中我們便可以:
- public class Post
- {
- ...
- public string ToXml()
- {
- var xml =
- new XElement("Post",
- new XElement("Title", this.Title),
- new XElement("Content", this.Content),
- new XElement("Tags",
- this.Tags.Select(t => new XElement("Tag", t))));
- return xml.ToString();
- }
- }
很簡單,不是嗎?但是用F#寫同樣的邏輯便有一些問題了,最終得到的結果是:
- type Post() =
- ...
- member p.ToXml() =
- let xml = new XElement(XName.Get("Post"))
- xml.Add(new XElement(XName.Get("Title"), p.Title))
- xml.Add(new XElement(XName.Get("Content"), p.Content))
- let tagElements = p.Tags |> Array.map (fun t -> new XElement(XName.Get("Tag"), t))
- xml.Add(new XElement(XName.Get("Tags"), tagElements))
- xml.ToString()
C#之所以可以寫的簡單,其中有諸多因素:
XElement的構造函數(shù)***使用了params object[],這意味著我們可以把參數(shù)“羅列”出來,而不需要顯式地構造一個數(shù)組。
XElement的構造函數(shù)接受的其實是XName類型參數(shù),但字符串可以被隱式地轉(zhuǎn)化為XName類型。
XElement的構造函數(shù)可以將IEnumerable<XElement>對象轉(zhuǎn)化為獨立的元素。 但是,除了***一條外,其他兩個特性在F#里都無法享受到。因此,我們只能用命令式編程的方式編寫此類代碼。您可以發(fā)現(xiàn),這樣的F#代碼幾乎可以被自動轉(zhuǎn)化為Java代碼。F#在寫這樣的代碼時實在沒有優(yōu)勢。
使用DataContractSerializer
手動進行XML序列化雖然并不困難,但是實在麻煩。這不是一種通用的做法,我們必須為每個類型各寫一套序列化(和反序列化)邏輯,在類型字段有所改變的時候,序列化和反序列化的邏輯還必須有所變化。就在我打算寫一個簡單的,通用的XML序列化方法時,我忽然想到以前看到過的一篇文章,說是在.NET 3.0中發(fā)布了新的類庫:DataContractSerializer。
DataContractSerializer看似和WCF有關,如DataContractAttribute,DataMemberAttribute等標記最典型的作用也一直用在WCF里。但事實上,這些類型都是定義在System.Runtime.Serialization.dll中的,這意味著這些功能從設計之初與WCF分離開來,可以獨立使用。那么我們不如嘗試一下吧:
- let serialize (graph : 'a) =
- let serializer = new DataContractSerializer(typeof<'a>)
- let textWriter = new StringWriter();
- let xmlWriter = new XmlTextWriter(textWriter);
- serializer.WriteObject(xmlWriter, graph)
- textWriter.ToString()
果然好用,DataContractSerializer并沒有出現(xiàn)XmlSerializer那樣傻乎乎地錯誤。自然,與之相對的反序列化函數(shù)也很容易寫:
- let deserialize<'a> xml =
- let serializer = new DataContractSerializer(typeof<'a>)
- let textReader = new StringReader(xml)
- let xmlReader = new XmlTextReader(textReader)
- serializer.ReadObject(xmlReader) :?> 'a
試驗一下,看看效果?
- let post = new XmlSerialization.Post()
- post.Title <- "Hello"
- post.Content <- "World"
- post.Tags <- [| "Hello"; "World" |]
- let xml = XmlSerialization.serialize post
- let post' = XmlSerialization.deserialize<XmlSerialization.Post> xml
經(jīng)過更多試驗,我發(fā)現(xiàn)DataContractSerializer對于復雜類型的字段也可以正常應對,而得到這些功能也只需要在目標類型上標記一個SerializableAttribute就行了,更細節(jié)的控制也可以通過DataContractAttribute等進行控制。這樣看來,XmlSerializer似乎已經(jīng)可以退出歷史舞臺了?
原文標題:F#中的XML序列化
鏈接: http://www.cnblogs.com/JeffreyZhao/archive/2010/01/03/fsharp-xml-serialization.html