強大的MongoBson庫

后端開發，統計了一下大概有這些場景需要用到序列化：

物件通過序列化反序列化clone
服務端資料庫存盤資料，二進制
分布式服務端，多行程間的訊息，二進制
后端日志，文本格式
服務端的各種組態檔，文本格式

C#序列化庫有非常非常多了，protobuf，json等等，但是這些序列化庫都無法應當所有場景，既要可讀又要小，protobuf不支持復雜的物件結構（無法使用繼承），做訊息合適，做資料庫存盤和日志格式并不好用，json做日志格式合適，但是做網路訊息和資料存盤就太大，我們當然希望一個庫能滿足上面所有場景，理由如下：

你想想某天你的組態檔需要放到資料庫中保存，你不需要進行格式轉換，后端直接把前端發過來的配置訊息保存到資料庫中，這是不是能減少非常多錯誤呢？
某天有些服務端的組態檔不用檔案格式了，需要放在資料庫中，同樣，只需要幾行代碼就可以完成遷移，
某天后端服務器crash，你需要掃描日志進行資料恢復，把日志進行反序列化成C#物件，一條條進行處理，再轉成物件保存到資料庫就完成了，
物件保存在資料庫，直接就可以看到文本內容，可以做各種類sql的操作
想像一個場景，一個配置文本物件，反序列化到記憶體，通過網路訊息發送，存盤到資料庫中，整個程序一氣呵成，

簡單來說就是減少各種資料轉換，減少代碼，提高開發效率，提高可維護性，當然，Mongo Bson就能夠滿足，MongoDB庫既可以序列化成文本也可以序列化成BSON的二進制格式，并且MongoDB本身就是一個游戲中使用非常多的資料庫，Mongo Bson非常完善，是我見過功能最全使用最強大的序列化庫，有些功能十分貼心，其支持功能如下：

支持復雜的繼承結構
支持忽略某些欄位序列化
支持欄位默認值
結構多出多余的欄位照樣可以反序列化，這對多版本協議非常有用
支持ISupportInitialize介面使用，這個在反序列化的時候簡直就是神器
支持文本json和二進制bson序列化
MongoDB資料庫支持

簡單的介紹下mongo bson庫

1.支持序列化反序列化成json或者bson

public sealed class Player
    {
        public long Id;

        public string Account { get; private set; }

        public long UnitId { get; set; }
    }

    Player player1 = new Player() { Id = 1 };
    string json = player1.ToJson();
    Console.WriteLine($"player1 to json: {json}");
    Console.WriteLine($"player to bson: {player.ToBson().ToHex()}");
    // output:
    // player to json: { "_id" : NumberLong(1), "C" : [], "Account" : null, "UnitId" : NumberLong(0) }
    // player to bson: B000000125F69640001000000000000000A4163636F756E740012556E6974496400000000000000000000

注意mongo的json跟標準的json有點區別，如果想用標準的json，可以傳入一個JsonWriterSettings物件，限制使用JsonOutputMode.Strict模式

// 使用標準json
    Player player2 = new Player() { Id = 1 };
    Console.WriteLine($"player to json: {player2.ToJson(new JsonWriterSettings() {OutputMode = JsonOutputMode.Strict})}");
    // player to json: { "_id" : 1, "C" : [], "Account" : null, "UnitId" : 0 }

反序列化json:

            // 反序列化json
        Player player11 = BsonSerializer.Deserialize<Player>(json);
        Console.WriteLine($"player11 to json: {player11.ToJson()}");

反序列化bson:

    // 反序列化bson
    using (MemoryStream memoryStream = new MemoryStream(bson))
    {
        Player player12 = (Player) BsonSerializer.Deserialize(memoryStream, typeof (Player));
        Console.WriteLine($"player12 to json: {player12.ToJson()}");
    }

2.可以忽略某些欄位

