[Unity 3D] ET 框架網絡模塊的抽離错邦、重構與模塊化

在本文涎显,筆者介紹一下這段時間重構的 ET 網絡模塊,希望能夠遇到需要它的人吧兴猩。
ET: 一個雙端 C# Unity 游戲開發(fā)框架期吓,網絡 + 熱重載的功能亮點; Attribute + 擴展方法 + 反射的底層驅動邏輯倾芝;ECS 架構特色讨勤。

前言

做一個飛屏軟件,負責技術的同事敲定用 ET 晨另,emmm.... 內心是抗拒的潭千,畢竟項目不大,但反過來想想借尿,項目不大正好是個學習 ET 的契機刨晴。
因為我負責控制端,用不到熱更路翻,并且習慣了在 Unity 內做開發(fā)狈癞,所以我決定把 ET 的網絡模塊剝離出來,用在我負責的控制端上茂契,這樣一來蝶桶,既能夠與 ET 后臺對接,也能保持我自己的開發(fā)習慣掉冶。

當然真竖,非要說細節(jié)上為啥抗拒,其實是有幾點的厌小,作為 ET 0 基礎小白斗膽小聲BB幾句:

  1. 為了熱重載恢共,嚴格約束用戶按照 ET ECS 架構開發(fā),因此開發(fā)一個應用得整好幾個解決方案璧亚,而且還不是常規(guī)的打開方式讨韭,跨解決方案的引用查找還挺難(可能是我太菜哈)。
  2. 不需要熱更涨岁,ILRuntime 插件冗余了拐袜,不能忍,如果考慮熱更那也只會是對現(xiàn)有開發(fā)模式無侵入的 HCLR梢薪。
  3. 修改在 Model 、 Hotfix 程序集尝哆,需要編譯才能看到修改的效果秉撇,而開啟自動編譯一度讓我困惑。
  4. 框架文件結構限定的比較死,由于很多路徑都是寫死在邏輯中琐馆,原本僅有一個 Server 规阀,一個 Client,想要做 一個 Server + 兩個 Client 令初次接觸 ET 的我無從下手(當然瘦麸,現(xiàn)在整明白了谁撼,改一些腳本中文件夾路徑就行,按說 ET7 啥都內斂到了 Unity 內部滋饲,也不預設熱更方案也就沒有這些痛點了)厉碟。

抽離

  • 更新 ET6.0 Github最新提交后,一通復制粘貼屠缭,把網絡部分梳理到新工程中
  • 轉移 Protobuf箍鼓、Litjson 、ETTask呵曹、Timer 款咖、KCP 到新工程。
  • 刪除 Litjson 奄喂、Protobuf 中為適配 ILRuntime 而撰寫的邏輯铐殃。
  • 此時,網絡模塊已經大體抽離跨新,然后再根據(jù)報錯背稼,將缺失的、離散在周邊的腳本匯集整理玻蝌。
  • 到了這一步蟹肘,網絡模塊還是 ECS 架構的(由于模塊無需熱更, ECS 沒有拆分在各個程序集)所以一通改造俯树,把各個功能模塊的 ECS 整合成單腳本(其實就是把 Component的字段帘腹,System 中的 Awake 、Update 等方法整到一起许饿,使用 MonoBehaviour 驅動)阳欲。
  • ET EventSystem ,ET 的心臟陋率,用于在啟動或熱重載時根據(jù) Attribute 做 Type 預綁定球化,同時也是一個事件總線。網絡模塊瓦糟、ECS以及事件分發(fā)都依賴它筒愚,一通刪除,保留網絡消息類型注冊部分即可菩浙。
  • 斷開對 ET Entity 的依賴:刪除繼承關系巢掺,同時將 GetChild 句伶、AddChild 進行簡單的改寫成實例查詢和實例構建就好了。
  • 兩個有意思的地方:LitJson 保留是為了 網絡消息實例以 json 輸出陆淀,方便log考余;KCP 最后被干掉了是因為 ET6.0 為了通用,即便是 KServer 轧苫、KChannel 也默認不使用 KCP楚堤。

