Unity XLua Hotfix热更新配置笔记

Unity XLUA Hotfix热更新配置笔记

---

目录

Unity XLUA Hotfix热更新配置笔记

---

配置热更新步骤：

• 下载XLUA
• 下载压缩包解压 复制xlua 和plugins到assets
• 开启热补丁特性 先添加宏 HOTFIX_ENABLE;INJECT_WITHOUT_TOOL
• 报“This delegate/interface must add to CSharpCallLua : XXX”异常怎么解决？
• .require XXX 调用Lua脚本 具体脚本参考官方文档 lua文件放在Resources下
• Tips：

---

 

• 下载XLua

• 传送门

官网：

https://github.com/Tencent/xLua

配置文档：

https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/hotfix.md

官方FAQ：

https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/faq.md

代码生成引擎：

https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/custom_generate.md

Lua5.3官方手册：

https://www.lua.org/manual/5.3/manual.html

 

• 下载压缩包解压 复制XLua和plugins到assets，Tool复制在Assets同级目录下

• 开启热补丁特性 先添加宏 HOTFIX_ENABLE;INJECT_WITHOUT_TOOL

注意：两个宏都要添加（），官方FAQ说

报“This delegate/interface must add to CSharpCallLua : XXX”异常怎么解决？

在编辑器下xLua不生成代码都可以运行，出现这种提示，要么是该类型没加CSharpCallLua，要么是加之前生成过代码，没重新执行生成。

解决办法，确认XXX（类型名）加上CSharpCallLua后，清除代码后运行。

如果编辑器下没问题，发布到手机报这错，表示你发布前没生成代码（执行“XLua/Generate Code”）。

亲测两个宏都必须要加

 

HOTFIX_ENABLE：开启热更新特性，编辑器，各手机平台需要手动单独设置，如果是自动化打包，要注意在代码里用API设置的宏是不生效的，需要在编辑器里设置。
     INJECT_WITHOUT_TOOL：采用内嵌到编辑器的方式注入。添加了该宏之后，在菜单栏XLUA里才能够进行【Hotfix inject in Editor】的操作；在构建手机包的时候这个步骤会在构建时自动进行，编辑器模式下开发补丁需要手动执行Hotfix inject in Editor进行注入。
     定义INJECT_WITHOUT_TOOL宏后，热补丁特性依赖Cecil，添加HOTFIX_ENABLE宏之后，可能会报找不到Cecil。这时你需要到Unity安装目录下找到Mono.Cecil.dll，Mono.Cecil.Pdb.dll，Mono.Cecil.Mdb.dll，拷贝到项目里头。
    注意：如果你的Unity安装目录没有Mono.Cecil.Pdb.dll，Mono.Cecil.Mdb.dll（往往是一些老版本），那就只拷贝Mono.Cecil.dll（你从别的版本的Unity拷贝一套可能会导致编辑器不稳定），这时你需要定义HOTFIX_SYMBOLS_DISABLE，
    这会导致C#代码没法调试以及Log的栈源文件及行号错乱（所以赶紧升级Unity）。

    以上两个宏若是不开启，或者在没有成功进行Hotfix inject in Editor操作直接运行的话，系统会抛出 LuaException: xlua.access, no field __Hotfix0_hotfix

 

随后执行XLua/Generate Code菜单。热补丁需要执行XLua/Generate Code才能正常运行。

注入，构建手机包这个步骤会在构建时自动进行，编辑器下开发补丁需要手动执行”XLua/Hotfix Inject In Editor“菜单。

注入成功会打印“hotfix inject finish!”或者“had injected!”。

 

• .require XXX 调用Lua脚本 具体脚本参考官方文档 lua文件放在Resources下

main.lua.txt

local list = require("PatchList");
for _,filename in ipairs(list) do
    require(filename);
end

PatchList.lua.txt

return {
    "Patch1",
};

Patch1.lua.txt

---xlua.private_accessible(CS.MyMessage.ShowMessage);  这个似乎有bug
 
xlua.hotfix(CS.MyMessage.ShowMessage, 'show', function(self)  
 local go= CS.UnityEngine.GameObject.Find("HotfixTextTip")
 go.GetComponent(go,"Text").text="热更新完成"
end)

ShowMessage.cs

namespace MyMessage
{

    public class ShowMessage
    {
        public void Update()
        {
            show();
        }

