Unity3d之xlua游戏中的热更新

TheLudGamer

热更新手把手简单实例带你入门：Unity3D之xlua热更新例子
什么是热更新

热：就是刚出炉
简单来说就是当游戏某个功能出现bug，或者修改了某个功能，或者增加了某个功能的时候，我们不需要重新下载安装安装包，就可以更新游戏内容。
热更新的好处：不用浪费流量重新下载，不用通过商店审核更加快速，不用重新安装玩家可以更快体验到更新的内容
目前比较受欢迎的热更新方案：uLua tolua xLua
热更新方案

这些热更新方案都是基于Lua语言的，也可以叫做lua插件（可以运行lua，并实现了lua和C#交互的插件）。
所以本质上这些热更新方案就是一个lua插件，可以运行lua，并实现了lua和C#交互的插件。
1，（luainterface cs2lua tolua）–>ulua(不再维护，转到主要维护tolua)
2，tolua（基于tolua开发了luaframework）
3，slua代码质量好，性能比tolua低
4，C#light、LSharp同一个作者（商用比较少）
开发过程：
首先开发业务代码->在所有可能出现问题的类上打上hotfix的标签，在所有lua调用CSharp的方法上打上LuaCallCSharp,在所有CSharp调用Lua的方法上打上CSharpCallLua->打包发布->修改bug时只需要更新Lua文件，修改资源时（声音，模型，贴图，图片，UI）只需要更新ab包。用户只需要去下载lua文件跟ab包。
xlua作者博文：腾讯开源手游热更新方案：Unity3D下的XLua方案介绍
XLua官方教程
IL（中间语言）
自定义Loader

在xLua加自定义loader是很简单的，只涉及到一个接口：
public delegate byte[] CustomLoader(ref string filepath);
public void LuaEnv.AddLoader(CustomLoader loader)
通过AddLoader可以注册个回调，该回调参数是字符串，lua代码里头调用require时，参数将会透传给回调，回调中就可以根据这个参数去加载指定文件，如果需要支持调试，需要把filepath修改为真实路径传出。该回调返回值是一个byte数组，如果为空表示该loader找不到，否则则为lua文件的内容。 有了这个就简单了，用IIPS的IFS？没问题。写个loader调用IIPS的接口读文件内容即可。文件已经加密？没问题，自己写loader读取文件解密后返回即可。。。 完整示例见XLua\Tutorial\LoadLuaScript\Loader

1. using System.Collections;using System.Collections.Generic;using UnityEngine;using XLua;using System.IO;publicclassCreateLoader:MonoBehaviour{void Start (){LuaEnv env =newLuaEnv();
3.         env.AddLoader(MyLoader);//自定义loader加载lua文件。
5.         env.DoString("require 'test007'");//require实际上是调一个个的loader去加载，有一个成功就不再往下尝试，全失败则报文件找不到。
7.         env.Dispose();}privatebyte[]MyLoader(refstring filePath){string absPath = Application.streamingAssetsPath +"/"+ filePath +".lua.txt";return System.Text.Encoding.UTF8.GetBytes(File.ReadAllText(absPath));//字符串转换字节数组}}

复制代码

C#访问Lua例子

csharpcalllua.lua.txt

1. print("csharpcalllua")
2. a = 100.1
3. str = "siki"
4. isDie = false
6. person = {
7.         name="siki",age=100,12,2,2,2,2,"siki",true,3.3,
8.         eat=function(self,a,b)
9.                 print(a+b)
10.         end
11. }
13. function add(a,b)
14.         print(a+b)
15.         return a+b,a,b
16. end

复制代码

CsharpCallLua.cs

1. using System.Collections;using System.Collections.Generic;using UnityEngine;using XLua;using System;publicclassCSharpCallLua:MonoBehaviour{// Use this for initializationvoid Start (){LuaEnv luaEnv =newLuaEnv();
3.         luaEnv.DoString("require 'CSharpCallLua'");//  number  --  int float double //double a = luaEnv.Global.Get<double>("a");//获取到lua里面的全局变量 a//print(a);//string str = luaEnv.Global.Get<string>("str");//获取到lua里面的全局变量 a//print(str);//bool isDie = luaEnv.Global.Get<bool>("isDie");//获取到lua里面的全局变量 a//print(isDie);//1,通过class(struct)//Person p = luaEnv.Global.Get<Person>("person");//print(p.name+"-"+ p.age+"-"+p.age2);//p.name = "Sikiedu.com";//luaEnv.DoString("print(person.name)");//2,通过interface//IPerson p = luaEnv.Global.Get<IPerson>("person");//print(p.name+"-"+p.age);//p.name = "Sikiedu.com";//luaEnv.DoString("print(person.name)");//p.eat(12,34);//  p.eat(p,12,34);//3,通过Dictionary、List//Dictionary<string, object> dict = luaEnv.Global.Get<Dictionary<string, object>>("person");//foreach(string key in dict.Keys)//{//    print(key + "-" + dict[key]);//}//List<object> list = luaEnv.Global.Get<List<object>>("person");//foreach (object o in list)//{//    print(o);//}//4,通过LuaTable//LuaTable tab= luaEnv.Global.Get<LuaTable>("person");//print(tab.Get<string>("name"));//print(tab.Get<int>("age"));//print(tab.Length);//访问Lua中的全局函数//不带参数//Action act1 = luaEnv.Global.Get<Action>("add");//act1();//act1 = null;//1、映射到Delegate//Add add = luaEnv.Global.Get<Add>("add");//int resa=0; int resb=0;//int res = add(34, 78,out resa,out resb);//print(res);//print(resa);//print(resb);//add = null;//2、映射到LuaFunction//LuaFunction func = luaEnv.Global.Get<LuaFunction>("add");//object[] os= func.Call(1, 2);//foreach(object o in os)//{//    print(o);//}
5.         luaEnv.Dispose();}[CSharpCallLua]delegateintAdd(int a,int b,outint resa,outint resb);classPerson{publicstring name;publicint age;publicint age2;}[CSharpCallLua]interfaceIPerson{string name {get;set;}int age {get;set;}voideat(int a,int b);}}

复制代码

Lua访问C#例子

lua脚本：

1. --构造游戏物体，new对象
2. --CS.UnityEngine.GameObject("new by lua")
4. print(CS.UnityEngine.Time.deltaTime)
6. CS.UnityEngine.Time.timeScale = 0.5
8. local gameObject = CS.UnityEngine.GameObject
10. local camera = gameObject.Find("Main Camera")
12. camera.name = "update by lua"
13. --调用成员方法的时候，使用冒号(调用成员方法，第一个参数需要传该对象，建议用冒号语法糖，如下)
14. --local cameraCom= camera.GetComponent(camera,"Camera")
15. local cameraCom= camera:GetComponent("Camera")
16. gameObject.Destroy(cameraCom)
18. local light = gameObject.Find("Direction Light")

复制代码

LuaCallCsharp.cs

1. using System.Collections;using System.Collections.Generic;using UnityEngine;using XLua;enum EnemyType
2. {
3.     Normal,
4.     Hard,
5.     NB
6. }publicclassLuaCallCSharp:MonoBehaviour{void Start (){LuaEnv luaEnv =newLuaEnv();
7.    
8.         luaEnv.DoString("require 'LuaCallCSharp'");
10.         luaEnv.Dispose();}}

复制代码

实战热更新操作

xlua迁入和hotfix配置

github下载xLua包，Assets目录复制到目标目录的Assets

tools工具包打包

将这个复制到目标项目的根目录
切换到xlua的hotfix的案例：https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/hotfix.md
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!”才算成功，否则会打印错误信息。
如下图

配置成功