CSharpCallLua
CSharpCallLua,顾名思义CS里面去调用访问Lua代码里面的属性方法。对应的官方Demo为“CSharpCallLua”。
访问全局基本数据类型
假如我在Lua中定义了下面三个变量:
-
a = 1
-
b = 'hello world'
-
c = true
那么我们只需要通过luaenv.Global.Get<T>(name)就可在C#中访问这几个变量,如下:
-
LuaEnv luaenv = new LuaEnv();
-
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
比如我在Lua中定义了如下的一个table:
-
d = {
-
f1 = 12, f2 = 34,
-
1, 2, 3,
-
add = function(self, a, b)
-
print('d.add called')
-
return a + b
-
end
-
}
方法1:将table映射到一个c#的class或struct中
我们可以定义一个class,将lua中的table里面的字段(即键值对的键)对应到class中的属性中,该属性需要添加public字段,并且该class需要有无参的构造函数。如上诉table d中f1 = 12, f2 = 34可以对应到class中如下:
-
public class DClass {
-
public int f1;
-
public int f2;
-
}
注意,这些方式,table的属性不需要和class属性一一对应,并且可以嵌套其他复杂类型,上诉table中的1,2,3和add的属性无法映射到class中。然后利用下面的方法即可实例化这个class:
-
DClass d = luaenv.Global.Get<DClass>("d");//映射到有对应字段的class,by value
-
Debug.Log("_G.d = {f1=" + d.f1 + ", f2=" + d.f2 + "}");
这种方式,Xlua会帮我们new一个实例,并将lua中table对应的字段的值赋值到class中。整个过程是值拷贝,如果class比较复杂代价会比较大,并且由于是值拷贝,修改class中属性的值不会同步到table当中,反之亦然。我们可以通过在class前添加[GCOptimize]标签,降低开销。
方法2:将table映射到interface中
这种方式依赖生成的代码(如果没有生成代码,会抛出InvalidCastException异常)。这种方式不仅可以访问table里面的属性,还可以访问table中的函数。是官方推荐用法,如下:
-
[CSharpCallLua]
-
public interface ItfD {
-
int f1 { get; set; }
-
int f2 { get; set; }
-
int add(int a, int b);
-
}
需要注意的是,这种方式需要给interface添加[CSharpCallLua]标签。映射方式和class相同,如下:
-
//映射到interface实例,by ref,这个要求interface加到生成列表即添加[CSharpCallLua]标签,否则会返回null,建议用法
-
ItfD d3 = luaenv.Global.Get<ItfD>("d");
-
d3.f2 = 1000;
-
Debug.Log("_G.d = {f1=" + d3.f1 + ", f2=" + d3.f2 + "}");
-
Debug.Log("_G.d:add(1, 2)=" + d3.add(1, 2));
这种方式是引用类型,即当你get一个属性时,会从table中去取对应字段的值,set一个属性时,会去设置table中对应字段的值。还可通过interface中定义的方法去访问对应的table中的函数。
方法3:将table映射到Dictionary<>或List<>
这种方法不需要像上面自己定义class,struct或interface。这种方法是一种值拷贝,并且只会映射出同为一种类型的值。如下:
-
//映射到Dictionary<string, double>,by value
-
Dictionary<string, double> d1 = luaenv.Global.Get<Dictionary<string, double>>("d");
-
Debug.Log("_G.d = {f1=" + d1["f1"] + ", f2=" + d1["f2"] + "}, d.Count=" + d1.Count);
-
//只能映射出table中键值对<string, double>的属性,即上述的f1=12,f2=34
-
//映射到List<double>,by value
-
List<double> d2 = luaenv.Global.Get<List<double>>("d");
-
Debug.Log("_G.d.len = " + d2.Count);
-
//只能映射出table中类型为number的属性,即上述的1,2,3
方法4:将table映射到LuaTable类
这种方法也是引用类型,LuaTable类是XLua里面的一个Class,同样不需要生成代码。但是效率较低,且没有类型检测,如下:
-
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
例如我们在XLua里定义了如下三个函数:
-
function e()
-
print('i am e')
-
end
-
function f(a, b)
-
print('a', a, 'b', b)
-
return 1, {f1 = 1024}
-
end
-
function ret_e()
-
print('ret_e called')
-
return e
-
end
e为无参无返回值函数,f为有参有返回值函数,ret_e为无参有返回值(返回一个函数)函数
方法1:映射到delegate
该方法是官方推荐方式,不仅性能好,而且类型安全,需要生成代码(否则抛出InvalidCastException异常)。像上面的函数e,我们可以直接映射到系统的delegate Action中,如:
-
Action e = luaenv.Global.Get<Action>("e");
-
e();
-
//带参数的f函数映射到Action中,可以映射成功,但是函数体内参数值传递进来为nil
-
Action f = luaenv.Global.Get<Action>("f");
-
f();
对于有参数有返回值(以及多返回值)的函数,我们需要自定义delegate并添加[CSharpCallLua]标签。lua函数里面的每个形参就要在delegate中声明一个对应的输入类型参数。我们可以看到f函数是具有两个返回值的(number和table),那么多返回值的情况,第一个返回值还是对应delegate的返回值,剩下的返回值从左到右对应到delegate的输出类型参数(out参数,ref参数)。所以f函数的映射如下:
-
//f函数返回的{f1=1024},可以对应之前映射的class DClass
-
[CSharpCallLua]
-
public delegate int FDelegate(int a, string b, out DClass c);
使用:
-
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);
同时function还可以返回一个function,即对应C#的返回值为delegate,ret_e对应的映射可以为:
-
[CSharpCallLua]
-
public delegate Action GetE();
使用如下:
-
GetE ret_e = luaenv.Global.Get<GetE>("ret_e");//delegate可以返回更复杂的类型,甚至是另外一个delegate
-
Action e2 = ret_e();
-
e2();
方法2:映射到LuaFunction
这种方式不需要生成代码,但是性能和安全性就不如前者。LuaFunction是XLua的一个class,有一个变参的Call函数,可以传任意类型,任意个数的参数。返回值是一个object数组,对应lua的多返回值,如下:
-
LuaFunction d_e = luaenv.Global.Get<LuaFunction>("e");
-
d_e.Call();
使用建议
1.访问Lua全局数据,特别是table和function,代价较大,建议尽量少做,比如在初始化时把要调用的lua table function获取一次(映射到delegate)后保存下来,后续直接调用对应delegate即可。
2.如果Lua部分的映射都以delegate和interface的方式处理,使用方法可以完全和XLua解耦:由一个专门的模块负责XLua的初始化以及delegate,interface的映射,然后把这些delegate,interface设置到要用到他们的地方。
发现内容比较多,关于Lua调用C#的笔记就留到下篇记录=。=