        void show()
        {
            GameObject go = GameObject.Find("message");
            go.GetComponent().text = "公告：暂无公告";
        }
    }
}

 

• Tips：

反复执行lua文件需要重新构建LuaEnv

热更新类和函数需要标签[Hotfix]或者
 [Hotfix]
        public static List hotfixList
        {
            get
            {
                string[] allowNamespaces = new string[] {
                    "命名空间",
                };

                return (from type in Assembly.Load("Assembly-CSharp").GetTypes()
                        where allowNamespaces.Contains(type.Namespace)
                        select type).ToList();
            }

        }
在Assets\XLua\Src\Editor 使用 HotfixConfig.cs 添加白名单

xlua.hotfix(class, [method_name], fix)

描述 ： 注入lua补丁
class ： C#类，两种表示方法，CS.Namespace.TypeName或者字符串方式"Namespace.TypeName"，字符串格式和C#的Type.GetType要求一致，如果是内嵌类型（Nested Type）是非Public类型的话，只能用字符串方式表示"Namespace.TypeName+NestedTypeName"；
method_name ： 方法名，可选；
fix ： 如果传了method_name，fix将会是一个function，否则通过table提供一组函数。table的组织按key是method_name，value是function的方式。

---

• 官方文档

https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/hotfix.md

 

---

官方文档

• 使用方式
• 约束
• API
• 标识要热更新的类型
• Hotfix Flag
• 使用建议
• 打补丁

---

使用方式

1、添加HOTFIX_ENABLE宏打开该特性（在Unity3D的File->Build Setting->Scripting Define Symbols下添加）。编辑器、各手机平台这个宏要分别设置！如果是自动化打包，要注意在代码里头用API设置的宏是不生效的，需要在编辑器设置。

（建议平时开发业务代码不打开HOTFIX_ENABLE，只在build手机版本或者要在编译器下开发补丁时打开HOTFIX_ENABLE）

2、执行XLua/Generate Code菜单。

3、注入，构建手机包这个步骤会在构建时自动进行，编辑器下开发补丁需要手动执行"XLua/Hotfix Inject In Editor"菜单。注入成功会打印“hotfix inject finish!”或者“had injected!”。

约束

不支持静态构造函数。

目前只支持Assets下代码的热补丁，不支持引擎，c#系统库的热补丁。

API

xlua.hotfix(class, [method_name], fix)

• 描述 ： 注入lua补丁
• class ： C#类，两种表示方法，CS.Namespace.TypeName或者字符串方式"Namespace.TypeName"，字符串格式和C#的Type.GetType要求一致，如果是内嵌类型（Nested Type）是非Public类型的话，只能用字符串方式表示"Namespace.TypeName+NestedTypeName"；
• method_name ： 方法名，可选；
• fix ： 如果传了method_name，fix将会是一个function，否则通过table提供一组函数。table的组织按key是method_name，value是function的方式。

base(csobj)

• 描述 ： 子类override函数通过base调用父类实现。
• csobj ： 对象
• 返回值 ： 新对象，可以通过该对象base上的方法

例子（位于HotfixTest2.cs）：

xlua.hotfix(CS.BaseTest, 'Foo', function(self, p)
    print('BaseTest', p)
    base(self):Foo(p)
end)

util.hotfix_ex(class, method_name, fix)

• 描述 ： xlua.hotfix的增强版本，可以在fix函数里头执行原来的函数，缺点是fix的执行会略慢。
• method_name ： 方法名；
• fix ： 用来替换C#方法的lua function。

标识要热更新的类型

和其它配置一样，有两种方式

方式一：直接在类里头打Hotfix标签（不建议，示例只是为了方便演示采取这种方式）；

方式二：在一个static类的static字段或者属性里头配置一个列表。属性可以用于实现的比较复杂的配置，比如根据Namespace做白名单。

//如果涉及到Assembly-CSharp.dll之外的其它dll，如下代码需要放到Editor目录
public static class HotfixCfg
{
    [Hotfix]
    public static List by_field = new List()
    {
        typeof(HotFixSubClass),
        typeof(GenericClass<>),
    };

    [Hotfix]
    public static List by_property
    {
        get
        {
            return (from type in Assembly.Load("Assembly-CSharp").GetTypes()
                    where type.Namespace == "XXXX"
                    select type).ToList();
        }
    }
}

Hotfix Flag

Hotfix标签可以设置一些标志位对生成代码及插桩定制化

