序列化和反序列化的你的物件

http://www.clarkrabbit.net/2008/08/course-serialize-and-deserialize-your.html

http://www.dotblogs.com.tw/jeff377/archive/2008/08/19/4953.aspx

[Course] 序列化和反序列化的你的物件

大家有沒有遇過一個問題，就是當你想要將一個 .net 裡自行開發的一個物件存到資料庫裡或是想要保存資料到網頁上某個 hidden field 要怎麼將物件變成可以儲存的格式？

序列化(Serialize)和反序列化(Deserialize)就是在解決大家所遇到的這件事情，並且提供了許多種格式的序列化類別來幫大家節省開發的時間。事情當然不是簡單到直接把東西丟到序列化類別中就可以處理掉完成，因為只有你自已才知道這個物件哪些要序列化、哪些不序列化、哪些屬性要在物件建立時預先設定，所以必需要在想要被序列化的物件實作必要的method，來完全這一項序列化的工作。

以下以一個 UserInfo 物件的例子來看看怎麼開始來做序列化和反序列化這事情。一開始我們會先有一個 UserInfo 的 class 。

view plaincopy to clipboardprint?

public class UserInfo
{
private String m_userID;
private String m_userName;
private Hashtable m_favorates = new Hashtable();
public String UserID
{
get { return m_userID; }
set { m_userID = value; }
}
public String UserName
{
get { return m_userName; }
set { m_userName = value; }
}
public Hashtable Favorates
{
get { return m_favorates; }
set { m_favorates = value; }
}
public UserInfo(String userID, String userName)
{
m_userID = userID;
m_userName = userName;
}
}

再來，我們需要替 UserInfo 加上一個 Interface ，並實作 Interface 裡的項目，來提供序列化類別使用，結果會像這樣。

view plaincopy to clipboardprint?

[Serializable] //加上這行表示可以被序列化
public class UserInfo : ISerializable //加上可被序列化的介面宣告
{
private String m_userID;
private String m_userName;
private Hashtable m_favorates = new Hashtable();
//.......中間略過.........
public UserInfo(String userID, String userName)
{
m_userID = userID;
m_userName = userName;
}
//實作 ISerializable 裡定義的 method ，來達到序列化的工作
public void GetObjectData(SerializationInfo info, StreamingContext context)
{
//自行定義對應的key(userid, username..)，並將變數存入 SerializationInfo 中
info.AddValue("userid", m_userID);
info.AddValue("username", m_userName);
//由於hashtable中有多筆資料，所以先存一個count 供反序列之用，
//並利用迴圈來將資料存入
info.AddValue("fav_count", m_favorates.Count);
int index = 0;
foreach (DictionaryEntry entry in m_favorates)
{
info.AddValue("fav_id_" + index, entry.Key);
info.AddValue("fav_value_" + index, entry.Value);
index++;
}
}
//建立一個序列化類別在進行反序列化動作時需要使用的建構函數
public UserInfo(SerializationInfo info, StreamingContext context)
{
//開始反序列化工作，丟入自行定義的 key 將之前被序列化的資料讀出
m_userID = info.GetString("userid");
m_userName = info.GetString("username");
//遇到比較複雜的變數型態時需要自行做處理，
//本例使用一個 count 值記錄到底有多少筆資料放在 hashtable 中，
//跑迴圈丟入動態的index來讀出相關的hashtable中的value
int count = info.GetInt32("fav_count");
for (int i = 0; i < count; i++)
{
m_favorates.Add(info.GetString("fav_id_" + i), info.GetString("fav_value_" + i));
}
}
}

好了，經過上面兩個動作以後，這個UserInfo可以被多種序列化類別使用(相關文章看這裡)，為了驗證是否正確，以下使用一種類別來作序列化工作。

