簡介

LiteByte是一種輕量級的二進位數據交換格式。
體積小巧、簡單易用是設計目標。主要用於解決前後臺數據傳輸量的問題。

作者：冰封百度(ZhangYu)
設計的靈感來源於C# struct記憶體對齊後的緊湊格式。暫時只實現了C#版本。

特點

1.緊湊的二進位數據格式，支持變長整型，數據量小。
2.用近似代碼定義類的方式定義對象結構，使用方便。

實現思路

把一個對象分為兩個部分：結構和值，結構用配置文件定義，值用於網路傳輸。前後臺依賴相同的結構配置文件，轉換時把對象的值拆出來傳輸，解析時把值還原成對象。

使用方法

1.創建自定義結構文件CustomType.lbs (LiteByte Schema 文本文件)。
2.定義對象欄位(像寫類一樣寫結構、類型和名稱)。
3.調用LBUtil.Serialize(object) 把對象序列化成二進位數據。
4.調用LBUtil.Deserilize(bytes) 把二進位數據反序列化成對象。

代碼樣例:

// 自定義對象結構：
// 寫結構配置和C#中寫struct一樣, 訪問修飾符可以不寫，讀配置文件的時候會被忽略

/// <summary> 玩家信息測試 | PlayerInfo test </summary>
public struct PlayerInfo {

    public uint id;
    public string nickname;
    public byte gender;
    public bool isVip;
    public int lv;
    public int hp;
    public int mp;
    public int exp;

}

// 命名空間
using LiteByte;

// 創建對象
PlayerInfo player = new PlayerInfo();
player.id = 100001;
player.nickname = "冰封百度";
player.gender = 1;
player.isVip = true;
player.lv = 999;
player.hp = 999999;
player.mp = 999999;
player.exp = 9999999;

// 序列化:
string typeName = "PlayerInfo";
byte[] bytes = LBUtil.Serialize(typeName, player); // 長度:31位元組

// 反序列化：
PlayerInfo info = LBUtil.Deserialize<PlayerInfo>(typeName, bytes);

轉換結果：

代碼說明:

1.序列化對象時用LBUtil.Serialize("name", obj)
2.反序列化對象時候用LBUtil.Deserilize("name", obj)
3.可以轉換自定義的struct和class 欄位需要是public的
4.提供了通用的轉換對象LBObject，可以Set和Get值，用於動態創建全新的自定義結構。由於序列化和反序列化自定義struct和class時用了反射，效率不高，用LBObject轉換效率會更高一些，但用起來會麻煩一些，按自己喜歡的方式使用就好。

支持的數據類型

數據類型介紹

1.基本的值類型:bool、byte、short、int、long
2.字元串 string (支持UTF8、Unicode、ASCII三種編碼方式)
3.數組 (類型+"[]"會被識別成數組)
4.自定義類型 (複雜對象)

基本數據類型

比特型（7種）

整型（16種）

浮點型（5種）

變長整型（7種）

字元串（3種編碼）

複雜數據類型（2種）

自定義類型結構配置(LiteByte Schema)樣例

以下樣例中 基本類型預設應用以下簡稱配置
Bit1 = bool
Int8 = sbyte
UInt8 = byte
VarInt32 = int
VarUnt32 = uint
VarInt64 = long
VarUInt64 = ulong
UTF8 = string

基本數據類型 結構:

 1 struct BaseTypeST {
 2 
 3     // 比特型
 4     bool boolValue;
 5 
 6     // 有符號整型
 7     sbyte sbyteValue;
 8     short shortValue;
 9     int intValue;
10     long longValue;
11 
12     // 無符號整型
13     byte byteValue;
14     ushort ushortValue;
15     uint uintValue;
16     ulong ulongValue;
17 
18     // 有符號浮點型
19     float floatValue;
20     double doubleValue;
21 
22     // 字元型(UTF8)
23     string stringValue;
24 
25 }

數組 結構:

1 struct ArrayST {
2     int[] ids;
3     string[] names;
4 }

用戶信息 結構:

 1 struct UserInfoST {
 2 
 3     uint id;
 4     string username;
 5     string nickname;
 6     int hp;
 7     int mp;
 8     long exp;
 9     long gold;
10     byte age;
11     bool isVip;
12 
13 }

各語言類型對照表

共計38種

數據類型說明：

1.對bool型的支持最好，一個bool型只占1位(1/8個位元組)。
2.支持變長整數(short、int、long、ushort、uint、ulong)
3.支持null值 (能空的類型string, array, object，都支持它們為空的情況)
4.建議在定義數據格式時，用儘量小的類型定義欄位，這樣序列化的數據體積會更小，如果懶得寫，可以考慮使用變長數據。
5.支持自定義數據類型名稱，因為相同的數據類型在不同的編程語言中名字不一樣，為了方便使用，我添加了一套內置數據類型名稱並添加了一個類型名稱映射的功能，可以自定義基本值類型的名稱，按照自己喜歡的風格命名就好。
6.因為在編寫變長數據類型的過程中用到了一些不常見的數據格式，為了重用類型，索性就一起支持了，在對數據大小很嚴格的環境會有幫助，這些非常規的數據類型有:
Bit2~Bit7 占2~7位
Int24、Int40、Int48、Int56 占3、5、6、7位元組
UInt24、UInt40、UInt48、UInt56 占3、5、6、7位元組
VarLength 用於表示string和array的長度 值範圍-1~(int.MaxValue/2 - 1)

其他說明：

由於能力有限，暫時只實現了C#版本(在Unity中實現的，算半個.Net吧)
其他語言後續有時間再寫，雖然造了個輪子 不過感覺造輪子的過程中收穫遠大於付出，挺開心的。
建了個群，有需求的可加。
QQ群：715800513

項目GitHub:https://github.com/zhangyukof/litebyte

測試Demo:
鏈接：https://pan.baidu.com/s/1yQVn6f4YAkNBDnD0g86xow
提取碼：lio4

轉載請標明原文地址:https://www.cnblogs.com/zhangyukof/p/12073041.html