热更新学习--xLua

Petrichorzncu

已于 2024-08-13 19:01:17 修改

阅读量736

点赞数 19

分类专栏：热更新文章标签：学习

于 2024-05-18 14:20:31 首次发布

本文链接：https://blog.csdn.net/Petrichorzncu/article/details/138920670

版权

热更新专栏收录该内容

3 篇文章 0 订阅

订阅专栏

xLua教程
 腾讯开源手游热更新方案：Unity3D下的XLua方案介绍
热更新的好处：不用浪费流量重新下载，不用通过商店审核更加快速，不用重新安装玩家可以更快体验到更新的内容

这些热更新方案都是基于Lua语言的，也可以叫做lua插件（可以运行lua，并实现了lua和C#交互的插件）。
所以本质上这些热更新方案就是一个lua插件，可以运行lua，并实现了lua和C#交互的插件。

xLua为Unity、 .Net、 Mono等C#环境增加Lua脚本编程的能力，借助xLua，这些Lua代码可以方便的和C#相互调用。

通过xlua插件运行lua程序

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;
public class HelloWorld01 : MonoBehaviour
{
    private LuaEnv luaEnv;
    void Start()
    {
        luaEnv = new LuaEnv();//运行环境
        luaEnv.DoString("print('HelloWorld')");
        直接用LuaEnv.DoString执行一个字符串，当然，字符串得符合Lua语法 
    }
    private void OnDestroy()
    {
        luaEnv.Dispose();//释放
    }
}

使用lua中的方法在控制台输出语句时会显示Lua的标识，引用C#中的方法则不会

在lua中调用C#中的方法

luaEnv.DoString("CS.UnityEngine.Debug.Log('HelloWorld')");

通过内置的loader加载lua源文件

require实际上是调一个个的loader去加载，有一个成功就不再往下尝试，全失败则报文件找不到。目前xLua除了原生的loader外，还添加了从Resource加载的loader，需要注意的是因为Resource只支持有限的后缀，放Resources下的lua文件得加上txt后缀（见附带的例子）。

建议的加载Lua脚本方式是：整个程序就一个DoString(“require ‘main’”)，然后在main.lua加载其它脚本（类似lua脚本的命令行执行：lua main.lua）。

LuaEnv env = new LuaEnv();
        env.DoString("require'helloworld'");//使用require加载文件时，就会调用loder去找
        env.Dispose();

添加自定义的Loader方法

通过AddLoader可以注册个回调，该回调参数是字符串，lua代码里头调用require时，参数将会透传给回调，回调中就可以根据这个参数去加载指定文件，如果需要支持调试，需要把filepath修改为真实路径传出。该回调返回值是一个byte数组，如果为空表示该loader找不到，否则则为lua文件的内容。

查找loder时首先执行了自定义的loder

void Start()
    {
        LuaEnv env = new LuaEnv();
        env.AddLoader(MyLoader);
        env.DoString("require 'helloworld'");
        env.Dispose();
        
    }
    private byte[] MyLoader(ref string filepath)
    {
        print(filepath);
        string s = "print(123)";
        return System.Text.Encoding.UTF8.GetBytes(s);
    }

通过自定义Loader加载指定目录的Lua脚本

public class CreateLoader : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        LuaEnv env = new LuaEnv();
        env.AddLoader(MyLoader);
        env.DoString("require 'test007'");
        env.Dispose();
        
    }
    private byte[] MyLoader(ref string filepath)
    {
        string absPath=Application.streamingAssetsPath+"/"+filepath+".lua.txt";
        return System.Text.Encoding.UTF8.GetBytes(File.ReadAllText(absPath));
    }
}

C#访问Lua之访问Lua中的全局变量

获取一个全局基本数据类型访问LuaEnv.Global就可以了，上面有个模版Get方法，可指定返回的类型。

public class CSharpCallLua : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
        //C#在接收lua中的变量时需要正确地声明类型，否则会报错
        int a=luaEnv.Global.Get<int>("a");//获取到lua里面的全局变量a
        string str=luaEnv.Global.Get<string>("str");
        bool isDie=luaEnv.Global.Get<bool>("isDie");
        print(a);
        print(str);
        print(isDie);
        luaEnv.Dispose();
    }

C#访问Lua之访问Lua中的table

映射到普通class或struct

定义一个class，有对应于table的字段的public属性，而且有无参数构造函数即可，比如对于{f1 = 100, f2 = 100}可以定义一个包含public int f1;public int f2;的class。这种方式下xLua会帮你new一个实例，并把对应的字段赋值过去。

table的属性可以多于或者少于class的属性。可以嵌套其它复杂类型。要注意的是，这个过程是值拷贝，如果class比较复杂代价会比较大。而且修改class的字段值不会同步到table，反过来也不会。

这个功能可以通过把类型加到GCOptimize生成降低开销

 void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
        Person p = luaEnv.Global.Get<Person>("person");
        print(p.name+"-"+p.age);
        luaEnv.Dispose();
    }

    class Person
    {
        public string name;
        public int age;
    }

映射到一个interface

这种方式依赖于生成代码（如果没生成代码会抛InvalidCastException异常），代码生成器会生成这个interface的实例，如果get一个属性，生成代码会get对应的table字段，如果set属性也会设置对应的字段。甚至可以通过interface的方法访问lua的函数。

出现问题：即使在interface上面加上了[CSharpCallLua]依旧会报错 InvalidCastException: This type must add to CSharpCallLua: CSharpCallLua+IPerson（也就是上文提到的InvalidCastException异常）

解决：在接口前加public,在unity中点击xlua->Generate code即可解决