public class MySerialization
{
public static String Serialize(List<userinfo> users)
{
String base64Str;
BinaryFormatter formatter = new BinaryFormatter();
using (MemoryStream stream = new MemoryStream())
{
//選用 BinaryFormatter 來當作序列化類別
formatter.Serialize(stream, users.ToArray());
//若不想明碼列出所有資料以及避免網頁傳遞出現問題，
//使用base64做編碼
base64Str = Convert.ToBase64String(stream.GetBuffer());
}
return base64Str;
}
public static List<userinfo> Deserialize(String base64String)
{
try
{
UserInfo[] users;
//先從base64解回string
byte[] buffer = Convert.FromBase64String(base64String);
BinaryFormatter formatter = new BinaryFormatter();
using (MemoryStream stream = new MemoryStream(buffer))
{
//反序列化
users = (UserInfo[])formatter.Deserialize(stream);
}
return new List<userinfo>(users);
}
catch
{
return new List<userinfo>(0);
}
}
}
serinfo></userinfo></userinfo></userinfo>

好了，我們終於完成序列化的準備工作，開始來測試囉！

//先建立sample資料
List<userinfo> userList = new List<userinfo>();
UserInfo info = new UserInfo("joe", "李阿四");
info.Favorates.Add("movie", "The Batman");
info.Favorates.Add("star", "Nicolas Cage");
userList.Add(info);
info = new UserInfo("tom", "張阿三");
info.Favorates.Add("movie", "The Dark Knight");
info.Favorates.Add("star", "Heath Ledger");
userList.Add(info);
//開始序列化物件
String serializated = MySerialization.Serialize(userList);
//將序列化完成以後的字串反序列化看看
List<userinfo> result = MySerialization.Deserialize(serializated);
//列出反序列化後的結果
Console.WriteLine(result[0].UserID);
Console.WriteLine(result[0].Favorates["movie"]);
Console.WriteLine(result[0].Favorates["star"]);
Console.WriteLine(result[1].UserID);
Console.WriteLine(result[1].Favorates["movie"]);
Console.WriteLine(result[1].Favorates["star"]);
nfo></userinfo></userinfo>

得到結果如下：

可喜可賀，我們完成了序列化和反序列化的偉大工作，UserInfo 物件從此將可以無所不在！

====序列化各種存儲格式======================================================================

序列化是將物件狀態轉換為可保存或可傳輸格式的處理序。序列化的反面是還原序列化，它可以將資料流轉換成物件。在 .NET 程式中常用的序列化方式如下表所示。

我們撰寫一個 TBSerializerUtil 類別，來處理上述幾種序列化，TBSerializerUtil 類別包含的序列化方法如下表所示。

TBSerializerUtil 類別的完整程式碼如下

Imports System.Xml.Serialization

Imports System.IO

Imports System.Runtime.Serialization.Formatters.Soap

Imports System.Runtime.Serialization.Formatters.Binary

Imports System.Runtime.Serialization.Json

Imports System.Runtime.Serialization

Namespace [Lib]

    ''' <summary>

    ''' 物件序列化與反序化共用函式。

    ''' </summary>

Public Class TBSerializerUtil

        ''' <summary>

        ''' 將物件序列化為 XML 檔案。

        ''' </summary>

        ''' <param name="Value">物件。</param>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Sub ObjectToXmlFile(ByVal Value As Object, ByVal FileName As String)

Dim oSerializer As XmlSerializer

Dim oStream As StreamWriter

Dim sPath As String

            sPath = System.IO.Path.GetDirectoryName(FileName)

If Not System.IO.Directory.Exists(sPath) Then

                System.IO.Directory.CreateDirectory(sPath)

End If

oSerializer = New XmlSerializer(Value.GetType())

oStream = New StreamWriter(FileName)

            oSerializer.Serialize(oStream, Value)

            oStream.Close()

End Sub

        ''' <summary>

        ''' 將 XML 檔案反序列化為物件。

        ''' </summary>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Function XmlFileToObject(ByVal FileName As String, ByVal Type As System.Type) As Object

Dim oSerializer As XmlSerializer

Dim oFileStream As FileStream

Dim oValue As Object

            '若指定的檔案不存在則離開

If Not System.IO.File.Exists(FileName) Then Return Nothing

oSerializer = New XmlSerializer(Type)

