这里指的是C#主动发起对Lua数据结构的访问。
本章涉及到的例子都可以在XLua\Tutorial\CSharpCallLua下找到。

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

访问LuaEnv.Global就可以了，上面有个模版Get方法，可指定返回的类型。

1
2
3
luaenv.Global.Get<int>("a")
luaenv.Global.Get<string>("b")
luaenv.Global.Get<bool>("c")

访问一个全局的table

也是用上面的Get方法，那类型要指定成啥呢？

  1. 映射到普通Class或Struct

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

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

    这个功能可以通过把类型加到GCOptimize生成降低开销，详细可参见配置介绍文档。
    那有没有引用方式的映射呢？有，下面这个就是：

  2. 映射到一个Interface

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

  3. 映射到Dictionary<TK,TV>，List

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

  4. 映射到LuaTable类

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

访问一个全局的function

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

  1. 映射到 delegate

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

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

    参数、返回值类型支持哪些呢？

    都支持，各种复杂类型，out，ref修饰的，甚至可以返回另外一个delegate。

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

  2. 映射到 LuaFunction

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

注意⚠️

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

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

代码示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
//获取全局变量
Debug.Log("_G.a = " + luaenv.Global.Get<int>("a"));
Debug.Log("_G.b = " + luaenv.Global.Get<string>("b"));
Debug.Log("_G.c = " + luaenv.Global.Get<bool>("c"));

//获取table
//table映射到CLass
DClass d = luaenv.Global.Get<DClass>("d");//映射到有对应字段的class，by value
Debug.Log("_G.d = {f1=" + d.f1 + ", f2=" + d.f2 + "}");

//table映射到字典
Dictionary<string, double> d1 = luaenv.Global.Get<Dictionary<string, double>>("d");//映射到Dictionary<string, double>，by value
Debug.Log("_G.d = {f1=" + d1["f1"] + ", f2=" + d1["f2"] + "}, d.Count=" + d1.Count);

//table映射到List
List<double> d2 = luaenv.Global.Get<List<double>>("d"); //映射到List<double>，by value
Debug.Log("_G.d.len = " + d2.Count);

//table映射到接口
ItfD d3 = luaenv.Global.Get<ItfD>("d"); //映射到interface实例，by ref，这个要求interface加到生成列表，否则会返回null，建议用法
d3.f2 = 1000;
Debug.Log("_G.d = {f1=" + d3.f1 + ", f2=" + d3.f2 + "}");
Debug.Log("_G.d:add(1, 2)=" + d3.add(1, 2));

//table映射到LuaTable
LuaTable d4 = luaenv.Global.Get<LuaTable>("d");//映射到LuaTable，by ref
Debug.Log("_G.d = {f1=" + d4.Get<int>("f1") + ", f2=" + d4.Get<int>("f2") + "}");

//获取 function
//function 映射到 与定义委托
Action e = luaenv.Global.Get<Action>("e");//映射到一个delgate，要求delegate加到生成列表，否则返回null，建议用法
e();

//function 映射到 自定义委托
FDelegate f = luaenv.Global.Get<FDelegate>("f");
DClass d_ret;
int f_ret = f(100, "John", out d_ret);//lua的多返回值映射：从左往右映射到c#的输出参数，输出参数包括返回值，out参数，ref参数
Debug.Log("ret.d = {f1=" + d_ret.f1 + ", f2=" + d_ret.f2 + "}, ret=" + f_ret);

//funtion 映射到 返回复杂类型的预定义委托
GetE ret_e = luaenv.Global.Get<GetE>("ret_e");//delegate可以返回更复杂的类型，甚至是另外一个delegate
e = ret_e();
e();

//function 映射到Lua function
LuaFunction d_e = luaenv.Global.Get<LuaFunction>("e");
d_e.Call();