疑问：为什么接口默认就是public的但是在这里还要特意在该接口前加上public呢？
Generate code又是做什么用的？

答：这个功能可能会根据你的 C# 代码生成一些额外的代码，以便与 Lua 脚本进行互操作。XLua 可能会通过生成绑定代码，将 C# 类型和方法暴露给 Lua 环境，使得你可以在 Lua 脚本中调用、扩展和处理 C# 的类型和方法。生成的代码可能包括一些自动化的封装、映射和适配逻辑，以确保 C# 与 Lua 的交互能够顺利进行。

 void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
        oPerson p = luaEnv.Global.Get<oPerson>("person");
        print(p.name+"-"+p.age);
        p.name = "Sikiedu.com";
        p.age = 20;
        luaEnv.DoString("print(person.name)");
        p.eat(12,12);
        luaEnv.Dispose();
    }
    [CSharpCallLua]
    public interface oPerson
    {
        string name{ get; set; }
        int age { get; set; }
        void eat(int a,int b);
    }

函数会有隐藏的参数，用来表示当前调用函数的对象，如果没有在函数定义中写出该参数，在调用该函数时会出错

更轻量级的by value方式：映射到Dictionary<>，List<>

不想定义class或者interface的话，可以考虑用这个，前提table下key和value的类型都是一致的。

void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
        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);
        }
        luaEnv.Dispose();
    }

C#访问Lua之通过LuaTable访问table

这种方式好处是不需要生成代码，但也有一些问题，比如慢，比方式2要慢一个数量级，比如没有类型检查。

void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
		LuaTable tab=luaEnv.Global.Get<LuaTable>("person");
        print(tab.Get<string>("name"));
        print(tab.Get<int>("age"));
        //print(tab.Length);
        foreach (string key in tab.GetKeys())
        {
            print(tab.Get<object>(key));
        }
        
        luaEnv.Dispose();
    }

访问一个全局的function

仍然是用Get方法，不同的是类型映射。

映射到delegate

这种是建议的方式，性能好很多，而且类型安全。缺点是要生成代码（如果没生成代码会抛InvalidCastException异常）。

delegate要怎样声明呢？对于function的每个参数就声明一个输入类型的参数。多返回值要怎么处理？从左往右映射到c#的输出参数，输出参数包括返回值，out参数，ref参数。

参数、返回值类型支持哪些呢？都支持，各种复杂类型，out，ref修饰的，甚至可以返回另外一个delegate。

delegate的使用就更简单了，直接像个函数那样用就可以了。

void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
		Add add=luaEnv.Global.Get<Add>("add");
        int res1;
        int res = add(34, 78,out res1);
        print(res);
        add= null;
        
        luaEnv.Dispose();
    }
    [CSharpCallLua]
    delegate int Add(int a, int b,out int res1);

映射到LuaFunction

这种方式的优缺点刚好和第一种相反。使用也简单，LuaFunction上有个变参的Call函数，可以传任意类型，任意个数的参数，返回值是object的数组，对应于lua的多返回值。

void Start()
    {
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
		LuaFunction func = luaEnv.Global.Get<LuaFunction>("add");
        object[] os = func.Call(1,2);
        foreach (object o in os)
        {
            print(o);
        }
        
        luaEnv.Dispose();

使用建议

访问lua全局数据，特别是table以及function，代价比较大，建议尽量少做，比如在初始化时把要调用的lua function获取一次（映射到delegate）后，保存下来，后续直接调用该delegate即可。table也类似。

如果lua侧的实现的部分都以delegate和interface的方式提供，使用方可以完全和xLua解耦：由一个专门的模块负责xlua的初始化以及delegate、interface的映射，然后把这些delegate和interface设置到要用到它们的地方。

在Lua中new C#对象（创建游戏物体）

new C#对象

你在C#这样new一个对象：

var newGameObj = new UnityEngine.GameObject();
对应到Lua是这样：

local newGameObj = CS.UnityEngine.GameObject()
基本类似，除了：

lua里头没有new关键字；
所有C#相关的都放到CS下，包括构造函数，静态成员属性、方法；
如果有多个构造函数呢？放心，xlua支持重载，比如你要调用GameObject的带一个string参数的构造函数，这么写：

local newGameObj2 = CS.UnityEngine.GameObject(‘helloworld’)

访问C#静态属性，方法

读静态属性
CS.UnityEngine.Time.deltaTime

写静态属性
CS.UnityEngine.Time.timeScale = 0.5

调用静态方法
CS.UnityEngine.GameObject.Find(‘helloworld’)

小技巧：如果需要经常访问的类，可以先用局部变量引用后访问，除了减少敲代码的时间，还能提高性能：

local GameObject = CS.UnityEngine.GameObject
GameObject.Find(‘helloworld’)

访问C#成员属性，方法

读成员属性：

testobj.DMF

写成员属性：

testobj.DMF = 1024

调用成员方法：
注意：调用成员方法，第一个参数需要传该对象，建议用冒号语法糖，如下

testobj:DMFunc()

--构造游戏物体，new对象
--CS.UnityEngine.GameObject()
-- 读静态变量
print(CS.UnityEngine.Time.deltaTime)
--写静态变量
CS.UnityEngine.Time.timeScale=0.5;

--如果需要经常访问的类，可以先用局部变量引用后访问，除了减少敲代码的时间，还能提高性能：
local gameObject=CS.UnityEngine.GameObject
--调用静态方法
local camera=gameObject.Find("Main Camera")

camera.name="update by lua"
--调用成员方法的时候使用冒号
local cameraCom=camera:GetComponent("Camera")

gameObject.Destroy(cameraCom)

local light=gameObject.Find("Directional Light")