[BsonIgnore]該標簽用來禁止欄位序列化，

    public sealed class Player
    {
        public long Id;

        [BsonIgnore]
        public string Account { get; private set; }
        
        public long UnitId { get; set; }
    ｝

    Player player = new Player() { Id = 2, UnitId = 3, Account = "panda"};
    Console.WriteLine($"player to json: {player.ToJson()}");
    // player to json: { "_id" : 2, "UnitId" : 3 }

3.支持默認值以及取別名

[BsonElement] 欄位加上該標簽，即使是private欄位也會序列化(默認只序列化public欄位)，該標簽還可以帶一個string引數，給欄位序列化指定別名，

    public sealed class Player
    {
        public long Id;

        public string Account { get; private set; }

        [BsonElement("UId")]
        public long UnitId { get; set; }
    ｝
    Player player = new Player() { Id = 2, UnitId = 3, Account = "panda"};
    Console.WriteLine($"player to json: {player.ToJson()}");
    // player to json: { "_id" : 2, "Account" : "panda", "UId" : 3 }

4.升級版本支持

[BsonIgnoreExtraElements] 該標簽用在class上面，反序列化時用來忽略多余的欄位，一般版本兼容需要考慮，低版本的協議需要能夠反序列化高版本的內容,否則新版本加了欄位，舊版本結構反序列化會出錯

    [BsonIgnoreExtraElements]
    public sealed class Player
    {
        public long Id;

        public string Account { get; private set; }

        [BsonElement("UId")]
        public long UnitId { get; set; }
    ｝

5.支持復雜的繼承結構

mongo bson庫強大的地方在于完全支持序列化反序列化繼承結構，需要注意的是，繼承反序列化需要注冊所有的父類，有兩種方法： a. 你可以在父類上面使用[BsonKnownTypes]標簽宣告繼承的子類，這樣mongo會自動注冊，例如:

    [BsonKnownTypes(typeof(Entity))]
    public class Component
    {
    }
    [BsonKnownTypes(typeof(Player))]
    public class Entity: Component
    {
    }
    public sealed class Player: Entity
    {
        public long Id;
        
        public string Account { get; set; }
        
        public long UnitId { get; set; }
    }

這樣有缺陷，因為框架并不知道一個類會有哪些子類，這樣做對框架代碼有侵入性，我們希望能解除這個耦合，可以掃描程式集中所有子類父類的型別，將他們注冊到mongo驅動中

            Type[] types = typeof(Game).Assembly.GetTypes();
            foreach (Type type in types)
            {
                if (!type.IsSubclassOf(typeof(Component)))
                {
                    continue;
                }

                BsonClassMap.LookupClassMap(type);
            }

            BsonSerializer.RegisterSerializer(new EnumSerializer<NumericType>(BsonType.String));

這樣完全的自動化注冊，使用者也不需要關心類是否注冊，

6.ISupportInitialize介面

mongo bson反序列化時支持一個ISupportInitialize介面，ISupportInitialize有兩個方法

    public interface ISupportInitialize
    {
        void BeginInit();
        void EndInit();
    }

BeginInit在反序列化前呼叫，EndInit在反序列化后呼叫，這個介面非常有用了，可以在反序列化后執行一些操作，例如

    [BsonIgnoreExtraElements]
    public class InnerConfig: AConfigComponent
    {
        [BsonIgnore]
        public IPEndPoint IPEndPoint { get; private set; }
        
        public string Address { get; set; }

        public override void EndInit()
        {
            this.IPEndPoint = NetworkHelper.ToIPEndPoint(this.Address);
        }
    }

InnerConfig是ET中行程內網地址的配置，由于IPEndPoint不太好配置，我們可以配置成string形式，然后反序列化的時候在EndInit中把string轉換成IPEndPoint，同樣我給protobuf反序列化方法也加上了這個呼叫，參考ProtobufHelper.cs，ET的protobuf因為要支持ilruntime，所以去掉了map的支持，假如我們想要一個map怎么辦呢？這里我給生成的代碼都做了手腳，把proto訊息都改成了partial class，這樣我們可以自己擴展這個class，比如：

message UnitInfo
{
    int64 UnitId  = 1;

    float X = 2;
    float Y = 3;
    float Z = 4;
}

// protobuf
message G2C_EnterMap // IResponse
{
    int32 RpcId = 90;
    int32 Error = 91;
    string Message = 92;
    // 自己的unit id
    int64 UnitId = 1;
    // 所有的unit
    repeated UnitInfo Units = 2;
}

這個網路訊息有個repeated UnitInfo欄位，在protobuf中其實是個陣列，使用起來不是很方便，我希望轉成一個Dictionary<Int64, UnitInfo>的欄位，我們可以做這樣的操作：

    public partial class G2C_EnterMap: ISupportInitialize
    {
        public Dictionary<Int64, UnitInfo> unitsDict = new Dictionary<long, UnitInfo>();
        
        public void BeginInit()
        {
        }

        public void EndInit()
        {
            foreach (var unit in this.Units)
            {
                this.unitsDict.Add(unit.UnitId, unit);
            }
        }
    }

通過這樣一段代碼把訊息進行擴展一下，反序列化出來之后，自動轉成了一個Dictionary，

ET開源地址地址：egametang/ET: Unity3D Client And C# Server Framework (github.com) qq群：474643097

轉載請註明出處，本文鏈接：https://www.uj5u.com/ruanti/552882.html

標籤：架構設計

上一篇：領域驅動設計DDD架構決議和繪圖模板分享

下一篇：返回列表