XLua 学习之路（二）之C#访问Lua

       这里指的是C#主动发起对Lua数据结构的访问。从Lua支持的数据类型来讲，C#获取Lua元素主要分为：基本数据类型(number,bool,string)，复杂的数据类型(table)，函数(function)。

       本次测试的待获取的Lua文件CSharpCallLua.lua.txt内容t如下：

--用于测试获取全局基本数据类型
a = 100;--全局变量
isDead = false
str = "leander"
--用于测试获取全局函数类型
function addTest()
    print("addTest")
end
--用于测试获取全局函数带参数类型
function add(a,b)
    print(a+b)
end
--用于测试获取全局函数带多个返回值类型
function addReturnMulti(a,b)
    return a+b,a,b
end
--用于测试获取全局table数据类型
preson={
    name = "leander",2,"test",3.3,
    age = 24,
    --self参数，代表当前table对象
    sum = function(self,a,b)
        print("a+b="+(a+b))
    end

}

--使用“:”定义
--默认带一个self参数，代表当前调用对象

--[
--用于测试获取全局table外部定义函数(不显式第一个参数)类型
function preson:sum(a,b)
    print(a+b)
end
--]

--使用“.”定义
--[
--用于测试获取全局table外部定义函数(显式第一个参数)类型
function preson.sum(self,a,b)
    print(a+b)
end
--]

一、获取全局基本数据类型

       首先，还是创建XLua的虚拟机。然后，再通过LuaEnv.Global.Get<类型>(“name”)方法进行获取即可;示例代码如下：

LuaEnv env = new LuaEnv();//创建Lua虚拟机
//读取CSharpCallLua.lua.txt文件
env.DoString("require 'CSharpCallLua'");

//C#获取lua的基本数据类型
int a = env.Global.Get<int>("a");
bool isDead = env.Global.Get<bool>("isDead");
string str = env.Global.Get<string>("str");

print(a); //100
print(isDead); //False
print(str); //leander
env.Dispose(); //释放Lua虚拟机

二、获取全局table类型

       获取table类型，一共有四种方式：1.将table映射到普通class或struct 2.映射到接口（优先考虑）3.映射到Dictionary或List 4.通过XLua的LuaTable完成映射；下面将分别完成这四种的映射。

1.映射到普通class或struct

       这种方式下xLua会帮你new一个实例，并把对应的字段赋值过去。table的属性可以多于或者少于class的属性。可以嵌套其它复杂类型。要注意的是，这个过程是值拷贝，如果class比较复杂代价会比较大。而且修改class的字段值不会同步到table，反过来也不会。这个功能可以通过把类型加到GCOptimize生成降低开销。实现方式如下：
       首先，构建table对应的class。

//第一种映射方式
class Preson
{
    //字段名要与lua文件table中保持一致
    public string name;
    public int age;
}

       再通过LuaEnv.Global.Get<类型>(“name”)方法进行获取即可;示例代码如下：

//要注意的是，这个过程是值拷贝，如果class比较复杂,代价会比较大。
//而且修改class的字段值不会同步到table，反过来也不会。
Preson p = env.Global.Get<Preson>("preson");
print(p.name + ":" + p.age);//leander:24
p.name = "leander.com";
env.DoString("print(preson.name)");//leander 注意：此处并不是leander.com

       注意：此方法，不能映射table中的函数，若要映射到table中的函数，则考虑第二种映射方式。

2.映射到接口

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

//第二种映射方式
[CSharpCallLua] //如果不加这个属性就会抛InvalidCastException异常
interface IPerson
{
    //接口不能包含字段，将其转换成属性
    string name { get; set; }
    int age { get; set; }

    //函数名称需要与lua文件函数名一致
    void sum(int a,int b);
}

       再通过LuaEnv.Global.Get<类型>(“name”)方法进行获取即可;示例代码如下：

