Unity之热更新：（三）XLua

1. XLua是什么？

　　Xlua是Lua在C#环境(.net)下的Lua解决方案，包括C#环境下的Lua代码解释器(Lua虚拟机)。

2. 基于XLua的纯Lua开发环境的基本原则？ 

• Unity场景里不放任务物体，通过代码创建和释放物体。这样避免冲突，方便维护（比如程序和美术都往场景里放了同一物体），可以通过搜索代码查看创建了哪些物体以及结构关系。
• 运行时只有一个场景，没有场景切换。地图、角色、特效、粒子...都被做成资源或预制体给代码使用。（这一步实现美术与程序分离）
• 不手动往节点上面挂脚本，而是通过代码AddComponent挂载。（方便维护，直接搜索组件名称就能找到哪里挂载了脚本）
• 纯AssetsBundle来做资源管理，代替Resources。这样方便更新，方便打空包。
• 制定一个纯Lua的组件化开发框架。方便写业务逻辑，减少Lua与C#相互调用。
• 调试模式加载Lua代码、资源。AssetDataBase来加载资源。发布模式，打AB包，更新。

3. 在Unity中使用XLUA

　1）https://github.com/Tencent/xlua 下载xlua

　2）复制Assets文件夹下四个文件到工程Assets文件夹

　

　3）打开宏

 

　4）任何代码的修改都要执行以下两个步骤才能运行：

  5）下面开始写C#调用Lua的代码

写一个lua文件，命名后缀 .lua.txt

注意lua文件要放在C#脚本的同级Resources目录下。

 

 

 下面是C#脚本，演示C#脚本里调用lua。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;

public class textCSharp : MonoBehaviour 
{
    LuaEnv env = new LuaEnv();

    private void OnGUI()
    {
        if (GUILayout.Button("C#调用Lua语句"))
            env.DoString("print 'testlua'");

        if (GUILayout.Button("C#调用Lua文件"))
            CSharpCallLuaFile();    
    }
    void CSharpCallLuaFile()
    {
        env.DoString("require 'luatest'");
        //调用lua全局变量
        Debug.Log(env.Global.Get<string>("name"));
        Debug.Log(env.Global.Get<int>("age"));
        //调用lua表中数据
        LuaTable table = env.Global.Get<LuaTable>("config");
        Debug.Log(table.Get<string>("name"));
        Debug.Log(table.Get<string>("age"));
    }
}

也可以直接映射成类

public class textCSharp : MonoBehaviour 
{
    LuaEnv env = new LuaEnv();

    private void OnGUI()
    {
        if (GUILayout.Button("C#调用Lua文件"))
            CSharpCallLuaFile();    
    }
    void CSharpCallLuaFile()
    {
        env.DoString("require 'luatest'");

        Config config = env.Global.Get<Config>("config");
        Debug.Log(config.name);
        Debug.Log(config.age);
    }
    public class Config
    {
        public string name;
        public int age;
    }
}

void CSharpCallLuaFile()
    {
        env.DoString("require 'luatest'");
        //调用lua函数并接收返回值
        LuaFunction fun = env.Global.Get<LuaFunction>("printInfo");
        object[] objs = fun.Call();  //lua函数可以有1个或多个返回值
        Debug.Log(objs[0]);
    }

结果是：第一行输出的是Call()里面的内容

 

也可以使用委托来调用lua函数

public class textCSharp : MonoBehaviour 
{
    LuaEnv env = new LuaEnv();

    delegate int Fun(int num);
    private void OnGUI()
    {
        if (GUILayout.Button("C#调用Lua文件"))
            CSharpCallLuaFile();    
    }
    void CSharpCallLuaFile()
    {
        env.DoString("require 'luatest'");
        //调用lua函数并接收返回值
        Fun f = env.Global.Get<Fun>("printInfo");
        Debug.Log(f(0));
    }
}

输出：

 

 

 

 6）下面演示Lua调用C#

先写一个C#类

public class Hero 
{
    private int Hp;
    private string Name;

    public Hero(string name, int hp)
    {
        this.Name = name;
        this.Hp = hp;
    }
    public void PrintInfo()
    {
        Debug.Log(Name + "的血量是：" + Hp);
    }
    public int AddHp(int _hp)
    {
        Debug.Log("lua传递来的参数：" + _hp);
        Hp += _hp;
        return Hp;
    }
}

lua脚本

 

 注意：Lua调用C#类，要加CS

Lua调用 MonoBehaviour 类要加 CS.UnityEngine

 别忘了在C#里执行一下

public class textCSharp:MonoBehaviour
{
    LuaEnv env = new LuaEnv();
    void OnGUI()
    {
        if (GUILayout.Button("Lua调用C#"))
        {
            LuaCallCSharp();
        }
    }
    void LuaCallCSharp()
    {
        env.DoString("require 'luatest'");
    }
}

结果如下：

--------------------------------------------------------------------------------------------------------------------------------------------------------------

XLUA配置三步：

1.打标签 :XLUA会自动生成适配代码，注意子类打了标签，父类也要打。