重構

  • 管理器性質的組件都依賴了 MonoBehaviour 驅動,但他們多為管理器性質含懊,所以筆者將他們改為靜態(tài)類身冬。
  • 對管理器性質的組件的初始化放在 ET Eventsystem 中統(tǒng)一按順序進行(比如 opcode管理器就要優(yōu)先于其他消息分發(fā)管理器)。
  • 對管理器性質的組件的 Update 統(tǒng)一放在 ET Eventsystem 中統(tǒng)一使用 PlayerLoop 驅動绢要。
  • 作為底層核心網絡消息吏恭,將 Ping 消息 OuterMessage 中單獨抽離出來,實現(xiàn)網絡模塊對 OuterMessage 零依賴重罪。
  • 重新設計非 RPC 網絡消息的監(jiān)聽與取消監(jiān)聽樱哼,實現(xiàn)非 RPC 消息在繼承了 MonoBehaviour 的類更方便的被捕獲。
  • 代碼生成:實現(xiàn)非RPC 網絡消息處理器的一鍵生成剿配;修正 OuterMessage 的一鍵生成邏輯搅幅,跳過 Ping 消息。
  • 引入 Loom 做線程間數(shù)據(jù)傳遞呼胚,剔除原有的帶 Thread 關鍵字的組件茄唐,避免了不必要的依賴注入,使用 using static Loom;的形式簡化多線程間數(shù)據(jù)的投遞蝇更。

模塊化

借助 Unity 官方 Assembly Definition File 沪编,我們可以在 Unity 項目中輕松的模塊化 ET 網絡模塊。

  • 首先年扩,將依賴的插件抽離蚁廓,放在 ThirdPart,為他們加上各自的 .asmdef 文件厨幻,使其模塊化
  • 然后相嵌,將用戶自定義的消息類 (OuterMessage.cs 和 OuterOpcode.cs)抽離,網絡模塊對其 0 依賴况脆,方便隨時剔除饭宾,隨時生成,隨時更新格了。
  • 網絡模塊重構成以下形式:


可見:

  • ettask 看铆、timer 、litjson笆搓、protobuf 都成了獨立的程序集性湿。
  • 網絡核心又拆分出 editor + runtime + generated(generated 為一鍵生成的 outermessage 和 messagehandler)

使用

  1. clone 本項目纬傲,將文件夾 ET Network Module 拷貝到你的項目中(可考慮自行改為 UPM )
  2. 刪除 Generated 文件夾满败。
  3. 如果有代碼引用了 OuterMessage 中的類型肤频,則這個代碼所在的文件夾改名,加上 ~ (波浪號)完成編譯后再刪除波浪號
  4. 約定:前后端公用的 outermessage.proto 中 Ping 消息置頂算墨。
  5. 通過 Tools 菜單中提供的工具宵荒,依次生成 OuterMessage.cs 、OuterOpcode.cs 以及各個非 RPC 消息處理器
  6. 調用 ET 原生 API:call + send 實現(xiàn)通信净嘀,var response = await Session.call(new SomeRPCRequest()) 或者 Session.Send(new NoRPCRequest())
  7. 非 RPC 消息的監(jiān)聽:使用 using static MessageHandler 即可在自己的類中通過 ListenSignal 报咳、RemoveSignal 處理感興趣的網絡消息,示例代碼如下:
using ET;
using UnityEngine;
using static MessageHandler;
public class HandlerUsageCase : MonoBehaviour
{
    private void Start()
    {
        ListenSignal<M2C_CreateMyUnit>(OnMyUnitCreated);
        ListenSignal<M2C_CreateUnits>(OnUnitsCreated);
    }

    private void OnUnitsCreated(Session arg1, M2C_CreateUnits arg2)
    {
        // 撰寫你自己的邏輯
    }
    private void OnMyUnitCreated(Session arg1, M2C_CreateMyUnit arg2)
    {
        // 撰寫你自己的邏輯
    }
    private void OnDestroy()
    {
        RemoveSignal<M2C_CreateMyUnit>(OnMyUnitCreated);
        RemoveSignal<M2C_CreateUnits>(OnUnitsCreated);
    }
}