• Stateless、Stateful

遗留设置，Stateful方式在新版本已经删除，因为这种方式可以用xlua.util.state接口达到类似的效果，该接口的使用可以看下HotfixTest2.cs里的示例代码。

由于没Stateful，默认就是Stateless，所以也没必要设置该标志位。

• ValueTypeBoxing

值类型的适配delegate会收敛到object，好处是代码量更少，不好的是值类型会产生boxing及gc，适用于对text段敏感的业务。

• IgnoreProperty

不对属性注入及生成适配代码，一般而言，大多数属性的实现都很简单，出错几率比较小，建议不注入。

• IgnoreNotPublic

不对非public的方法注入及生成适配代码。除了像MonoBehaviour那种会被反射调用的私有方法必须得注入，其它仅被本类调用的非public方法可以不注入，只不过修复时会工作量稍大，所有引用到这个函数的public方法都要重写。

• Inline

不生成适配delegate，直接在函数体注入处理代码。

• IntKey

不生成静态字段，而是把所有注入点放到一个数组集中管理。

好处：对text段影响小。

坏处：使用不像默认方式那么方便，需要通过id来指明hotfix哪个函数，而这个id是代码注入工具时分配的，函数到id的映射会保存在Gen/Resources/hotfix_id_map.lua.txt，并且自动加时间戳备份到hotfix_id_map.lua.txt同级目录，发布手机版本后请妥善保存该文件。

该文件的格式大概如下（注意：该文件仅IntKey模式使用，当你没类型指定IntKey模式注入，该文件只返回个空表）：

return {
    ["HotfixTest"] = {
        [".ctor"] = {
            5
        },
        ["Start"] = {
            6
        },
        ["Update"] = {
            7
        },
        ["FixedUpdate"] = {
            8
        },
        ["Add"] = {
            9,10
        },
        ["OnGUI"] = {
            11
        },
    },
}

想要替换HotfixTest的Update函数，你得

CS.XLua.HotfixDelegateBridge.Set(7, func)

如果是重载函数，将会一个函数名对应多个id，比如上面的Add函数。

能不能自动化一些呢？可以，xlua.util提供了auto_id_map函数，执行一次后你就可以像以前那样直接用类，方法名去指明修补的函数。

