目前大部分手遊都會採用熱更新來解決應用商店稽核週期長，無法滿足快節奏迭代的問題。另外熱更新能夠有效降低版本升級所需的資源大小，節省玩家的時間和流量，這也使其成為移動遊戲的主流更新方式之一。
熱更新可以分為資源熱更和程式碼熱更兩類，其中程式碼熱更又包括Lua熱更和C#熱更。Lua作為一種輕量小巧的指令碼語言，由Lua虛擬機器解釋執行。所以Lua熱更通過簡單的原始碼檔案替換即可完成。反觀C#的整個編譯執行過程是先通過編譯器將C#編譯成IL（Intermediate Language），再由CLR（Common Language Runtime）將IL編譯成平臺相關的二進位制機器碼進行執行。
在JIT（Just in time）模式下可以做到執行時將IL編譯成機器碼，此時如果C#利用反射動態載入程式集，則通過替換DLL檔案即可完成C#熱更。雖然Android是支援JIT的，但IOS並不支援，IOS僅支援AOT（Ahead of time）模式。且Mono在IOS平臺上使用的是Full AOT模式，會在程式執行前就將IL編譯成機器碼。如果使用反射執行DLL檔案，就會觸發Mono的JIT編譯器，而Full AOT模式又不允許JIT，就會報以下錯誤
ExecutionEngineException: Attempting to JIT compile method '...' while running with --aot-only.
所以C#通過反射熱更的方式在不同平臺並不通用。
基於IL程式碼注入熱更
最後只剩下基於IL程式碼注入的C#熱更方案了，這也是xLua框架熱更所採用的方案。它的基本思想是，對於一個類
public class TestXLua
{
public int Add(int a, int b)
{
return a - b;
}
}
通過在IL層面為其注入程式碼，使其變成類似這樣
public class TestXLua
{
static Func<object, int, int, int> hotfix_Add = null;
int Add(int a, int b)
{
if (hotfix_Add != null) return hotfix_Add(this, a, b);
return a - b;
}
}
然後通過Lua編寫補丁，使hotfix_Add指向一個lua的適配函式，從而達到替換原C#函式，實現更新的目的。
根據xLua熱更新操作指南，使用xLua熱更主要有以下4個步驟
1、開啟該特性
新增HOTFIX_ENABLE巨集，（在Unity3D的File->Build Setting->Scripting Define Symbols下新增）。編輯器、各手機平臺這個巨集要分別設定！如果是自動化打包，要注意在程式碼裡頭用API設定的巨集是不生效的，需要在編輯器設定。
2、執行XLua/Generate Code選單。
3、注入，構建手機包這個步驟會在構建時自動進行，編輯器下開發補丁需要手動執行"XLua/Hotfix Inject In Editor"選單。列印“hotfix inject finish!”或者“had injected!”才算成功，否則會列印錯誤資訊。
4、使用xlua.hotfix或util.hotfix_ex打補丁
接下來將逐個分析上述步驟背後都做了些什麼，是如何一步步基於IL程式碼注入實現熱更的
開啟HOTFIX_ENABLE巨集
HOTFIX_ENABLE是xLua定義啟用熱更的一個巨集，新增這個巨集主要有兩個作用
- 在編輯器中出現"XLua/Hotfix Inject In Editor"選單，通過該選單可以手動執行程式碼注入
- 利用HOTFIX_ENABLE進行了條件編譯，定義了一些只有使用熱更時才需要的方法。例如DelegateBridge.cs中的部分方法，這些方法會在針對泛型方法進行IL注入時用到
// DelegateBridge.cs #if HOTFIX_ENABLE private int _oldTop = 0; private Stack<int> _stack = new Stack<int>(); public void InvokeSessionStart() { // ... } public void Invoke(int nRet) { // ... } public void InvokeSessionEnd() { // ... } // ... #endif
生成程式碼
生成程式碼的作用，主要是為標記有Hotfix特性的方法生成對應的匹配函式。以新增了Hotfix特性的TestXLua為例
// 測試用 TestXLua.cs
[Hotfix]
public class TestXLua
{
public int Add(int a, int b)
{
return a - b; // 這裡的Add方法故意寫成減法，後面通過熱更新修復
}
}
會在配置的Gen目錄下生成DelegatesGensBridge.cs檔案，其中有為TestXLua.Add生成的對應的匹配函式__Gen_Delegate_Imp1
// DelegatesGensBridge.cs
public partial class DelegateBridge : DelegateBridgeBase
{
// ...
public int __Gen_Delegate_Imp1(object p0, int p1, int p2)
{
#if THREAD_SAFE || HOTFIX_ENABLE
lock (luaEnv.luaEnvLock)
{
#endif
RealStatePtr L = luaEnv.rawL;
int errFunc = LuaAPI.pcall_prepare(L, errorFuncRef, luaReference);
ObjectTranslator translator = luaEnv.translator;
translator.PushAny(L, p0);
LuaAPI.xlua_pushinteger(L, p1);
LuaAPI.xlua_pushinteger(L, p2);
PCall(L, 3, 1, errFunc);
int __gen_ret = LuaAPI.xlua_tointeger(L, errFunc + 1);
LuaAPI.lua_settop(L, errFunc - 1);
return __gen_ret;
#if THREAD_SAFE || HOTFIX_ENABLE
}
#endif
}
// ...
}
為什麼需要生成對應的匹配函式呢？這是因為xLua就是通過將該C#函式替換成Lua函式來實現熱更的。也就是說，熱更後就會出現C#呼叫Lua函式的情況，而C#想要呼叫Lua函式，就需要用到生成的匹配函式。具體流程是，呼叫傳遞給C#的Lua函式時，相當於呼叫以"__Gen_Delegate_Imp"開頭的生成函式，這個生成函式負責引數壓棧，並通過儲存的索引獲取到真正的Lua function，然後使用lua_pcall完成Lua function的呼叫。
關於C#如何呼叫Lua方法的詳細介紹可以參考這篇文章
注入
點選"XLua/Hotfix Inject In Editor"選單後會開始注入程式碼。將觸發HotfixInject方法，內部再通過xLua提供的工具XLuaHotfixInject.exe來完成程式碼注入。應該是為了避免檔案佔用問題，所以直接提供了exe工具。同時IL程式碼注入需要用到Mono.Cecil庫，這樣也避免了每個專案都要額外整合這個庫。
// Hotfix.cs
[MenuItem("XLua/Hotfix Inject In Editor", false, 3)]
public static void HotfixInject()
{
HotfixInject("./Library/ScriptAssemblies");
}
通過檢視exe工具原始碼可知，最終實際完成程式碼注入的還是在Hotfix.cs檔案中定義的過載方法HotfixInject，相關程式碼通過XLUA_GENERAL巨集做了條件編譯。
// Hotfix.cs
public static void HotfixInject(string injectAssemblyPath, string xluaAssemblyPath, IEnumerable<string> searchDirectorys, string idMapFilePath, Dictionary<string, int> hotfixConfig)
{
AssemblyDefinition injectAssembly = null;
AssemblyDefinition xluaAssembly = null;
// ...
injectAssembly = readAssembly(injectAssemblyPath);
// injected flag check
if (injectAssembly.MainModule.Types.Any(t => t.Name == "__XLUA_GEN_FLAG"))
{
Info(injectAssemblyPath + " had injected!");
return;
}
// 新增一個新的型別定義，以標記已注入
injectAssembly.MainModule.Types.Add(new TypeDefinition("__XLUA_GEN", "__XLUA_GEN_FLAG", ILRuntime.Mono.Cecil.TypeAttributes.Class,
injectAssembly.MainModule.TypeSystem.Object));
xluaAssembly = (injectAssemblyPath == xluaAssemblyPath || injectAssembly.MainModule.FullyQualifiedName == xluaAssemblyPath) ?
injectAssembly : readAssembly(xluaAssemblyPath);
Hotfix hotfix = new Hotfix();
hotfix.Init(injectAssembly, xluaAssembly, searchDirectorys, hotfixConfig);
//var hotfixDelegateAttributeType = assembly.MainModule.Types.Single(t => t.FullName == "XLua.HotfixDelegateAttribute");
var hotfixAttributeType = xluaAssembly.MainModule.Types.Single(t => t.FullName == "XLua.HotfixAttribute");
var toInject = (from module in injectAssembly.Modules from type in module.Types select type).ToList(); // injectAssembly中的各個型別
foreach (var type in toInject)
{
if (!hotfix.InjectType(hotfixAttributeType, type))
{
return;
}
}
Directory.CreateDirectory(Path.GetDirectoryName(idMapFilePath));
hotfix.OutputIntKeyMapper(new FileStream(idMapFilePath, FileMode.Create, FileAccess.Write));
File.Copy(idMapFilePath, idMapFilePath + "." + DateTime.Now.ToString("yyyyMMddHHmmssfff"));
// 寫入對程式集的修改
writeAssembly(injectAssembly, injectAssemblyPath);
Info(injectAssemblyPath + " inject finish!");
// ...
}
其中，injectAssemblyPath表示要注入的程式集，例如./Library/ScriptAssemblies\Assembly-CSharp.dll。xluaAssemblyPath表示LuaEnv所在程式集的完全限定路徑，一般情況下和injectAssemblyPath相同。HotfixInject的主要任務是遍歷injectAssembly中的所有型別，通過InjectType依次對它們進行程式碼注入
// Hotfix.cs
public bool InjectType(TypeReference hotfixAttributeType, TypeDefinition type)
{
foreach(var nestedTypes in type.NestedTypes)
{
if (!InjectType(hotfixAttributeType, nestedTypes))
{
return false;
}
}
if (type.Name.Contains("<") || type.IsInterface || type.Methods.Count == 0) // skip anonymous type and interface
{
return true;
}
CustomAttribute hotfixAttr = type.CustomAttributes.FirstOrDefault(ca => ca.AttributeType == hotfixAttributeType); // 獲取type上的HotfixAttribute
HotfixFlagInTool hotfixType;
// 僅對帶有HotfixAttribute的型別或hotfixCfg中有配置的型別進行注入
if (hotfixAttr != null)
{
hotfixType = (HotfixFlagInTool)(int)hotfixAttr.ConstructorArguments[0].Value; // 獲取HotfixAttribute建構函式的第一個引數，HotfixFlag
}
else
{
if (!hotfixCfg.ContainsKey(type.FullName))
{
return true;
}
hotfixType = (HotfixFlagInTool)hotfixCfg[type.FullName];
}
// 通過HotfixFlag的不同設定過濾要注入的方法
bool ignoreProperty = hotfixType.HasFlag(HotfixFlagInTool.IgnoreProperty);
bool ignoreCompilerGenerated = hotfixType.HasFlag(HotfixFlagInTool.IgnoreCompilerGenerated);
bool ignoreNotPublic = hotfixType.HasFlag(HotfixFlagInTool.IgnoreNotPublic);
bool isInline = hotfixType.HasFlag(HotfixFlagInTool.Inline);
bool isIntKey = hotfixType.HasFlag(HotfixFlagInTool.IntKey);
bool noBaseProxy = hotfixType.HasFlag(HotfixFlagInTool.NoBaseProxy);
if (ignoreCompilerGenerated && type.CustomAttributes.Any(ca => ca.AttributeType.FullName == "System.Runtime.CompilerServices.CompilerGeneratedAttribute")) // 忽略由編譯器生成的型別
{
return true;
}
if (isIntKey && type.HasGenericParameters)
{
throw new InvalidOperationException(type.FullName + " is generic definition, can not be mark as IntKey!");
}
//isIntKey = !type.HasGenericParameters;
foreach (var method in type.Methods)
{
if (ignoreNotPublic && !method.IsPublic)
{
continue;
}
if (ignoreProperty && method.IsSpecialName && (method.Name.StartsWith("get_") || method.Name.StartsWith("set_"))) // 忽略屬性
{
continue;
}
if (ignoreCompilerGenerated && method.CustomAttributes.Any(ca => ca.AttributeType.FullName == "System.Runtime.CompilerServices.CompilerGeneratedAttribute"))
{
continue;
}
if (method.Name != ".cctor" && !method.IsAbstract && !method.IsPInvokeImpl && method.Body != null && !method.Name.Contains("<"))
{
//Debug.Log(method);
if ((isInline || method.HasGenericParameters || genericInOut(method, hotfixType))
? !injectGenericMethod(method, hotfixType) :
!injectMethod(method, hotfixType))
{
return false;
}
}
}
// ...
}
InjectType的主要任務是遍歷指定型別的所有方法（根據HotfixFlag會做一些過濾），依次對它們進行程式碼注入。注入方法有兩個，一個是針對泛型方法的injectGenericMethod，一個是針對普通方法的injectMethod。兩個方法邏輯是類似的，這裡簡單起見，就主要分析injectMethod方法
// Hotfix.cs
bool injectMethod(MethodDefinition method, HotfixFlagInTool hotfixType)
{
var type = method.DeclaringType; // 方法所在類
bool isFinalize = (method.Name == "Finalize" && method.IsSpecialName);
MethodReference invoke = null;
int param_count = method.Parameters.Count + (method.IsStatic ? 0 : 1);
if (!findHotfixDelegate(method, out invoke, hotfixType)) // 找到與method匹配的生成方法，以__Gen_Delegate_Imp開頭的
{
Error("can not find delegate for " + method.DeclaringType + "." + method.Name + "! try re-genertate code.");
return false;
}
if (invoke == null)
{
throw new Exception("unknow exception!");
}
#if XLUA_GENERAL
invoke = injectAssembly.MainModule.ImportReference(invoke);
#else
invoke = injectAssembly.MainModule.Import(invoke);
#endif
FieldReference fieldReference = null;
VariableDefinition injection = null;
// IntKey是xLua的標誌位，可以控制不生成靜態欄位，而是把所有注入點放到一個陣列集中管理。這裡可以先忽略，主要看 is not IntKey的邏輯
bool isIntKey = hotfixType.HasFlag(HotfixFlagInTool.IntKey) && !type.HasGenericParameters && isTheSameAssembly;
//isIntKey = !type.HasGenericParameters;
if (!isIntKey)
{
injection = new VariableDefinition(invoke.DeclaringType); // 新建立一個XLua.DelegateBridge型別的變數
method.Body.Variables.Add(injection);
var luaDelegateName = getDelegateName(method); // 獲取將要新增的靜態變數的名稱，這個靜態變數用於儲存Lua補丁設定的方法
if (luaDelegateName == null)
{
Error("too many overload!");
return false;
}
FieldDefinition fieldDefinition = new FieldDefinition(luaDelegateName, ILRuntime.Mono.Cecil.FieldAttributes.Static | ILRuntime.Mono.Cecil.FieldAttributes.Private,
invoke.DeclaringType); // 建立一個靜態XLua.DelegateBridge變數，用於儲存Lua補丁設定的方法
type.Fields.Add(fieldDefinition); // 給type新增一個luaDelegateName靜態欄位，這個欄位值在呼叫xlua.hotfix時會賦值
fieldReference = fieldDefinition.GetGeneric();
}
bool ignoreValueType = hotfixType.HasFlag(HotfixFlagInTool.ValueTypeBoxing);
var insertPoint = method.Body.Instructions[0];
// //獲取IL處理器
var processor = method.Body.GetILProcessor();
if (method.IsConstructor)
{
insertPoint = findNextRet(method.Body.Instructions, insertPoint); // 獲取到下一個Ret指令
}
Dictionary<Instruction, Instruction> originToNewTarget = new Dictionary<Instruction, Instruction>();
HashSet<Instruction> noCheck = new HashSet<Instruction>();
// 真正的IL程式碼注入邏輯。通過Mono.Cecil庫的API插入一些IL指令
while (insertPoint != null)
{
Instruction firstInstruction;
if (isIntKey)
{
// ...
}
else
{
firstInstruction = processor.Create(OpCodes.Ldsfld, fieldReference); // 載入靜態域fieldReference，即luaDelegateName欄位
processor.InsertBefore(insertPoint, firstInstruction);
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Stloc, injection)); // 儲存本地變數，將injection變數的值設定為luaDelegateName欄位的值
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Ldloc, injection)); // 載入本地變數
}
// Brfalse表示棧上的值為 false/null/0 時發生跳轉，如果injection的值為空，就調轉到insertPoint，那通過InsertBefore插入的指令就都會被跳過了
var jmpInstruction = processor.Create(OpCodes.Brfalse, insertPoint);
processor.InsertBefore(insertPoint, jmpInstruction);
if (isIntKey)
{
// ...
}
else
{
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Ldloc, injection)); // 再載入一次injection的值
}
// 載入引數
for (int i = 0; i < param_count; i++)
{
if (i < ldargs.Length)
{
processor.InsertBefore(insertPoint, processor.Create(ldargs[i])); // 載入第i個引數
}
else if (i < 256)
{
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Ldarg_S, (byte)i));
}
else
{
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Ldarg, (short)i));
}
if (i == 0 && !method.IsStatic && type.IsValueType)
{
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Ldobj, type)); // 載入物件
}
// ...
}
// 插入方法呼叫指令
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Call, invoke)); // 呼叫injection處值（DelegateBridge物件）的方法invoke（__Gen_Delegate_Imp開頭的方法）
if (!method.IsConstructor && !isFinalize)
{
processor.InsertBefore(insertPoint, processor.Create(OpCodes.Ret)); // 插入返回指令
}
if (!method.IsConstructor)
{
break;
}
else
{
originToNewTarget[insertPoint] = firstInstruction;
noCheck.Add(jmpInstruction);
}
insertPoint = findNextRet(method.Body.Instructions, insertPoint);
}
// ...
}
injectMethod的主要邏輯是對於要注入的方法method，先找到與其相匹配的以__Gen_Delegate_Imp開頭的生成方法，然後通過IL操作為method所在類新增一個DelegateBridge型別的靜態變數（變數名通過getDelegateName方法獲得）。並在method方法頭部插入IL指令邏輯：判斷靜態變數是否不為空，如果不為空，則呼叫DelegateBridge變數的以__Gen_Delegate_Imp開頭的生成方法並直接返回不再執行原邏輯。這個生成方法在打補丁後對應的就是Lua函式。
打補丁
xlua可以通過xlua.hotfix或xlua.hotfix_ex將C#函式邏輯替換成Lua函式。例如替換TestXLua.Add方法來修復其求和演算法的錯誤
-- lua測試檔案
xlua.hotfix(CS.TestXLua, "Add", function(self, a, b)
return a + b -- 修復成正確的加法
end)
xlua.hotfix的定義在LuaEnv.cs檔案中，其中cs表示要修復的類，field表示要修復的變數名，func表示對應的修復函式
-- LuaEnv.cs
xlua.hotfix = function(cs, field, func)
if func == nil then func = false end
local tbl = (type(field) == 'table') and field or {[field] = func}
for k, v in pairs(tbl) do
local cflag = ''
if k == '.ctor' then
cflag = '_c'
k = 'ctor'
end
local f = type(v) == 'function' and v or nil
-- cflag .. '__Hotfix0_'..k 對應了前面C#程式碼中的 luaDelegateName
xlua.access(cs, cflag .. '__Hotfix0_'..k, f) -- at least one
pcall(function()
for i = 1, 99 do
xlua.access(cs, cflag .. '__Hotfix'..i..'_'..k, f)
end
end)
end
xlua.private_accessible(cs)
end
主要邏輯是，先根據一定規則計算得到真正的C#變數名，這個變數名與前面的getDelegateName方法得到的變數名相同。例如在修復TestXLua.Add的例子中，這個變數名就叫做"__Hotfix0_Add"。然後通過xlua.access方法為這個變數設定對應的Lua修復函式
// StaticLuaCallbacks.cs
public static int XLuaAccess(RealStatePtr L)
{
try
{
ObjectTranslator translator = ObjectTranslatorPool.Instance.Find(L);
Type type = getType(L, translator, 1); // 獲取第一個引數的型別
object obj = null;
if (type == null && LuaAPI.lua_type(L, 1) == LuaTypes.LUA_TUSERDATA)
{
obj = translator.SafeGetCSObj(L, 1);
if (obj == null)
{
return LuaAPI.luaL_error(L, "xlua.access, #1 parameter must a type/c# object/string");
}
type = obj.GetType();
}
if (type == null)
{
return LuaAPI.luaL_error(L, "xlua.access, can not find c# type");
}
string fieldName = LuaAPI.lua_tostring(L, 2);
BindingFlags bindingFlags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static;
if (LuaAPI.lua_gettop(L) > 2) // set 設定欄位值
{
// 設定欄位（引數2）值為引數3
var field = type.GetField(fieldName, bindingFlags);
if (field != null)
{
field.SetValue(obj, translator.GetObject(L, 3, field.FieldType));
return 0;
}
var prop = type.GetProperty(fieldName, bindingFlags);
if (prop != null)
{
prop.SetValue(obj, translator.GetObject(L, 3, prop.PropertyType), null);
return 0;
}
}
else
{
// 獲取欄位（引數2）值
var field = type.GetField(fieldName, bindingFlags);
if (field != null)
{
translator.PushAny(L, field.GetValue(obj));
return 1;
}
var prop = type.GetProperty(fieldName, bindingFlags);
if (prop != null)
{
translator.PushAny(L, prop.GetValue(obj, null));
return 1;
}
}
return LuaAPI.luaL_error(L, "xlua.access, no field " + fieldName); // 沒有找到fieldName欄位，丟擲異常
}
catch (Exception e)
{
return LuaAPI.luaL_error(L, "c# exception in xlua.access: " + e);
}
}
xlua.access實際上呼叫的是StaticLuaCallbacks.cs的XLuaAccess方法。主要功能是設定或訪問指定欄位的值。我們主要看設定欄位值的部分，引數數量大於2（引數1型別，引數2欄位名，引數3要設定的值），就表示是要設定欄位值。xlua.hotfix通過XLuaAccess是為"__Hotfix0_Add"靜態欄位設定了一個Lua函式，在C#中這個Lua函式對應的是DelegateBridge物件（其內部儲存著Lua函式的索引），這也是為什麼前面IL注入時是為類新增一個DelegateBridge型別的靜態變數
總結
以修復TestXLua.Add函式為例來描述一下整個熱更過程
先通過Generate Code為TestXLua.Add生成與其宣告相同的匹配函式"__Gen_Delegate_Imp1"，這個匹配函式是被生成在DelegateBridge類中的。有了這個匹配函式，Lua函式就可以被傳遞到C#中。
然後通過IL程式碼注入，為TestXLua新增一個名為"__Hotfix0_Add"的DelegateBridge型別的靜態變數。並在原來的Add方法中注入判斷靜態變數是否不為空，如果不為空就呼叫靜態變數所對應的Lua方法的邏輯。反編譯已注入IL程式碼的Assembly-CSharp.dll，檢視其中的TestXLua如下所示
using System;
using XLua;
// Token: 0x02000016 RID: 22
[Hotfix(HotfixFlag.Stateless)]
public class TestXLua
{
// Token: 0x06000051 RID: 81 RVA: 0x00002CE0 File Offset: 0x00000EE0
public int Add(int a, int b)
{
DelegateBridge _Hotfix0_Add = TestXLua.__Hotfix0_Add;
if (_Hotfix0_Add != null)
{
return _Hotfix0_Add.__Gen_Delegate_Imp1(this, a, b);
}
return a - b;
}
// Token: 0x06000052 RID: 82 RVA: 0x00002D14 File Offset: 0x00000F14
public TestXLua()
{
DelegateBridge c__Hotfix0_ctor = TestXLua._c__Hotfix0_ctor;
if (c__Hotfix0_ctor != null)
{
c__Hotfix0_ctor.__Gen_Delegate_Imp2(this);
}
}
// Token: 0x04000022 RID: 34
private static DelegateBridge __Hotfix0_Add;
// Token: 0x04000023 RID: 35
private static DelegateBridge _c__Hotfix0_ctor;
}
最後打補丁時通過xlua.hotfix為靜態變數"__Hotfix0_Add"設定一個Lua函式。這樣下次呼叫TestXLua.Add時，"__Hotfix0_Add"將不為空，此時將執行_Hotfix0_Add.__Gen_Delegate_Imp1，即呼叫設定的Lua函式，而不再執行原有邏輯。從而實現了C#熱修復。