演示

演示一:消息生成挖藏,消息處理器生成

code generate

演示二:測試與 ET 服務器通信(登錄網關暑刃,登錄地圖,Ping(心跳))

寫到最后

  • 為了方便的測試此 ET 網絡模塊膜眠,提供 ET6.0 示例 Server 編譯而來的 .exe 文件岩臣,通過菜單 “Tools/Start Test Server” 開啟。
  • 需要留意的是宵膨,因為徹底的重構架谎,導致了業(yè)務邏輯代碼必不可能復用,所以 ET 服務器的 AI壓測辟躏、AI陪玩啥的怕是用不了谷扣,這點大家應該是明了的。
  • 本文配套項目地址:https://github.com/Bian-Sh/ET-Network-Module

原創(chuàng)作品捎琐,轉載請注明出處

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末会涎,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子瑞凑,更是在濱河造成了極大的恐慌末秃,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,372評論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件拨黔,死亡現(xiàn)場離奇詭異蛔溃,居然都是意外死亡,警方通過查閱死者的電腦和手機篱蝇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評論 3 392
  • 文/潘曉璐 我一進店門贺待,熙熙樓的掌柜王于貴愁眉苦臉地迎上來秧骑,“玉大人酪碘,你說我怎么就攤上這事〖俣幔” “怎么了涧衙?”我有些...
    開封第一講書人閱讀 162,415評論 0 353
  • 文/不壞的土叔 我叫張陵哪工,是天一觀的道長奥此。 經常有香客問我,道長雁比,這世上最難降的妖魔是什么稚虎? 我笑而不...
    開封第一講書人閱讀 58,157評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮偎捎,結果婚禮上蠢终,老公的妹妹穿的比我還像新娘。我一直安慰自己茴她,他們只是感情好寻拂,可當我...
    茶點故事閱讀 67,171評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著丈牢,像睡著了一般祭钉。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上己沛,一...
    開封第一講書人閱讀 51,125評論 1 297
  • 那天慌核,我揣著相機與錄音,去河邊找鬼泛粹。 笑死遂铡,一個胖子當著我的面吹牛,可吹牛的內容都是我干的晶姊。 我是一名探鬼主播扒接,決...
    沈念sama閱讀 40,028評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼们衙!你這毒婦竟也來了钾怔?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 38,887評論 0 274
  • 序言:老撾萬榮一對情侶失蹤蒙挑,失蹤者是張志新(化名)和其女友劉穎宗侦,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體忆蚀,經...
    沈念sama閱讀 45,310評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡矾利,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,533評論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了馋袜。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片男旗。...
    茶點故事閱讀 39,690評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖欣鳖,靈堂內的尸體忽然破棺而出察皇,到底是詐尸還是另有隱情,我是刑警寧澤泽台,帶...
    沈念sama閱讀 35,411評論 5 343
  • 正文 年R本政府宣布什荣,位于F島的核電站矾缓,受9級特大地震影響,放射性物質發(fā)生泄漏稻爬。R本人自食惡果不足惜嗜闻,卻給世界環(huán)境...
    茶點故事閱讀 41,004評論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望因篇。 院中可真熱鬧泞辐,春花似錦笔横、人聲如沸竞滓。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽商佑。三九已至,卻和暖如春厢塘,著一層夾襖步出監(jiān)牢的瞬間茶没,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評論 1 268
  • 我被黑心中介騙來泰國打工晚碾, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留抓半,地道東北人。 一個月前我還...
    沈念sama閱讀 47,693評論 2 368
  • 正文 我出身青樓格嘁,卻偏偏與公主長得像笛求,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子糕簿,可洞房花燭夜當晚...
    茶點故事閱讀 44,577評論 2 353

推薦閱讀更多精彩內容