oFileStream = New FileStream(FileName, FileMode.Open)

            'Call the Deserialize method and cast to the object type.

            oValue = oSerializer.Deserialize(oFileStream)

            oFileStream.Close()

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 XML 字串。

        ''' </summary>

        ''' <param name="Value">物件。</param>

Public Shared Function ObjectToXml(ByVal Value As Object) As String

Dim olSerializer As XmlSerializer

Dim oMemoryStream As MemoryStream

Dim oReader As StreamReader

Dim sText As String

olSerializer = New XmlSerializer(Value.GetType())

oMemoryStream = New MemoryStream()

            olSerializer.Serialize(oMemoryStream, Value)

            oMemoryStream.Position = 0

oReader = New StreamReader(oMemoryStream)

            sText = oReader.ReadToEnd()

Return sText

End Function

        ''' <summary>

        ''' 將 XML 字串反序列化為物件。

        ''' </summary>

        ''' <param name="Text">XML 字串。</param>

Public Shared Function XmlToObject(ByVal Text As String, ByVal Type As System.Type) As Object

Dim oSerializer As XmlSerializer

Dim oMemoryStream As MemoryStream

Dim oBuffer As Byte()

Dim oValue As Object

oSerializer = New XmlSerializer(Type)

            oBuffer = System.Text.Encoding.UTF8.GetBytes(Text)

oMemoryStream = New MemoryStream(oBuffer)

            'Call the Deserialize method and cast to the object type.

            oValue = oSerializer.Deserialize(oMemoryStream)

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 Soap 檔案。

        ''' </summary>

        ''' <param name="Value">物件。</param>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Sub ObjectToSoapFile(ByVal Value As Object, ByVal FileName As String)

Dim oFormatter As SoapFormatter

Dim oFileStream As FileStream

Dim sPath As String

            sPath = System.IO.Path.GetDirectoryName(FileName)

If Not System.IO.Directory.Exists(sPath) Then

                System.IO.Directory.CreateDirectory(sPath)

End If

oFormatter = New SoapFormatter()

oFileStream = New FileStream(FileName, FileMode.Create)

            oFormatter.Serialize(oFileStream, Value)

            oFileStream.Close()

End Sub

        ''' <summary>

        ''' 將 Soap 檔案反序列化為物件。

        ''' </summary>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Function SoapFileToObject(ByVal FileName As String, ByVal Type As System.Type) As Object

Dim oFormatter As SoapFormatter

Dim oFileStream As FileStream

Dim oValue As Object

            '若指定的檔案不存在則離開

If Not System.IO.File.Exists(FileName) Then Return Nothing

oFormatter = New SoapFormatter()

oFileStream = New FileStream(FileName, FileMode.Open)

            'Call the Deserialize method and cast to the object type.

            oValue = oFormatter.Deserialize(oFileStream)

            oFileStream.Close()

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 Soap 字串。

        ''' </summary>

        ''' <param name="Value">物件。</param>

Public Shared Function ObjectToSoap(ByVal Value As Object) As String

Dim oFormatter As SoapFormatter

Dim oMemoryStream As MemoryStream

Dim oReader As StreamReader

Dim sText As String

oFormatter = New SoapFormatter()

oMemoryStream = New MemoryStream()

            oFormatter.Serialize(oMemoryStream, Value)

            oMemoryStream.Position = 0

oReader = New StreamReader(oMemoryStream)

            sText = oReader.ReadToEnd()

Return sText

End Function

        ''' <summary>

        ''' 將 Soap 字串反序列化為物件。

        ''' </summary>

        ''' <param name="Text">Soap 字串。</param>

Public Shared Function SoapToObject(ByVal Text As String, ByVal Type As System.Type) As Object

Dim oFormatter As SoapFormatter

Dim oMemoryStream As MemoryStream

Dim oBuffer As Byte()

Dim oValue As Object

oFormatter = New SoapFormatter()

            oBuffer = System.Text.Encoding.UTF8.GetBytes(Text)

oMemoryStream = New MemoryStream(oBuffer)

            'Call the Deserialize method and cast to the object type.

            oValue = oFormatter.Deserialize(oMemoryStream)

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 Binary 檔案。

        ''' </summary>

        ''' <param name="Value">物件。</param>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Sub ObjectToBinaryFile(ByVal Value As Object, ByVal FileName As String)

Dim oFormatter As BinaryFormatter

Dim oFileStream As FileStream

Dim sPath As String

            sPath = System.IO.Path.GetDirectoryName(FileName)

If Not System.IO.Directory.Exists(sPath) Then

                System.IO.Directory.CreateDirectory(sPath)

End If

oFormatter = New BinaryFormatter()

oFileStream = New FileStream(FileName, FileMode.Create)

            oFormatter.Serialize(oFileStream, Value)

            oFileStream.Close()

End Sub

        ''' <summary>

        ''' 將 Binary 檔案反序列化為物件。

        ''' </summary>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Function BinaryFileToObject(ByVal FileName As String, ByVal Type As System.Type) As Object

