
這一篇應該是我ProtoBuf的系列文章第二篇，上一篇只簡單說了一些安裝方式與一些定義檔
的設定根本就不知道該如何使用這一個好用的序列化工具。依樣會是使用protobuf-net
這一個套件來做一個簡單的紀錄。

## ProtoBuf 序列化

在使用 ProtoBuf 的第一步就必須了解 Stream 的資料格式，因為在(反)序列化
的過程中，預設都是使用 Stream 作為媒介。序列化的部份是使用 Serializer.Serialize
這個方法來處理。

### Simple Code 1 - 序列化

```cs
public void SerializeToStream<T>(T data, Stream stream)
{
    Serializer.Serialize(stream, data)
}

public void Main()
{
    using (var stream = new MemoryStream())
    {
        this.SerializeToStream<object>(data, stream);
    }
}
```

主要原因是若Stream關閉後就無法做任何的操作，所以交由外部來控制Stream的資源初始與回收。
可以在序列化成為 Array 或 String 的格式。

### Simple Code 2 - Serialize to byte array and string

```cs
public byte[] SerializeToBytes<T>(T data)
{
    byte[] result;
    using (var stream = new MemoryStream())
    {
        this.SerializeToStream(data, stream);
        result = stream.ToArray();
    }

    return result;
}

public string SerializeToString<T>(T data)
{
    string result;
    using (var stream = new MemoryStream())
    {
        this.SerializeToStream(data, stream);
        result = Encoding.ASCII.GetString(stream.ToArray());
    }

    return result;
}
```

在Format 成 String 我是採用ASCII的編碼方式，讓他出來會像16進位的感覺。

> 也可以使用 Convert.ToBase64String(stream.ToArray()); 產生文字資料

## ProtoBuf 反序列化

在反序列化的部分也是預設採用 Stream 的資料格式來處理，

### Simple Code 3 - 反序列化

```cs
public T SerializeToStream<T>(Stream stream)
{
    return Serializer.Deserialize<T>(stream, data)
}
```

### Simple Code 4 - 針對 Byte array and string deserialize

```cs
public T DeSerializeFromBytes<T>(byte[] data)
{
    T result;
    using (var stream = new MemoryStream(data))
    {
        stream.Seek(0, SeekOrigin.Begin);
        result = this.DeSerializeFromStream<T>(stream);
    }

    return result;
}

public T DeSerializeFromString<T>(string data)
{
    return this.DeSerializeFromBytes<T>(Encoding.ASCII.GetBytes(data));
}
```

>注： 若string是使用base64字元輸出，那麼在deserialize時就必須使用
>Convert.FromBase64String(data) 處理


這一篇應該是我ProtoBuf的系列文章第二篇，上一篇只簡單說了一些安裝方式與一些定義檔 的設定根本就不知道該如何使用這一個好用的序列化工具。依樣會是使用protobuf-net 這一個套件來做一個簡單的紀錄。

[ProtoBuf] ProtoBuf Serialize 與 DeSerialize！


## 什麼是ProtoBuf？

這是一個Google所開發出的資料儲存結構或物件（反）序列的結構（如 JOSN、XML、msgpack等），在官方網站的介紹上有這麼一段：
> Protocol buffers are Google's language-neutral,
> platform-neutral, extensible mechanism for serializing structured data
> – think XML, but smaller, faster, and simpler.
> You define how you want your data to be structured once,
> then you can use special generated source code to easily write
> and read your structured data to and from a variety of data streams and using a variety of languages.
> <p style="text-align:right"> from <a href="https://developers.google.com/protocol-buffers/" target="_blank">https://developers.google.com/protocol-buffers/</a></p>

ProtoBuf支援各種主流的語言(ex: C#, C++, JAVA等)，
在官方中的[GitHub](https://github.com/google/protobuf)上有目前支援的語言實做，或是Third-party搜尋相關的實做套件。

### ProtoBuf 優點

* (反)序列**速度快**，方便於網路傳輸
* 產出格式**內容小**，方便存放至檔案或其他Service

### ProtoBuf 缺點

* 二進位格式，難以閱讀
* 使用上必須先作定義，需要先設定.proto檔案

## 在 C# 中使用 ProtoBuf

在專案中我是使用third-party的套件，[ProtoBuf-net](https://www.nuget.org/packages/protobuf-net)
套件可以在nuget上找到，會選擇這個套件主要是因為在使用上較為簡便，也支援較多的設定的方式來做資料，設定的方式
稍後會有比較詳細一些的介紹。

### 定義方式

ProtoBuf-net設定的方式支援了以下三種方式

#### Attribute

這個方式，個人認為是一個較好的設定方式，

```cs
[ProtoContract]
public class TestClass
{
    [ProtoMember(1)]
    public int TestA { get; set; }

    [ProtoMember(2)]
    public string TestB { get; set; }

    [ProtoMember(3)]
    public TestClassB TestC { get; set; }
}

[ProtoContract]
public class TestClassB
{
    ...
}
```

這一個設定方式可以修改data model同時修改 Attribute 這樣在團隊使用上可以避免修改data model後
也可馬上維護protobuf的設定，避免在runtime時因為設定上造成exception。

#### .proto檔案

這一個方式是官方的標準設定，這個需要額外產生一份.proto檔案，定義方式與格式可參考
[官方網站](https://developers.google.com/protocol-buffers/docs/csharptutorial)
的設定。

這一個方式因為多產生了一個.proto的檔案，在修改data model後，必須要再額外修改.proto的檔案，
有時候在開發上會有不一致的情況；在使用上與設定上也相對較為複雜。

#### Runtime 定義

這是在Application執行期間產生一份 RuntimeTypeModel，在Serializer的時候會以這一份RuntimeTypeModel為你的
data model做序列化，以下提供語法參考設定方式

這一個方式會將原先定義覆蓋

```cs
    var metaType = RuntimeTypeModel.Default.Add(typeof(TestClassA), true);
    metaType.AddSubType(100, typeof(TestA));

    RuntimeTypeModel.Default.Add(typeof(TestA), false);
```

這一個會複寫(或新增)原先的定義
```cs
    var metaType = RuntimeTypeModel.Default;
    var testA = metaType[typeof(TestClassA)];
    testA.AddSubType(100, typeof(TestA));
    metaType.Add(typeof(TestA), false);
```

## 總結

目前會採用ProtoBuf序列化是因為先前使用JSON有效能上的問題與在存取Redis上產生較高的延遲，所以改採用
ProtoBuf來作為資料序列化與存放到Redis的主要格式。雖然在閱讀上需要自己寫小工具做轉譯，但在一般情況
擁有較好的效能展現。


其他更詳細的介紹可觀看
[protobuf-net 官方GitHub](https://github.com/mgravell/protobuf-net#advanced-subjects)

## 參考資料

[Level up - protobuf-net - Serialize/DeSerialize data](http://larrynung.github.io/2016/08/23/protobuf-net-Serialize-DeSerialize-data/)

[protobuf-net 官方GitHub](https://github.com/mgravell/protobuf-net)

[Google protobuf](https://github.com/google/protobuf)


目前會採用ProtoBuf序列化是因為先前使用JSON有效能上的問題與在存取Redis上產生較高的延遲，所以改採用ProtoBuf來作為資料序列化與存放到Redis的主要格式。雖然在閱讀上需要自己寫小工具做轉譯，但在一般情況擁有較好的效能展現。

[ProtoBuf] ProtoBuf Serialize 與 DeSerialize！

[ProtoBuf] 初次見面