.NET Protobuf包裝器庫

Carl 發(fā)布于2021-11-17 17:00 / 2465人閱讀

摘要：不然將根據(jù)屬性名稱進(jìn)行排序。獲取包裝器獲取包裝器我們可以直接轉(zhuǎn)換模型對象為。所有與對象不能包含值。它們將作為類型進(jìn)行序列化。我們定義了一個抽象類。使用會獲得最佳性能。許可證許可證庫使用許可證。

Wodsoft Protobuf Wrapper

內(nèi)容

關(guān)于
需求
安裝
用法
高級
許可證

關(guān)于

這是一個可以幫助你不需要.proto文件就能夠使用Protobuf序列化的一個庫。

通常.proto文件會創(chuàng)建繼承IMessage接口的模型，Protobuf使用這些模型來進(jìn)行序列化。

有時候我們已經(jīng)在自己的.NET項(xiàng)目里創(chuàng)建了一些模型，但我們需要使用Protobuf對這些模型進(jìn)行序列化。
這時候這個庫就能幫助你使用Protobuf對已存在的模型進(jìn)行序列化。

Github地址：Wodsoft.Protobuf.Wrapper

需求

Wodsoft.Protobuf.Wrapper需要NETStandard 2.0或以上。

這個庫需要工作在允許動態(tài)代碼編譯的平臺。所以IOS不支持。

安裝

在NuGet上獲取Wodsoft.Protobuf.Wrapper.

dotnet add package Wodsoft.Protobuf.Wrapper

用法

序列化

可以使用Wodsoft.Protobuf.Message類中的靜態(tài)方法Serialize。
你需要一個System.IO.Stream來存儲序列化后的數(shù)據(jù)。

YourModel model = new ();MemoryStream stream = new MemoryStream();Message.Serialize(stream, model);

這里也有一個重載方法。
你可以傳遞一個Google.Protobuf.CodedInputStream來替代System.IO.Stream。

YourModel model = new ();CodedInputStream input = ...;Message.Serialize(input, model);

或者你想直接拿到序列化后的字節(jié)數(shù)組。

YourModel model = new ();var bytes = Message.SerializeToBytes(model);

反序列化

你可以使用Wodsoft.Protobuf.Message類中的靜態(tài)方法Deserialize。
你需要傳遞包含需要反序列化數(shù)據(jù)的System.IO.Stream。
它將返回你的泛型對象T。

Stream stream = ...;YourType model = Message.Deserialize(stream);

這里也有一個重載方法。
你可以傳遞一個Google.Protobuf.CodedOutputStream來替代System.IO.Stream。

CodedOutputStream output = ...;YourType model = Message.Deserialize(output);

或者你想直接從字節(jié)數(shù)組進(jìn)行反序列化。

YourType model = Message.DeserializeFromBytes(bytes);

字段定義

IMessageFieldProvider.GetFields(Type type)會返回從對象映射而來的消息字段。

默認(rèn)實(shí)現(xiàn)是GeneralMessageFieldProvider.Intance類。
它只會映射可讀寫的屬性到消息字段。

你可以創(chuàng)建自己的IMessageFieldProvider去映射消息字段。
然后通過設(shè)置靜態(tài)屬性Message.FieldProvider為自定義的IMessageFieldProvider。

你需要為每個需要自定義消息字段的類型設(shè)置IMessageFieldProvider。

字段排序

給屬性添加System.Runtime.Serialization.DataMemberAttribute特性然后設(shè)置Order屬性。
不然將根據(jù)屬性名稱進(jìn)行排序。

?? 如果有任何一個屬性使用了DataMemberAttribute特性，將只會序列化擁有DataMemberAttribute特性的屬性。

?? 如果全部沒有使用DataMemberAttribute特性，服務(wù)如果因?yàn)椴渴饐栴}使用了不同版本的模型，反序列化時可能因?yàn)?strong>字段排序問題存在錯誤。

非空構(gòu)造函數(shù)

通過調(diào)用靜態(tài)方法MessageBuilder.SetTypeInitializer(Func initializer)來設(shè)置對象初始化委托。

獲取Protobuf包裝器

我們可以直接轉(zhuǎn)換模型對象為Message<>。

SimplyModel model;Message message = model;

然后這個message可以直接被Protobuf序列化。

高級

支持的屬性類型與Protobuf類型的關(guān)系

C#類型	Protobuf類型	消息結(jié)構(gòu)
bool(?)	bool	Varint
sbyte(?)	int32	Varint
byte(?)	int32	Varint
short(?)	int32	Varint
ushort(?)	int32	Varint
int(?)	int32	Varint
long(?)	int64	Varint
uint(?)	uint32	Varint
ulong(?)	uint64	Varint
float(?)	float	Varint
double(?)	double	Varint
string	string	Length-delimited
byte[]	ByteString	Length-delimited
Guid(?)	ByteString	Length-delimited
DateTime(?)	google.protobuf.Timestamp	Length-delimited
DateTimeOffset(?)	google.protobuf.Timestamp	Length-delimited
TimeSpan(?)	google.protobuf.Duration	Length-delimited
IMessage		Length-delimited
T[]	RepeatedField	Length-delimited
ICollection	RepeatedField	Length-delimited
Collection	RepeatedField	Length-delimited
IList	RepeatedField	Length-delimited
List	RepeatedField	Length-delimited
IDictionary	MapField	Length-delimited
Dictionary	MapField	Length-delimited

(?) 意思是可以為Nullable<>可空類型。
可以直接使用繼承了Google.Protobuf.IMessage的Protobuf對象作為屬性類型。
所有RepeatedField與MapField對象不能包含null值。
支持byte，sbyte，short和ushort作為屬性類型。
它們將作為int類型進(jìn)行序列化。
如果從其它第三方來源數(shù)據(jù)進(jìn)行反序列化，int可能會丟失數(shù)據(jù)。

如何工作

首先，Protobuf通過Google.Protobuf.IMessage與Google.Protobuf.IBufferMessage接口進(jìn)行序列化工作。

我們定義了一個抽象類Wodsoft.Protobuf.Message。
然后定義抽象保護(hù)方法Read，Write，CalculateSize。
顯式實(shí)現(xiàn)這些接口并調(diào)用這些方法。

然后定義泛型抽象類Wodsoft.Protobuf.Message。
這里有一個屬性可以直接獲取到原始類型值。然后我們實(shí)現(xiàn)了一些隱式轉(zhuǎn)換操作。

public T Source { get; }

最后，為需要序列化的類型動態(tài)創(chuàng)建繼承了Message的類。
通過Emit動態(tài)創(chuàng)建代碼實(shí)現(xiàn)Read，Write，CalculateSize方法。

性能

建議使用 RepeatedField<>，IList<>或ICollection<>作為集合屬性的類型。
使用RepeatedField<>會獲得最佳性能（因?yàn)椴恍枰~外類型轉(zhuǎn)換）。
使用IList<>或ICollection<>在序列化時會轉(zhuǎn)換為RepeatedField<>。
使用List<>或Collection<>在序列化時會轉(zhuǎn)換為RepeatedField<>。
并且在反序列化時會轉(zhuǎn)換回List<>或Collection<>（上一個會直接返回RepeatedField<>）。
推薦使用 MapField<,>或IDictionary<,>作為字典屬性的類型。
使用MapField<,>會獲得最佳性能。
使用IDictionary<,>在序列化時會轉(zhuǎn)換為MapField<,>。
使用Dictionary<,>在序列化時會轉(zhuǎn)換為MapField<,>。
并且在反序列化時會轉(zhuǎn)換回Dictionary<,>（上一個會直接返回MapField<,>）。