實現一個簡單的Unity網路同步引擎——netgo
實現一個簡單的Unity網路同步引擎Netgo
目前GOLANG有大行其道的趨勢，尤其是在網路程式設計方面。因為和c/c++比較起來，雖然GC佔用了一部分機器效能，但是出錯概率小了，開發效率大大提升，而且應用其原生支援的協程很容易就能開發出高併發的服務端程式。筆者接觸VR行業兩年有餘，接觸了一些商業unity網路引擎，總覺的用的東西都落伍了，於是自己寫了一個簡單的引擎。目前實現了的基本功能：
- 支援房間概念。
- 支援靈活的資料同步方式，包括幀同步和RPC。
- 支援自定義事件的傳送。
也實現了一個簡單的demo，同步效果見下圖，後面會有更詳細的介紹。
專案地址：https://github.com/netgo-framework
資料通訊格式
資料通訊格式的定義是整個專案的基石。我們這裡的客戶端和服務端是跨平臺，跨語言通訊。因此要定義一種語言無關，平臺無關並且簡單易用，高效不費流量的資料格式。這裡我們選用了Google的 Protobuf，詳細介紹參考這篇帖子。
Protobuf的C#程式碼庫有兩種選擇，一種是protobuf-net,一種是protobuf-csharp-port,前者的介面書寫更加符合C# 語法規範，會讓人看起來更舒服一些。如果需要跨平臺的話，推薦使用後者，因為不同語言的介面書寫比較類似，開發起來會更容易一些。看看原作者的回覆。
定義proto檔案
如何使用protobuf呢，首先要書寫proto檔案，定義自己的結構化資料，在netgo中，下面是netgo中定義的訊息體的一部分：
enum CacheOptions{ AddToRoomCache = 0; RemoveFromRoomCache = 1; } message NGVector3{ float x = 1; float y = 2; float z = 3; } message NGQuaternion{ float x = 1; float y = 2; float z = 3; float w = 4; } message NGColor{ float r = 1; float g = 2; float b = 3; float a = 4; }
完整定義參考。
生成c#和golang API介面檔案
更新好名稱空間後，執行下面的命令生成API檔案：
golang
protoc --go_out=. *.proto
c#
protoc --csharp_out=. *.proto
服務端網路模型
一個Unity網路同步引擎的實現包括服務端和客戶端兩部分。Nego 是Unity網路同步引擎的服務端，使用golang實現，充分利用了它的原生協程來實現高併發。其網路模型基於gotcp來實現。
參考上圖，netgo會為每個socket連結建立一個協程，一個socket協程內部建立三個協程：
- ReadLoop 用於從網路端讀取資料並放入Channel中。
- HandleLoop 用於解析應用層資料並完成相應處理，並將處理後的資料通過Channel傳送給WriteLoop。
- WriteLoop 負責將處理結果forward給其它客戶端或者response給本客戶端。
參考程式碼：
func (c *Conn) Do() {
if !c.srv.callback.OnConnect(c) {
return
}
asyncDo(c.handleLoop, c.srv.waitGroup)
asyncDo(c.readLoop, c.srv.waitGroup)
asyncDo(c.writeLoop, c.srv.waitGroup)
}客戶端程式碼結構
寫API基本上是面向使用者程式設計，筆者以為，清晰的程式碼結構，好的命名方式能省掉大部分註釋，程式碼寫的亂只能靠註釋來拯救，程式碼結構看下圖：
按照名稱空間，分為 Library,網路層和應用層（以後使用者介面層會分出來）.
相關概念
資料同步
這裡的同步是指一個房間內的資料同步，一個房間記憶體在著來自網路上的多個終端使用者，每個Client都會將房間內其它人的資料在本地做一個Clone，而資料同步是指將你自己的資料同步到其他Cient你自己的Clone上面，因此傳送範圍是其它使用者都會接收。
資料同步分為一下兩種：
- View Sync
View Sync是毫秒級別的資料同步。可用於虛擬角色動作同步。
- RPC
每次同步由使用者手動觸發。可用於換裝等同步。
Custom Event
Custom Event不是向所有其它Client的Clone實體傳送同步訊息，而是向一個或者幾個指定的Client傳送訊息。
介面介紹
房間相關介面
請求介面
//加入或者建立房間
public static void JoinOrCreateRoom(string roomid,uint maxnumber)
//建立房間
public static void CreateRoom(string roomid, uint maxnumber)
//加入房間
public static void JoinRoom(string roomid)
//離開房間
public static void LeaveRoom()回撥介面
//建立房間成功
void OnGreatedRoom();
//建立房間失敗
void OnGreateRoomFailed(string errmsg);
//加入房間成功
void OnJoinedRoom();
//加入房間失敗
void OnJoinRoomFailed();
//離開房間成功
void OnLeftRoom();Player相關介面
//例項化一個物體
public static void Instantiate(string prefabname, Vector3 position, Quaternion rotation, uint[] viewids)
//有其它使用者進入房間
void OnOtherPlayerEnteredRoom(NGPlayer player);
//有其它使用者離開房間
void OnOtherPlayerLeftRoom(NGPlayer player);CustomEvent介面
請求介面
//傳送事件
public static void SendCustomEvent(uint eventid, uint[] targetpeerids, NGAny[] customdata)
回撥介面
//接收事件
void OnCustomEvent(uint eventID, NGAny[] data);View Sync
檢視同步需要自己實現元件指令碼，實現序列化反序列化介面，並且需要掛載到物體上：
public interface INGSerialize
{
void SerializeViewComponent(NGViewStream stream);
void DeserializeViewComponent(NGViewStream stream);
}
public class CubeViewComponent : NGIncomingEvent, INGSerialize
{
public void SerializeViewComponent(NGViewStream stream)
{
stream.Send(this.transform.position);
stream.Send(this.transform.rotation);
}
public void DeserializeViewComponent(NGViewStream stream)
{
mCorrentPosition = (NGVector3)stream.Receive();
mCorrentRotation = (NGQuaternion)stream.Receive();
}
}Clone實體接受資料反序列化後在Update中實時更新即可：
void Update()
{
if (!view.IsMine)
{
transform.position = mCorrentPosition;//Vector3.Lerp(transform.position, mCorrentPosition, Time.deltaTime * 5);
transform.rotation = mCorrentRotation;//Quaternion.Lerp(transform.rotation, mCorrentRotation, Time.deltaTime * 5);
}
}RPC
使用RPC需要在檢視指令碼中寫一個RPC函式：
[NGRPCMethod]
public void OnColor(NGAny[] c)
{
mMat.color = c[0].NgColor;
}呼叫下面的介面向其它Clone實體傳送RPC呼叫：
public static void SendRPC(uint viewID, string methodname, RPCTarget target, params NGAny[] parameters)有關RPC，View Sync和Custom Event 的詳細使用方法 參考原始碼
Demo演示
服務端部署
Clone程式碼
git clone https://github.com/netgo-framework/netgo.git安裝依賴
go get -d ./...更新監聽IP
開啟main.go
tcpAddr, err := net.ResolveTCPAddr("tcp", "192.168.0.104:8686")啟動服務
go run main.go客戶端編譯安裝
客戶端支援windows/MacOS/Andorid/IOS多平臺。下面在Android和MacOS上測試：
配置IP和埠
切換Android平臺
編譯生成APK
安裝APK後的初始化介面如下：
功能測試
兩個Client進入同一個房間，每個Client會例項化出來兩個Cube，一個為本機實體（Mine Cube）,一個為對方的實體（Clone Cube）。
View SYnc
點選按鈕Move後，會通過檢視同步的方式進行postion和rotation同步。也就是文章剛開始的動圖展示的樣子：
RPC
點選Mine Cube之後，Cube的顏色會發生變化，同時同步到別的機器上，這裡的顏色同步是通過RPC來實現的。
Custom Event
點選Clone Cube之後，會向對方實體傳送訊息，效果是對方的Mine Cube Scale會增加。
Road Map
接下來考慮會加入或者需要優化的功能：
- 支援大廳功能
- 支援負載均衡
- 增加支援UDP等網路傳輸協議
- 增加支援json等多種資料編碼格式
- View Sync資料傳輸優化
- 支援跨房間Custom Event
- .....