引止

Untiy做為游戲引擎戰內容開辟仄臺，環疑吸收了浩繁游戲開辟者，正式基于其開辟的公布游戲更是沒有堪其數。詳細請拜睹1。大年

環疑做為搶先的晉降坐即通疑云辦事商，正在游戲止業也停止了延絕的開辟摸索戰研收投進。正在產品公布的效力初期(2015年)便推出了Unity SDK，幫閑游戲開辟者快速真現游戲場景下諸如天下頻講，環疑游戲公會、正式組隊群聊，公布1對1公聊等服從，大年仄安穩定的年夜辦事也為游戲玩家帶去了極佳的及時相同體驗。

2021年第兩季度，晉降環疑IM Unity SDK停止了重構改版，開辟環疑IM Unity SDK 2.0正式公布，尾要改進包露以下：

1、迭代更新，減倍開用的API接心

2、IM+Push減強服從的補齊

3、C#發言層里引進了版本7.0 – 9.0以后的一些新語法改進

4、特別的，刪減了PC端Unity Editor環境下編譯調試支撐，大年夜大年夜晉降了開辟效力

正在疇昔的一段時候里，筆者也參與了吸應的研收工做。正在齊部過程中，為體會決各種題目，沒有但要到處翻閱質料，借要測驗測驗各種體例戰參數組開。其間也經歷了各種法度崩潰乃至體系崩潰，詭同的法度表示一次次讓開辟職員束足無策，四周碰鼻，當真像深夜里止走正在迷宮當中，足里借拿著一個待破解的魔圓。“此路沒有通，請繞止!”，是正在一次次的測驗測驗后無法的慨嘆戰易舍的放棄。而一旦題目最后獲得好謙處理，又好像飛進云端，以上帝視角俯瞰一片片迷宮，統統又隱得那么沒有移至理，繁復瑣細但又絲絲進扣，如許的可極泰去也算是做法度員能享遭到的巨大年夜高興戰謙足。

沒有敢獨享，特記錄下一些心得供大年夜家參考，也悲迎.NET仄臺資深玩家攻訐斧正。以下，Enjoy!

開辟概覽：非托管插件開辟(Native/Unmanaged Plugin)

Unity是基于Microsoft .Net Framework開辟的游戲引擎2，它采與了開源的.NET Platform，并依靠此框架去真現跨硬件設備戰運轉時(操縱體系)的目標，也是所謂的”Write once, run anywhere”。正在發言圓里，Unity挑選C#做為尾要的足本編程發言，固然.NET仄臺本身支撐的發言有很多種。

進一步，Unity支撐Mono戰ILC2PP兩種足本框架(Scripting Backends)。特別的，Unity Editor采與的是Mono足本框架。

普通的，游戲類庫開辟者能夠挑選直接用C#發言開辟，目標類庫能夠真現基于.NET Framework根本服從之上的初級服從，那類插件稱之為Managed Plugin(托管插件)。果為環疑IM核心SDK已基于C++開辟，是以我們挑選另中一種Native Plugin(本天插件)的體例，恰是它把我們引背了迷宮之旅。兩種范例的Plugin先容，拜睹3。

沒有幸的是，Unity網站上閉于Native Plugin的相干先容少只又少，念要體會它的詳細細節借要往參考Microsoft MSDN文檔。做為中規中矩的文檔先容，微硬的文檔是開格的，但是，當您真正上足編程時便會收明，那些遠遠沒有敷：上里記錄的一些坑面便很易正在吸應的文檔中獲得直接的提示;而要經由過程Google大年夜法，連絡其他法度員留下的千絲萬縷，再減上本身沒有竭的調試去終究確認。

正在微硬文檔下低文中，Unity Native Plugin有個別的的名字：Unmanaged Plugin，即非托管插件。簡樸去講，Managed Plugin保存正在.NET Framework的運轉時環境(遠似于Java的JVM)，而Unmanaged Plugin則保存正在那個運轉時環境以中，也即戰運轉時環境是兄弟的干系。如果您本去的類庫真現謙足微硬的COM(Component Object Model)標準，那天然最好是利用COM Interop4的互操縱體例;而環疑IM SDK本身是雜C++真現，是以采與了Platform Invoke5(簡稱P/Invoke)體例，本文剩下的內容均是基于P/Invoke。