//2.映射到接口（优先考虑）
//这个过程是引用拷贝，修改IPerson的属性会同步到table
IPerson p = env.Global.Get<IPerson>("preson");
print(p.name); //leander
p.name = "leanderQT";
env.DoString("print(preson.name)");//leanderQT 注意：此时name的value被更新了
p.sum(12, 32); //44 相当于p.Sum(p,12,32);

       注意：映射class和struct和映射到interface的区别在于：1.映射class和struct是值拷贝，而映射到interface为引用拷贝。2.映射到interface时，需要添加[CSharpCallLua]注解，用于XLua生成代码。

3.映射到Dictionary或List

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

//3.映射到Dictionary 或 List

//List只能映射值，无法映射key-value形式 比如：name:leander age:24 函数等
List<object> list = env.Global.Get<List<object>>("preson");

foreach (object o in list)
{
    print(o);
}//输出 2 "test" 3.3

//Dictionary只能映射key-value形式，无法映射值，比如：数字，字符串等
Dictionary<string, object> dict = env.Global.Get<Dictionary<string, object>>("preson");

foreach (string key in dict.Keys)
{
    print(key + ":" + dict[key]);
}//输出 name:leander age:24 sum:function:11

       注意：List只能映射值，无法映射key-value形式；Dictionary只能映射key-value形式，无法映射值形式。

4.通过XLua的LuaTable完成映射

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

//4.通过XLua的LuaTable完成映射 只能获取table中的key-value形式(包括函数)
//若table中包含其他非key-value形式，下面代码将会报InvalidCastException异常
//在测试这段代码时，需要将lua文件的table里面2,"test",3.3移除，因为这种属于非key-value形式
LuaTable tab = env.Global.Get<LuaTable>("preson");
print(tab.Get<string>("name")); //leander
print(tab.Get<int>("age")); //24
print(tab.Length); //获取table中非key-value形式的元素个数
foreach (string key in tab.GetKeys())
{
    print(tab.Get<object>(key));
}//输出 leander 24 0

       此处的函数，被映射成0了，原因还在排查…

三、获取全局函数

仍然是用Get方法，不同的是类型映射。获取function，一共有两种方式：1、映射到delegate 2.映射到LuaFunction。

1.映射到delegate

       这种是建议的方式，性能好很多，而且类型安全。缺点是要生成代码（如果没生成代码会抛InvalidCastException异常）。示例代码如下：
       首先，定义函数对应的委托类型。

 [CSharpCallLua]
 //无返回值时委托定义
 delegate void Add(int a,int b);
 [CSharpCallLua]
 //多个返回值时委托定义 除去该方法第一个返回值时，使用out/ref关键字来接收
 delegate int AddReturnMulti(int a, int b, out int resa,out int resb);

       然后还是基于Get方法。

//访问lua中的全局函数 映射到delegate
//无参类型
Action addTest = env.Global.Get<Action>("addTest");
addTest(); //addTest
//在释放该虚拟机之前，要先释放上述映射的全局函数
addTest = null;

//带参类型 1.通过自定义委托类型来实现映射
Add add_Params = env.Global.Get<Add>("add");
add_Params(1, 3);//4
add_Params = null;

//多个返回值
AddReturnMulti addReturnMulti = env.Global.Get<AddReturnMulti>("addReturnMulti");
int resa, resb;
int result = addReturnMulti(34, 39, out resa, out resb);
print(resa + "+" + resb + "=" + result);//34+39=73
addReturnMulti = null;

2.映射到LuaFunction

       LuaFunction上有个变参的Call函数，可以传任意类型，任意个数的参数，返回值是object的数组，对应于lua的多返回值。

LuaFunction func = env.Global.Get<LuaFunction>("addReturnMulti");
object[] os = func.Call(1,2);
foreach (object o in os)
{
    print(o);
}//3 1 2

四、小结

       1、访问lua全局数据，特别是table以及function，代价比较大，建议尽量少做，比如在初始化时把要调用的lua function获取一次（映射到delegate）后，保存下来，后续直接调用该delegate即可。table也类似。
       2、如果lua测的实现的部分都以delegate和interface的方式提供，使用方可以完全和xLua解耦：由一个专门的模块负责xlua的初始化以及delegate、interface的映射，然后把这些delegate和interface设置到要用到它们的地方。

参考资料：https://github.com/Tencent/xLua