Dim oFormatter As BinaryFormatter

Dim oFileStream As FileStream

Dim oValue As Object

            '若指定的檔案不存在則離開

If Not System.IO.File.Exists(FileName) Then Return Nothing

oFormatter = New BinaryFormatter()

oFileStream = New FileStream(FileName, FileMode.Open)

            'Call the Deserialize method and cast to the object type.

            oValue = oFormatter.Deserialize(oFileStream)

            oFileStream.Close()

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 Binary 資料。

        ''' </summary>

        ''' <param name="Value">物件。</param>

Public Shared Function ObjectToBinary(ByVal Value As Object) As Byte()

Dim oFormatter As SoapFormatter

Dim oMemoryStream As MemoryStream

oFormatter = New SoapFormatter()

oMemoryStream = New MemoryStream()

            oFormatter.Serialize(oMemoryStream, Value)

            oMemoryStream.Position = 0

Return oMemoryStream.GetBuffer()

End Function

        ''' <summary>

        ''' 將 Binary 資料反序列化為物件。

        ''' </summary>

        ''' <param name="Buffer">Binary 資料。</param>

Public Shared Function BinaryToObject(ByVal Buffer As Byte(), ByVal Type As System.Type) As Object

Dim oFormatter As SoapFormatter

Dim oMemoryStream As MemoryStream

Dim oValue As Object

oFormatter = New SoapFormatter()

oMemoryStream = New MemoryStream(Buffer)

            'Call the Deserialize method and cast to the object type.

            oValue = oFormatter.Deserialize(oMemoryStream)

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 Json 檔案。

        ''' </summary>

        ''' <param name="Value">物件。</param>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Sub ObjectToJsonFile(ByVal Value As Object, ByVal FileName As String)

Dim oSerializer As DataContractJsonSerializer

Dim oFileStream As FileStream

Dim sPath As String

            sPath = System.IO.Path.GetDirectoryName(FileName)

If Not System.IO.Directory.Exists(sPath) Then

                System.IO.Directory.CreateDirectory(sPath)

End If

oSerializer = New DataContractJsonSerializer(Value.GetType())

oFileStream = New FileStream(FileName, FileMode.Create)

            oSerializer.WriteObject(oFileStream, Value)

            oFileStream.Close()