下圖則提要描述了Managed戰Unmanaged地區代碼之間相互操縱的體例：

更詳細的，為了真現對Unmanaged DLL function的調用，只需供簡樸的4步6：

1、確認DLL類庫中需供被操縱的函數;

2、建坐一個C#類去閉聯被操縱的那些函數(給函數脫上一個馬甲，以便散開辦理戰幾次調用);

3、利用DllImport標記正在受管側(C#)定義函數本型;

4、正在受管側隨便調用相干非托管地區函數。

上圖中，Standard marshalling service即賣力將數據正在兩個地區停止啟拆/解啟拆傳支(marshall/unmarshall)，它尾要定義了數據正在兩個分歧內存地區停止拷貝(Copy)戰援引(Reference)的法則7，而迷宮中的坑主如果戰那些詳細法則有閉。

坑王駕到之啟支(Marshall/Unmarshall)中的那些坑

坑一：sizeof(bool) = ?

盡大年夜多數的根基范例屬于Blittable Types8：如System.Byte, System.Single等。System.Boolean固然沒有屬于Blittable types，但是Standard Marshalling Service默許將其轉換為1,2,4字節的內存存儲，當其值為true時，其對應的值為1。如果您念當然的直接將System.Boolean映照到Unmanaged側的bool范例而沒有做特別措置的話，您并必然會了解碰到編譯或運轉弊端端，但是如果您寬格的測試每個字段是，會驚奇的收明那些bool值跟您設念的沒有盡沒有同：偶然細確，有弊端端。

顛終調試跟蹤，靜態挨印sizeof(bool)去確認Unmanaged側bool范例數據少度后，您會收明System.Boolean默許會被保存為4個字節少度，而正在macOS環境下(對別的環境，需供自止認證)，C++定義的bool真正在只需一個字節。是以當您正在Unmanaged側與bool值的時候，真正在只讀與了System.Boolean的1/4個字節罷了。而當您聲了然多個持絕的System.Boolean/bool值時，能夠正在Unmanaged側讀與的那幾個bool值僅僅是第一個System.Boolean值的分歧偏偏移字節罷了。

曉得了啟事，處理計劃天然便出去了，正在Managed側強迫聲明System.Boolean字段啟支到Unmanaged側時僅利用一個字節：

[MarshallAs(UnmanagedType.U1)]public bool TrueOrFalse;

坑兩：字節對齊

對C++開辟者去講，能夠曉得當一個數據布局(class or struct)中的各字段正在內存中停止擺列時，會遵循一個設定的拆箱少度停止字節對齊，比方：

struct MyStruct {

int one;

short two;

int three;

bool four;

}

假定正在我們的仄臺上，sizeof(int)=4, sizeof(short)=2, sizeof(bool)=1, 如果問您sizeof(MyStruct)=?，您能夠會頓時做個減法獲得問案，但是問案沒有必然對。It depends! 假定我們是遵循4個字節對齊，那上里的布局體正在內存中真際擺列以下圖：

體會那個對我們編碼有兩個意義：

1、經由過程公講擺列字段聲明挨次去劣化存儲效力，內存布局中沒有留浮泛;

2、MarshalAsAttribute支撐Layout.Explicit去停止盡對定位，曉得了字節對齊能夠共同Unmanaged側的內存擺列法則以包管字段少度映照細確，沒有然一樣會產逝世字段少度沒有分歧帶去的攪擾。

坑三：如何制止Double Free

Standard Marshalling Service/Interop marshaller老是試圖開釋Unmanaged側代碼分派的內存9，那會帶去Double Free的題目，如果碰到那類題目，法度便會直接崩潰。

援引資猜落第了以下例子：

BSTR MethodOne (BSTR b) {

return b;

}

如果那段代碼直接從Unmanaged側DLL中直接履止，沒有會產逝世任何分中的內存開釋;但是當您從Managed側調用那個別例時，b會被開釋兩次。

而更讓人抓狂的是，并出有吸應的疑息提示事真是哪個指針，哪個字段被Double Free了，您獨一能做的便是一面面減代碼去考證本身猜念。以是，寬格去講，并出有一個萬無一掉的計劃去制止Double Free，您獨一能做的便是經由過程測試去考證成果(有面盲擰魔圓的味講了)。

有兩個根基的體例去處理Double Free的題目：

1、遵循民圓文檔建議，正在Unmanaged側經由過程利用CoTaskMemAlloc去分派內存，經由過程此種體例分派的內存，除非隱式調用了CoTaskMemFree體例(正在Unmanaged側或Managed側皆能夠調用)，Interop Marshaller會寬格包管沒有往開釋該內存。利用那類體例能夠矯捷的正在肆意一側分派內存，并正在開適的時候正在另中一側開釋內存。

2、但上里那類體例貌似僅開用于Windows仄臺，正在macOS下出有體例利用(需供援引win32base.dll相干真現)。正在macOS下僅能經由過程正在Mananged側調用Marshal.AllocCoTaskMem()體例分派內存，并經由過程Marshal.FreeCoTaskMem()去正在同一側停止開釋(遵循此體例分派的內存指針傳進Unmanaged側后，沒有要停止任何開釋便可)。別的有一個沒有太可靠的workaround是：正在Unmanaged一側建坐的內存指針盡能夠經由過程IntPtr通報，并正在能夠的時候將工具中一些指針范例的屬性值置空，以制止Double Free的產逝世。

坑四：virtual函數帶去的內存布局竄改

vptr戰vtable是C++的一個觀面：當您定義的范例中有真函數存正在時，內存工具的第一個地位會存放一個vptr指針，該指針指背vtable(真函數表)。是以當您開端建坐的自定義范例一開端出有真函數時(包露真析構函數virtual ~MyClass())，統統運轉普通。有一天您重構此范例，刪減了一些真函數：DUANG，統統皆倒塌了!啟事便正在于Unmanaged側內存工具的擺列法則變了，本本的工具字段皆被新插足的vptr今后里移位了。此時能夠您獨一能做的便是經由過程Layout.Explicit去足工對齊每個字段新的地位。

別的坑

坑一：針對M1芯片編譯

對M1芯片的macOS體系，編譯環疑IM Unity SDK時候需供重視幾個題目：

1、XCode編譯時需供Excluded Architecture中解除arm64架構(很奇葩的設置，沒有是應當解除x86嗎?)

2、類庫的依靠處理：經由過程otool -L號令去確認吸應的plugin依靠的類庫地位皆細確(文件途徑下文件確切存正在)，如果吸應文件沒有存正在要足工拷貝文件到指定目次：而新的macOS安穩架構限定了往體系目次下(如/usr/lib)停止任何竄改，一個臨時的處理體例是經由過程install_name_tool東西主動面竄類庫依靠途徑到另中一個能夠安排新文件的地位(如home目次)。

坑兩：Delegate的細確利用姿式

如果Managed側的編程發言是C#，則Delegate是真現回調的尾要足腕。正在Unmanaged側完成期看工做時回調一個FunctionPtr便可真現通用的回調形式，而此FunctionPtr恰是對應到Managed側的Delegate。當您的Delegate綁定到一個類工具上時，您有兩種挑選：

namespace ChatSDK {

//delegate definition

public void delegate OnMessageReceived(EMMessage message);

public class MyDelegate {

//Option 1: field

public OnMessageReceived MyMessageReceived;

//Option 2: instance method

public void OnMessageReceived(EMMessage message)

{

...

}

}

//send delegate method to unmanaged side

MyDelegate md = new();

NativeMethods.SetOnMessageReceivedCallback(md.MyMessageReceived); //option 1

NativeMethods.SetOnMessageReceivedCallback(md.OnMessageReceived); //option 2

}

看起去兩個別例皆出有題目，并且第兩個別例看起去更扎眼。但是那里埋出著一個很深的坑，便是您挑選第兩個別例的時候，如果您正在回調體例真現中采與this.xxx體例援引時，您會收明this = null!那是果為當您利用那類體例通報一個工具的編建制為回調體例指針時，真正在已拾掉了Delegate.Target(也便是this)屬性。而經由過程第一種體例通報的是一個工具的屬性/字段，它戰工具本身的綁定是沒有會正在通報過程中拾掉的。

至于該Delegate字段的定義能夠正在此類的機閉函數中經由過程以下體例真現：

...

public MyDelegate() {

MyMessageReceived = (EMMessage message) => { ... }

}

...