使用xLua实现热更新

一、什么是热更新

简单来说，就是游戏中增加了某个功能的时候，用户只需要很少的流量进行更新游戏内容，而不需要重新下载并安装安装包。

二、xLua简介

xLua是Unity下Lua编程的解决方案，因其良好的性能、易用性、拓展性而广受好评。xLua为Unity、.Net、Mono等C#环境增加Lua脚本编程的能力，借助Lua代码可以方便的和C#相互调用。

三、xLua插件下载

浏览器打开网址：https://github.com/Tencent/xLua，
点击Clone or download——>Download ZIP，打开zip包，你会看到一个Assets目录，这目录就对应Unity工程的Assets目录，保持这目录结构放到你的Unity工程。

四、Lua文件加载

4.1、怎么在Unity中运行Lua程序呢？有两种方法：

方法1、执行字符串

using UnityEngine;
using XLua;
public class Learn01 : MonoBehaviour
{
    void Start()
    {
        //构造Lua虚拟机
        LuaEnv luaenv = new LuaEnv();
        //用LuaEnv.DoString执行一个字符串(DoString里面时Lua程序)，字符串得符合Lua语法
        //luaenv.DoString("print('hello world')");
        //释放luaenv内存
        luaenv.Dispose();
}

方法2、用lua的require函数加载Lua文件（建议使用）

require实际上是调一个个的loader去加载，有一个成功就不再往下尝试，全失败则报文件找不到。

目前xLua除了原生的loader外，还添加了从Resources加载的loader，放Resources下的lua文件得加上txt后缀，即在Resources目录下新建文本文档，假定名字为“Main.lua.txt”，该文本文档中放Lua程序。

using UnityEngine;
using XLua;
public class HelloWorld01 : MonoBehaviour
{
    private LuaEnv env;
    // Start is called before the first frame update
    void Start()
    {
        //TextAsset ta = Resources.Load<TextAsset>("HelloWorld.lua");
        //构造Lua虚拟机
        env = new LuaEnv();
        //env.DoString(ta.text);   //方法1
        //lua的require函数  引入并加载Resources文件目录下，lua文件名为"HelloWorld"的lua程序
        env.DoString("require'HelloWorld'");   //方法2
    }
    private void OnDestroy()
    {
        //程序结束时，释放luaenv内存
        env.Dispose();
    }
}

4.2、自定义Loader

要是Lua文件是下载回来的，或者某个自定义的文件格式里头解压出来，或者需要解密等等，怎么办？xLua的自定义Loader可以满足这些需求。

using System.IO;
using UnityEngine;
using XLua;
/*
 * 通过AddLoader可以注册个回调，该回调参数是字符串，lua代码里头调用require时，参数将会透传给回调，
 * 回调中就可以根据这个参数去加载指定文件，如果需要支持调试，需要把filepath修改为真实路径传出。
 * 该回调返回值是一个byte数组，如果为空表示该loader找不到，否则则为lua文件的内容。
 */
public class CreatLoader : MonoBehaviour
{
    private LuaEnv env;
    // Start is called before the first frame update
    void Start()
    {
        env = new LuaEnv();       
        env.AddLoader(MyLoad);
        env.DoString("require'TextLua01'");
    }
    private byte[] MyLoad(ref string filepath)
    {
        print(filepath);   //输出了（Lua文件名）：TextLua01
        //Lua文件路径
        string path = @"D:\Unity\MyProject\LearnLua\Assets\" + filepath + ".lua.txt";
        //读取文本
        string file = File.ReadAllText(path);
        //返回文本字节数组
        return Encoding.UTF8.GetBytes(file);
    }
    private void OnDestroy()
    {
        //程序结束时，释放luaenv内存
        env.Dispose();
    }
}

五、C#访问Lua

using System.IO;
using UnityEngine;
using XLua;
using System.Text;
/*
* C#访问Lua
*/
public class CShapeCallLua : MonoBehaviour
{
    private LuaEnv env;
    // Start is called before the first frame update
    void Start()
    {
        env = new LuaEnv();
        env.AddLoader(MyLoad);
        env.DoString("require'CSCallLua'");
        //1、访问到Lua中的全局变量a b c
        //int A = env.Global.Get<int>("a");
        //string B = env.Global.Get<string>("b");
        //float C = env.Global.Get<float>("c");
        //Debug.LogFormat("A={0},B={1},C={2}", A, B, C);

        //2、访问Lua一个全局的table
        //方法1   table为Lua中表的名称
        //Dictionary<int, object> dic = env.Global.Get<Dictionary<int, object>>("table");
        //foreach (int key in dic.Keys)
        //{
        //    print(key + "/" + dic[key]);
        //}
        //方法2   table为Lua中表的名称
        //List<object> list= env.Global.Get<List<object>>("table");
        //foreach (object item in list)
        //{
        //    print(item);
        //}
        //3、访问Lua中的全局函数  Lua中的函数名为f
        //无参函数
        //Action act = env.Global.Get<Action>("f");
        //act();
        //有参函数 有两个参数的Lua方法“eat”
        LuaFunction LuaFun = env.Global.Get<LuaFunction>("eat");
        //返回值是object的数组，对应于lua的多返回值
        object[] oArray = LuaFun.Call(3, 5);
        foreach (var item in oArray)
        {
            print(item);
        }
    }
    private byte[] MyLoad(ref string filepath)
    {
        //Lua文件路径
        string path = @"D:\Unity\MyProject\LearnLua\Assets\" + filepath + ".lua.txt";
        //读取文本
        string file = File.ReadAllText(path);
        //返回文本字节数组
        return Encoding.UTF8.GetBytes(file);
    }
    private void OnDestroy()
    {
        //程序结束时，释放luaenv内存
        env.Dispose();
    }
}

六、Lua访问C#

CSCallLua.lua.txt

print("Let's start learning Lua!")

--new C#对象
--local newgo = CS.UnityEngine.GameObject()
local newgo2 = CS.UnityEngine.GameObject('helloworld')

--访问C#静态属性，方法
--如果需要经常访问的类，可以先用局部变量引用后访问
--除了减少敲代码的时间，还能提高性能
local go = CS.UnityEngine.GameObject
local ue=CS.UnityEngine

--读静态属性
--print(ue.Time.deltaTime)

--写静态属性
--ue.Time.timeScale = 0.5
--调用静态方法
--newgo3 = go.Find('helloworld')
--newgo3.name="NiHao"
newgo4 = go.find('Main Camera')
--调用成员方法，第一个参数需要传该对象，建议用冒号代替
--local cameracom = newgo4:GetComponent("Camera")
--go.Destroy(cameracom)

七、使用Lua实现热更新的方案