End Sub

        ''' <summary>

        ''' 將 Json 檔案反序列化為物件。

        ''' </summary>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Function JsonFileToObject(ByVal FileName As String, ByVal Type As System.Type) As Object

Dim oSerializer As DataContractJsonSerializer

Dim oFileStream As FileStream

Dim oValue As Object

            '若指定的檔案不存在則離開

If Not System.IO.File.Exists(FileName) Then Return Nothing

oSerializer = New DataContractJsonSerializer(Type)

oFileStream = New FileStream(FileName, FileMode.Open)

            'Call the Deserialize method and cast to the object type.

            oValue = oSerializer.ReadObject(oFileStream)

            oFileStream.Close()

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 Json 字串。

        ''' </summary>

        ''' <param name="Value">物件。</param>

Public Shared Function ObjectToJson(ByVal Value As Object) As String

Dim oSerializer As DataContractJsonSerializer

Dim oMemoryStream As MemoryStream

Dim oReader As StreamReader

Dim sText As String

oSerializer = New DataContractJsonSerializer(Value.GetType)

oMemoryStream = New MemoryStream()

            oSerializer.WriteObject(oMemoryStream, Value)

            oMemoryStream.Position = 0

oReader = New StreamReader(oMemoryStream)

            sText = oReader.ReadToEnd()

Return sText

End Function

        ''' <summary>

        ''' 將 Json 字串反序列化為物件。

        ''' </summary>

        ''' <param name="Text">Json 字串。</param>

Public Shared Function JsonToObject(ByVal Text As String, ByVal Type As System.Type) As Object

Dim oSerializer As DataContractJsonSerializer

Dim oMemoryStream As MemoryStream

Dim oBuffer As Byte()

Dim oValue As Object

oSerializer = New DataContractJsonSerializer(Type)

            oBuffer = System.Text.Encoding.UTF8.GetBytes(Text)

oMemoryStream = New MemoryStream(oBuffer)

            'Call the Deserialize method and cast to the object type.

            oValue = oSerializer.ReadObject(oMemoryStream)

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 DataContract 檔案。

        ''' </summary>

        ''' <param name="Value">物件。</param>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Sub ObjectToDataContractFile(ByVal Value As Object, ByVal FileName As String)

Dim oSerializer As DataContractSerializer

Dim oFileStream As FileStream

Dim sPath As String

            sPath = System.IO.Path.GetDirectoryName(FileName)

If Not System.IO.Directory.Exists(sPath) Then

                System.IO.Directory.CreateDirectory(sPath)

End If

oSerializer = New DataContractSerializer(Value.GetType())

oFileStream = New FileStream(FileName, FileMode.Create)

            oSerializer.WriteObject(oFileStream, Value)

            oFileStream.Close()

End Sub

        ''' <summary>

        ''' 將 DataContract 檔案反序列化為物件。

        ''' </summary>

        ''' <param name="FileName">檔案名稱。</param>

Public Shared Function DataContractFileToObject(ByVal FileName As String, ByVal Type As System.Type) As Object

Dim oSerializer As DataContractSerializer

Dim oFileStream As FileStream

Dim oValue As Object

            '若指定的檔案不存在則離開

If Not System.IO.File.Exists(FileName) Then Return Nothing

oSerializer = New DataContractSerializer(Type)

oFileStream = New FileStream(FileName, FileMode.Open)

            'Call the Deserialize method and cast to the object type.

            oValue = oSerializer.ReadObject(oFileStream)

            oFileStream.Close()

Return oValue

End Function

        ''' <summary>

        ''' 將物件序列化為 DataContract 字串。

        ''' </summary>

        ''' <param name="Value">物件。</param>

Public Shared Function ObjectToDataContract(ByVal Value As Object) As String

Dim oSerializer As DataContractSerializer

Dim oMemoryStream As MemoryStream

Dim oReader As StreamReader

Dim sText As String

oSerializer = New DataContractSerializer(Value.GetType)

oMemoryStream = New MemoryStream()

            oSerializer.WriteObject(oMemoryStream, Value)

            oMemoryStream.Position = 0

oReader = New StreamReader(oMemoryStream)

            sText = oReader.ReadToEnd()

Return sText

End Function

        ''' <summary>

        ''' 將 DataContract 字串反序列化為物件。

        ''' </summary>

        ''' <param name="Text">Json 字串。</param>

Public Shared Function DataContractToObject(ByVal Text As String, ByVal Type As System.Type) As Object

Dim oSerializer As DataContractSerializer

Dim oMemoryStream As MemoryStream

Dim oBuffer As Byte()

Dim oValue As Object

oSerializer = New DataContractSerializer(Type)

            oBuffer = System.Text.Encoding.UTF8.GetBytes(Text)

oMemoryStream = New MemoryStream(oBuffer)

            'Call the Deserialize method and cast to the object type.

            oValue = oSerializer.ReadObject(oMemoryStream)

Return oValue

End Function

End Class

End Namespace

序列化和反序列化的你的物件

[Course] 序列化 和 反序列化 的你的物件

[Course] 序列化和反序列化的你的物件