xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8)

1.访问全局基本数据类型

      定义全局变量:

                                             

     代码:

        LuaEnv luaEnv = new LuaEnv();

        luaEnv.DoString("require 'CSharpCallLua'");//  number  --  int float double 
        double a = luaEnv.Global.Get("a");//获取到lua里面的全局变量 a
        print(a);
        string str = luaEnv.Global.Get("str");//获取到lua里面的全局变量 str
        print(str);
        bool isDie = luaEnv.Global.Get("isDie");//获取到lua里面的全局变量 isDie
        print(isDie);
        double a = luaEnv.Global.Get("a");//获取到lua里面的全局变量 a
        print(a);
        string str = luaEnv.Global.Get("str");//获取到lua里面的全局变量 str
        print(str);
        bool isDie = luaEnv.Global.Get("isDie");//获取到lua里面的全局变量 isDie
        print(isDie);

   要注意类型要相对应:

                                       

xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8)_第1张图片

2.访问全局的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生成降低开销

示例:

     首先定义一个类                         

   [CSharpCallLua]
    delegate int Add(int a, int b,out int resa,out int resb); 
    class Person
    {
        public string name;
        public int age;
        public int age2;
    }
   [CSharpCallLua]
    delegate int Add(int a, int b,out int resa,out int resb); 
    class Person
    {
        public string name;
        public int age;
        public int age2;
    }

     Lua脚本代码:

person = {
	name="qianxi", age=100,12,2,2,2,2,"qianxi",true,3.3,                 //age:是数组,没有对应的类型,不会映射
}

     访问代码:

 //通过class(struct)
        Person p = luaEnv.Global.Get("person");
        print(p.name+"-"+ p.age+"-"+p.age2);
        p.name = "qianxi.com";
        luaEnv.DoString("print(person.name)");
        Person p = luaEnv.Global.Get("person");
        print(p.name+"-"+ p.age+"-"+p.age2);
        p.name = "qianxi.com";
        luaEnv.DoString("print(person.name)");

     ②、映射到一个interface

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

示例:

     首先定义一个类接口

[CSharpCallLua] //接口必须添加这个特性,否则也会报InvalidCastException
    interface IPerson
    {
        string name { get; set; }
        int age { get; set; }
        void eat(int a,int b); //函数
    }
[CSharpCallLua] //接口必须添加这个特性,否则也会报InvalidCastException
    interface IPerson
    {
        string name { get; set; }
        int age { get; set; }
        void eat(int a,int b); //函数
    }

     Lua脚本代码:

person = {
	name="qianxi", age=100,12,2,2,2,2,"qianxi",true,3.3,                 //age:是数组,没有对应的类型,不会映射
	eat=function(self,a,b)     //也会映射过去(Lua中默认会有第一个对象,C#调用要传参数一一对应,self代表自身调用)
		print(a+b)
	end
}

    Lua函数还可以使用下面的代码,可以使用下面方法:

                  xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8)_第2张图片

   代码访问:

        
        luaEnv.DoString("require 'CSharpCallLua'");//访问lua脚本
        IPerson p = luaEnv.Global.Get("person");
        print(p.name + "-" + p.age);
        p.name = "qianxiStudy";         //修改后会对lua那边产生同样的影响
        luaEnv.DoString("print(person.name)");
        p.eat(12, 34);   //调用映射的函数(如果Lua定义时没有传self时就要传自己过去(即使用的是.而不是:的时候),即p.eat(p,12,34);)

     ③、更轻量级(代码量较少)的by value方式:映射到Dictionary<>,List<>

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

        Lua脚本代码:

