Unity 游戏用XLua的HotFix实现热更原理揭秘

Posted 2021-04-30 dotNET跨平台

本文通过对XLua的HoxFix使用原理的研究揭示出来这样的一套方法。这个方法的第一步：通过对C#的类与函数设置Hotfix标签。来标识需要支持热更的类和函数。第二步：生成函数连接器来连接LUA脚本与C#函数。第三步：在C#脚本编译结束后，使用Mono提供的一套C#的API函数，对已经编译过的.Net体系生成的DLL文件进行修改。第四步，通过LUA脚本修改C#带有标签的类中静态变量，把代码的执行路径修改到LUA脚本中。通过这套方案可以实现对已经标识的C#代码进行动态更新。

基础准备

知识准备

CIL: 通用中间语言（Common Intermediate Language，简称CIL）, 是一种属于通用语言架构和 .NET 框架的低阶（lowest-level）的人类可读的编程语言。目标为 .NET 框架的语言被编译成CIL（基于.NET框架下的伪汇编语言，原：MSIL），这是一组可以有效地转换为本机代码且独立于 CPU 的指令。CIL类似一个面向对象的汇编语言，并且它是完全基于堆栈的。它运行在CLR上（类似于JVM），其主要支持的语言有C#、VisualBasic .NET、C++/CLI以及 J#（集成这些语言向CIL的编译功能）。

在编译.NET编程语言时，源代码被翻译成CIL码，而不是基于特定平台或处理器的目标代码。CIL是一种独立于具体CPU和平台的指令集，它可以在任何支持.NET framework的环境下运行。CIL码在运行时被检查并提供比二进制代码更好的安全性和可靠性。在Unity3D中，是用过Mono虚拟机来实现运行这些中间语言指令的。

之前写一篇介绍过一篇使用微软的API函数，利用中间语言生成或注入.NET支持下的DLL。这里就不在赘述，需要了解的请参考《使用MSIL采用Emit方式实现C#的代码生成与注入》。

 

使用Mono的时候，脚本的编译运行如下图所示：

简单的来说，3大脚本被编译成IL，在游戏运行的时候，IL和项目里其他第三方兼容的DLL一起，放入Mono VM虚拟机，由虚拟机解析成机器码，并且执行

IL2CPP做的改变由下图红色部分标明：

在得到中间语言IL后，使用IL2CPP将他们重新变回C++代码，然后再由各个平台的C++编译器直接编译成能执行的原生汇编代码。

 

开启IL2CPP的Unity构建流程：unity构建流程分步：

第一步：平台资源处理，主要生成Library\metadata下面的文件。

第二步：脚本编译(主要是C#脚本)，Library\ScriptAssemblies下的Dll，主要是Assembly-CSharp.dll 和Assembly-CSharp-Editor.dll这两个Dll。

第三步：把这个Assembly-CSharp.dll编译成C++代码。在ios中，这里是导出Xcode的工程。Andriod中直接生成APK。

第四步：在IOS中，编译Xcode，生成IPA。Andriod没有这一步。

代码注入方式

函数与属性

       首先需要加入Mono.Cecil库 在Unity安装目录下 Editor\Data\Managed可以找到。

       建立一个可以编辑AssemblyDefinition类。

AssemblyDefinitionassembiy = AssemblyDefinition.ReadAssembly(FileName);

获取中间语言的类型

    foreach (Mono.Cecil.TypeDefinitioniteminassembiy.MainModule.Types)

      Console.Write("\nMainModule.Types" +  item.Name);

获取指定类型的元素

item.Methods

获取属性的方法

item.Properties

注入代码

      注入代码的函数需要的参数：

AssemblyDefinitionassembiy  可以编辑的IL语言的定义集合。

MethodDefinitionmethod  需要修改的函数方法

TypeDefinitionitem   需要修改的函数所属于的类

Instructionins = method.Body.Instructions[0]; // 获取指定函数的指令集合

ILProcessorkWorker = method.Body.GetILProcessor(); //获取修改指令集

kWorker.InsertBefore(ins, kWorker.Create(OpCodes.Nop)); // 在固定指令之前加入代码

 

ILProcessor函数介绍

Replace(Instructiontarget, Instructioninstruction); 指令替换

Append(Instructioninstruction);  增加指令

InsertAfter(Instructiontarget, Instructioninstruction);在指令指令之前插入新指令

InsertAfter(Instructiontarget, Instructioninstruction);在指令指令之后插入新指令

 

Create(OpCodeopcode); //创建新指令

Emit(OpCodeopcode); // 默认注入在当前函数最后插入对象指令。

关于IL指令，请参考《使用MSIL采用Emit方式实现C#的代码生成与注入》

工具准备

使用指南:能把C#生成二进制文件转换为MSIL 或者C# 任选一种，当想用Emit实现某一功能但是不知道怎么写时，可以先把该功能的C#代码写出来，再用ILSpy将其转换成MSIL，然后转化为C#先查看是否能够显示出来。

测试环境准备

本节主要介绍如何能够构成一个可以测试代码注入的环境。

第一步：建立C#代码代码如下：

[Hotfix]

publicclassHotfixTest : MonoBehaviour {

    LuaEnvluaenv = newLuaEnv();

    publicinttick = 0; //如果是private的，在lua设置xlua.private_accessible(CS.HotfixTest)后即可访问

    //Update is called once per frame

    voidUpdate () {

        if (++tick % 50 == 0){

            Debug.Log(">>>>>>>>Updatein C#, tick = " + tick);

       }

    }

 

    voidOnGUI() {

        if (GUI.Button(newRect(10, 100,300, 150), "Hotfix")){

            luaenv.DoString(@"

               xlua.hotfix(CS.HotfixTest, 'Update', function(self)

                   self.tick = self.tick + 1

                   if (self.tick % 50) == 0 then

                       print('<<<<<<<

       self.tick = self.tick + 1

       if (self.tick % 50) == 0 then

            print('<<<<<<<

    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

        xlua.access(cs, cflag.. '__Hitfix0_'..k, f) -- at least one

        pcall(function()

           for i = 1, 99 do

               xlua.access(cs, '__Hitfix'..i..'_'..k, f)

           end

        end)

    end

end

通过Access修改

在Access对应的C#代码是XLuaAccess代码处理。下面主要处理函数修改的功能如下：

ObjectTranslatortranslator = ObjectTranslatorPool.Instance.Find(L);

object obj = translator.SafeGetCSObj(L, 1);

stringfieldName = LuaAPI.lua_tostring(L, 2);

varfield = type.GetField(fieldName, bindingFlags); //获取函数名称

field.SetValue(obj, translator.GetObject(L, 3, field.FieldType)); //修改当前函数名称

修改创建函数对象

获取函数功能：ObjectTranslator.CreateDelegateBridge

DelegateBridgeBaseexist_bridge = delegate_bridges[referenced].TargetasDelegateBridgeBase;

exist_delegate = exist_bridge.GetDelegateByType(delegateType);

 

通过类型来获取函数的对象，如图所示：

publicoverrideDelegateGetDelegateByType(Typetype){

    if (type == typeof(__Gen_Hotfix_Delegate0)){

        returnnew__Gen_Hotfix_Delegate0(__Gen_Delegate_Imp1);

    }

}

总结

       本文主要揭示了Hoxfix的运行机制，便于能够更好的使用Xlua的热更机制。进一步了解C#的标签、代码生成、以及代码注入的机制。这种机制能够运行与Andriod和IOS平台。同时也能对是否使用IL2CPP没有影响。

---

.NET社区新闻，深度好文，微信中搜索dotNET跨平台或扫描二维码关注