(require 'xlua.util').auto_id_map()
xlua.hotfix(CS.HotfixTest, 'Update', function(self)
        self.tick = self.tick + 1
        if (self.tick % 50) == 0 then
            print('<<<<<<< 
  
使用建议
 
  
 
   
对所有较大可能变动的类型加上Hotfix标识；
 
   
建议用反射找出所有函数参数、字段、属性、事件涉及的delegate类型，标注CSharpCallLua；
 
   
业务代码、引擎API、系统API，需要在Lua补丁里头高性能访问的类型，加上LuaCallCSharp；
 
   
引擎API、系统API可能被代码剪裁调（C#无引用的地方都会被剪裁），如果觉得可能会新增C#代码之外的API调用，这些API所在的类型要么加LuaCallCSharp，要么加ReflectionUse；
 
  
 
  
打补丁
 
  
xlua可以用lua函数替换C#的构造函数，函数，属性，事件的替换。lua实现都是函数，比如属性对于一个getter函数和一个setter函数，事件对应一个add函数和一个remove函数。
 
  
 
   
函数
 
  
 
  
method_name传函数名，支持重载，不同重载都是转发到同一个lua函数。
 
  
比如：
 
  
// 要fix的C#类
[Hotfix]
public class HotfixCalc
{
    public int Add(int a, int b)
    {
        return a - b;
    }

    public Vector3 Add(Vector3 a, Vector3 b)
    {
        return a - b;
    }
｝
xlua.hotfix(CS.HotfixCalc, 'Add', function(self, a, b)
    return a + b
end)
 
  
静态函数和成员函数的区别是，成员函数会加一个self参数，这个self在Stateless方式下是C#对象本身（对应C#的this）
 
  
普通参数对于lua的参数，ref参数对应lua的一个参数和一个返回值，out参数对于lua的一个返回值。
 
  
泛化函数的打补丁规则和普通函数一样。
 
  
 
   
构造函数
 
  
 
  
构造函数对应的method_name是".ctor"。
 
  
和普通函数不一样的是，构造函数的热补丁并不是替换，而是执行原有逻辑后调用lua。
 
  
 
   
属性
 
  
 
  
对于名为“AProp”的属性，会对应一个getter，method_name等于get_AProp，setter的method_name等于set_AProp。
 
  
 
   
[]操作符
 
  
 
  
赋值对应set_Item，取值对应get_Item。第一个参数是self，赋值后面跟key，value，取值只有key参数，返回值是取出的值。
 
  
 
   
其它操作符
 
  
 
  
C#的操作符都有一套内部表示，比如+号的操作符函数名是op_Addition（其它操作符的内部表示可以去请参照相关资料），覆盖这函数就覆盖了C#的+号操作符。
 
  
 
   
事件
 
  
 
  
比如对于事件“AEvent”，+=操作符是add_AEvent，-=对应的是remove_AEvent。这两个函数均是第一个参数是self，第二个参数是操作符后面跟的delegate。
 
  
通过xlua.private_accessible（版本号大于2.1.11不需要调用xlua.private_accessible）来直接访问事件对应的私有delegate的直接访问后，可以通过对象的"&事件名"字段直接触发事件，例如self['&MyEvent']()，其中MyEvent是事件名。
 
  
 
   
析构函数
 
  
 
  
method_name是"Finalize"，传一个self参数。
 
  
和普通函数不一样的是，析构函数的热补丁并不是替换，而是开头调用lua函数后继续原有逻辑。
 
  
 
   
泛化类型
 
  
 
  
其它规则一致，需要说明的是，每个泛化类型实例化后都是一个独立的类型，只能针对实例化后的类型分别打补丁。比如：
 
  
public class GenericClass
{
｝
 
  
你只能对GenericClass，GenericClass这些类，而不是对GenericClass打补丁。
 
  
对GenericClass打补丁的实例如下：
 
  
luaenv.DoString(@"
    xlua.hotfix(CS.GenericClass(CS.System.Double), {
        ['.ctor'] = function(obj, a)
            print('GenericClass', obj, a)
        end;
        Func1 = function(obj)
            print('GenericClass.Func1', obj)
        end;
        Func2 = function(obj)
            print('GenericClass.Func2', obj)
            return 1314
        end
    })
");
 
  
 
   
Unity协程
 
  
 
  
通过util.cs_generator可以用一个function模拟一个IEnumerator，在里头用coroutine.yield，就类似C#里头的yield return。比如下面的C#代码和对应的hotfix代码是等同效果的
 
  
[XLua.Hotfix]
public class HotFixSubClass : MonoBehaviour {
    IEnumerator Start()
    {
        while (true)
        {
            yield return new WaitForSeconds(3);
            Debug.Log("Wait for 3 seconds");
        }
    }
}
luaenv.DoString(@"
    local util = require 'xlua.util'
    xlua.hotfix(CS.HotFixSubClass,{
        Start = function(self)
            return util.cs_generator(function()
                while true do
                    coroutine.yield(CS.UnityEngine.WaitForSeconds(3))
                    print('Wait for 3 seconds')
                end
            end)
        end;
    })
");
 
  
 
   
整个类
 
  
 
  
如果要替换整个类，不需要一次次的调用xlua.hotfix去替换，可以整个一次完成。只要给一个table，按method_name = function组织即可
 
  
xlua.hotfix(CS.StatefullTest, {
    ['.ctor'] = function(csobj)
        return util.state(csobj, {evt = {}, start = 0, prop = 0})
    end;
    set_AProp = function(self, v)
        print('set_AProp', v)
        self.prop = v
    end;
    get_AProp = function(self)
        return self.prop
    end;
    get_Item = function(self, k)
        print('get_Item', k)
        return 1024
    end;
    set_Item = function(self, k, v)
        print('set_Item', k, v)
    end;
    add_AEvent = function(self, cb)
        print('add_AEvent', cb)
        table.insert(self.evt, cb)
    end;
    remove_AEvent = function(self, cb)
       print('remove_AEvent', cb)
       for i, v in ipairs(self.evt) do
           if v == cb then
               table.remove(self.evt, i)
               break
           end
       end
    end;
    Start = function(self)
        print('Start')
        for _, cb in ipairs(self.evt) do
            cb(self.start, 2)
        end
        self.start = self.start + 1
    end;
    StaticFunc = function(a, b, c)
       print(a, b, c)
    end;
    GenericTest = function(self, a)
       print(self, a)
    end;
    Finalize = function(self)
       print('Finalize', self)
    end
})