person = {
	name="qianxi", age=100,12,2,2,2,2,"qianxi",true,3.3,                 //age:是数组,没有对应的类型,不会映射
	eat=function(self,a,b)     //也会映射过去(Lua中默认会有第一个对象,C#调用要传参数一一对应,self代表自身调用)
		print(a+b)
	end
}

      C#脚本:

     //3,通过Dictionary、List
        luaEnv.DoString("require 'CSharpCallLua'");
        Dictionary dict = luaEnv.Global.Get>("person"); //因为value类型不确定,因此用object代替,只会映射有key的
        foreach (string key in dict.Keys)
        {
            print("Dic " + key + "-" + dict[key]);
        }
        List listObject = luaEnv.Global.Get>("person"); //指挥映射没有key的,也就是只映射值
        foreach (var o in listObject)
        {
            print("ListObject " + o);
        }
        List listInt = luaEnv.Global.Get>("person");
        foreach (var o in listInt)
        {
            print("ListInt " + o);
        } 
  

  输出:

                                                                       xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8)_第3张图片

       我们可以看出,映射成Dictionary指挥映射有key值的,而List只能映射无Key值的,两者互补可以得到全部数据

    ④、另外一种by ref方式:映射到LuaTable类(不推荐,一般用第二种)
       

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

       lua脚本与上面是一致的

       C#:

        //4,通过LuaTable
        luaEnv.DoString("require 'CSharpCallLua'");
        LuaTable tab = luaEnv.Global.Get("person");
        print(tab.Get("name"));
        print(tab.Get("age"));
        print(tab.Length);

3.访问全局的function

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

     ①、映射到delegate

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

对于function的每个参数就声明一个输入类型的参数。

多返回值要怎么处理?从左往右映射到c#的输出参数,输出参数包括返回值,out参数,ref参数

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

 

示例1(使用内置事件):  

  lua脚本:

function add()
	print("调用全局Function")
end

  C#脚本:(Action是系统配置过的,已经生成了代码,可是如果带参数就需要自己配置了,本文不使用这种方法

        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");//访问lua脚本
        Action act1 = luaEnv.Global.Get("add");
        act1();
        act1 = null;
        luaEnv.Dispose();

示例2:

  lua脚本:

function add(a,b)
	print(a+b)
	return a+b,a,b  //三个返回值
end

C#脚本:

     [CSharpCallLua] 
     delegate int Add(int a, int b, out int resa, out int resb); //首先函数返回值为lua函数的第一个返回值,后两个out接收的是剩余的两个返回值,ref参数也是可以的
     LuaEnv luaEnv = new LuaEnv();
     luaEnv.DoString("require 'CSharpCallLua'");
     Add add = luaEnv.Global.Get("add");
     int resa = 0; int resb = 0;
     int res = add(34, 78, out resa, out resb);
     print(res);
     print(resa);
     print(resb);
     add = null;     //注意委托需要释放即置空
//首先函数返回值为lua函数的第一个返回值,后两个out接收的是剩余的两个返回值,ref参数也是可以的
     LuaEnv luaEnv = new LuaEnv();
     luaEnv.DoString("require 'CSharpCallLua'");
     Add add = luaEnv.Global.Get("add");
     int resa = 0; int resb = 0;
     int res = add(34, 78, out resa, out resb);
     print(res);
     print(resa);
     print(resb);
     add = null;     //注意委托需要释放即置空

     输出:

                                                  xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8)_第4张图片

     ②、映射到LuaFunction(性能较慢)

这种方式的优缺点刚好和第一种相反。

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

   lua脚本:

function add(a,b)
	print(a+b)
	return a+b,a,b  //三个返回值
end

  C#脚本:

       //映射到LuaFunction(频繁调用的不要映射成LuaFunction)
        LuaEnv luaEnv = new LuaEnv();
        luaEnv.DoString("require 'CSharpCallLua'");
        LuaFunction func = luaEnv.Global.Get("add");
        object[] os = func.Call(1, 2);
        foreach (object o in os)
        {
            print(o);
        }

 输出:

                                        xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8)_第5张图片

4.使用建议

①、访问lua全局数据,特别是table(推荐映射成interface)以及function(推荐映射成delegate),代价比较大,建议尽量少做

比如在初始化时把要调用的luafunction获取一次(映射到delegate)后,保存下来,后续直接调用该delegate即可。table也类似。

②、如果lua的实现的部分都以delegate和interface的方式提供,使用方可以完全和xLua解耦

由一个专门的模块负责xlua的初始化以及delegate、interface的映射,然后把这些delegate和interface设置到要用到它们的地方。

 

 

 

 

 

 

你可能感兴趣的:(xLua学习之路(三) ------ C#主动发起对Lua数据结构的访问(Lua文件保存格式要为UTF-8))