這兩天用 F# 寫一小段程式,需要把一些物件存到外部檔案。功能本身很簡單,.NET 早已內建序列化機制;為了方便除錯與人工檢視,我選擇序列化成 XML 而不是二進位資料流,也就是改用 XmlSerializer 而非 BinaryFormatter。理論上不該有問題,但實際執行時還是被絆了一下。
F# 有多種宣告形式。除了 F# 特有的 Record 型別,也能宣告一般的「類別」:
#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# 並沒有什麼優勢,反而需要更多程式碼。
原本以為用 XmlSerializer 序列化物件再簡單不過,寫個泛型函式就好:
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 的建構子卻拋出了 InvalidOperationException:
XMLSerialization.Post cannot be serialized. Static types cannot be used as parameters or return types.
訊息似乎是在說 XMLSerialization 是靜態型別——但這明明就是個 F# 模組。用 .NET Reflector 反編譯後才恍然大悟,Post 類別實際上被編譯成:
public static class XMLSerialization
{
public class Post { ... }
}
.NET 裡雖然也有「模組」的概念,但和 F# 的模組幾乎沒有相似之處。F# 模組會被編譯為靜態類別,模組中的函式自然成為靜態方法,而型別則成為靜態類別中的嵌套型別。這一切本身都合情合理,理論上 XmlSerializer 也不該有問題才對。
可惜它就是有問題。我認為這是個缺陷,但即便真是缺陷,也解決不了眼前的狀況。網路上也有人提出同樣的疑問,半年來卻沒有人回應。
既然如此,那就手動來吧。反正就是個簡單的物件,寫起來應該不麻煩。在 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 建構子最後採用了 params object[],可以把參數直接「列舉」出來而不用顯式建陣列;建構子接受 XName 型別,但字串能隱式轉換;建構子能把 IEnumerable<XElement> 攤平成獨立元素。除了第三點,前兩個便利在 F# 裡都享受不到,於是只能改寫成命令式的逐行 Add。這樣的 F# 程式碼幾乎可以自動轉譯成 Java——在這種場景下,F# 的函式式優勢完全使不上力。
手動序列化雖不難,但實在麻煩,而且不是通用做法:每個型別都得各寫一套序列化與反序列化邏輯,型別欄位一旦異動,兩邊都要跟著改。正當我打算硬寫一個通用版本時,忽然想起以前讀過的一篇文章提到,.NET 3.0 加入了新的類別庫 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()
果然可用,完全沒有 XmlSerializer 那種莫名的毛病。反序列化同樣簡單:
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
多做幾次實驗後發現,DataContractSerializer 對嵌套的複雜型別欄位也能正常處理,而取得這些能力只需在目標型別上標記 SerializableAttribute;需要更細緻的控制時,再透過 DataContractAttribute 等標記調整即可。
所以回到最初那個問題:在 F# 裡做 XML 序列化,直接跳過 XmlSerializer、選用 DataContractSerializer,能省下大量無謂的嘗試。至於 XmlSerializer 是否該退出歷史舞台——至少在 F# 的模組結構下,它確實不太好用。