[LuaCallCSharp]   Lua里适配的委托、接口也要在C#定义里打标签。 

[CSharpCallLua] 

[Hotfix]

2.静态列表

 

3.动态列表

 加 static List<Type> 修饰

详细参考：https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/configure.md

 ===================================================================================

下面我们来搭一个XLUA使用框架

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;
using System;

[LuaCallCSharp]
public class LuaEnvMgr
{
    //单例
    private static LuaEnvMgr instance;
    public static LuaEnvMgr Instance
    {
        get {
            if (instance == null)
                instance = new LuaEnvMgr();
            return instance;
        }
    }
    //封装Lua虚拟机
    private LuaEnv env;
    public LuaEnv Env
    {
        get { return env; }
    }
    //构造函数初始化Lua虚拟机
    public LuaEnvMgr()
    {
        env = new LuaEnv();
    }
    //获取Lua table
    public LuaTable GetGlobalTable()
    {
        return env.Global;
    }
    //创建Lua table
    public LuaTable CreateTable()
    {
        return env.NewTable();
    }
    //释放
    public void Dispose()
    {
        env.Dispose();
    }
}

[CSharpCallLua]
public delegate void OnCollisionDel(Collision2D collision);

[CSharpCallLua]
public delegate void OnTriggerDel(Collider2D collision);
/// <summary>
/// 方便Lua调用C#生命周期函数
/// </summary>
[LuaCallCSharp]
public class LuaCallBase : MonoBehaviour {

    public TextAsset textAsset;//lua文件

    protected LuaTable table;//存储lua文件数据的表

    //常用更新生命周期
    protected Action luaAwake;
    protected Action luaStart;
    protected Action luaUpdate;
    protected Action luaDestory;
    protected Action luaOnGUI;

    //自定义委托生命周期
    protected OnCollisionDel luaCollisionEnter;
    protected OnTriggerDel luaTriggerEnter;


    protected virtual void Awake()
    {
        table = LuaEnvMgr.Instance.CreateTable();
        LuaTable meta = LuaEnvMgr.Instance.CreateTable();
        meta.Set("__index", LuaEnvMgr.Instance.GetGlobalTable());
        table.SetMetaTable(meta);
        meta.Dispose();

        LuaEnvMgr.Instance.Env.DoString(textAsset.text, this.GetType().Name, table);
        
        
        SetLuaData();
        GetLuaData();
        if (luaAwake != null)
            luaAwake();
    }

    public object GetLuaData(string dataName)
    {
        object obj;
        table.Get(dataName,out obj);
        return obj;
    }

    protected virtual void SetLuaData()
    {
        table.Set("self", this);
    }

    protected virtual void GetLuaData()
    {
        table.Get("awake", out luaAwake);
        table.Get("start", out luaStart);
        table.Get("update", out luaUpdate);
        table.Get("destroy", out luaDestory);
        table.Get("ongui", out luaOnGUI);

        table.Get("onCollisionEnter", out luaCollisionEnter);
        table.Get("onTriggerEnter", out luaTriggerEnter);
    }

    private void Start()
    {
        if (luaStart != null)
            luaStart();
    }
    private void Update()
    {
        if (luaUpdate != null)
            luaUpdate();
    }
    private void OnGUI()
    {
        if (luaOnGUI != null)
            luaOnGUI();
    }
    private void OnDestroy()
    {
        if (luaDestory != null)
            luaDestory();
    }

    private void OnCollisionEnter2D(Collision2D collision)
    {
        if (luaCollisionEnter != null)
            luaCollisionEnter(collision);
    }
    private void OnTriggerEnter2D(Collider2D collision)
    {
        if (luaTriggerEnter != null)
            luaTriggerEnter(collision);
    }
}

只需要继承这个框架类，把lua脚本拖上去，就会执行啦！跟C#在Unity里的操作一样，只是挂载的C#脚本里的功能都由Lua脚本来实现了。

如果嫌Lua每次调用C#方法都要加前缀麻烦。可以写一个Lua公共脚本，把这些前缀重新赋值，其他脚本只要 require "公共脚本名"，就可以像写C#一样调用Unity方法啦！

System=CS.System
Int=System.Int32
String=System.String

Unity=CS.UnityEngine
Debug=Unity.Debug
GameObject=Unity.GameObject
Transform=Unity.Transform
Renderer=Unity.Renderer
Color=Unity.Color
Vector3=Unity.Vector3
Vector2=Unity.Vector2
Input=Unity.Input
Resources=Unity.Resources
Camera=Unity.Camera
LineRenderer=Unity.LineRenderer
EdgeCollider2D=Unity.EdgeCollider2D
Time=Unity.Time

Vector3List=CS.System.Collections.Generic.List(Vector3)
Vector2List=CS.System.Collections.Generic.List(Vector2)

function getLuaData(obj,script,data)
    local instance=obj:GetComponent(script)
    return instance:GetLuaData(data)
end

　　

参考：Unity3D架构师进阶系列: 基于xLua的热更框架