xlua学习4 值传递避免gc

mypro334

定义方法

声明一些方法，结构体，接口，作为测试对象
对于只包含值类型的结构体我们可以加GCOptimize标签，让xlua生成代码，优化gc
不要忘记在xlua中生成代码

1. [GCOptimize]//只包含值类型的结构体，可以打GCOptimize标签，并生成代码，优化gc
2. [LuaCallCSharp]//lua中使用C#，打标签生成代码做优化，否则会使用反射的方式访问，非常耗资源
3.                //测试结构体
4. public struct Pedding
5. {
6.     public byte c;
7. }
8. [GCOptimize]
9. [LuaCallCSharp]
10. //测试结构体
11. public struct MyStruct
12. {
13.     public MyStruct(int p1, int p2)
14.     {
15.         a = p1;
16.         b = p2;
17.         c = p2;
18.         e.c = (byte)p1;
19.     }
20.     public int a;
21.     public int b;
22.     public decimal c;
23.     public Pedding e;
24. }
25. [LuaCallCSharp]
26. //测试枚举
27. public enum MyEnum
28. {
29.     E1,
30.     E2
31. }
32. [CSharpCallLua]
33. public delegate int IntParam(int p);//测试方法
34. [CSharpCallLua]
35. public delegate Vector3 Vector3Param(Vector3 p);//测试方法
36. [CSharpCallLua]
37. public delegate MyStruct CustomValueTypeParam(MyStruct p);//测试方法
38. [CSharpCallLua]
39. public delegate MyEnum EnumParam(MyEnum p);//测试方法
40. [CSharpCallLua]
41. public delegate decimal DecimalParam(decimal p);//测试方法
42. [CSharpCallLua]
43. public delegate void ArrayAccess(Array arr);//测试方法
44. [CSharpCallLua]
45. //测试接口
46. public interface IExchanger
47. {
48.     void exchange(Array arr);
49. }

复制代码

然后创建实例和一些测试数据

1. IntParam f1;//测试方法
2. Vector3Param f2;
3. CustomValueTypeParam f3;
4. EnumParam f4;
5. DecimalParam f5;
6. ArrayAccess farr;
7. IExchanger ie;
8. Action flua;
9. LuaFunction add;
10. #endregion
11. #region test data
12. [NonSerialized]
13. public double[] a1 = new double[] { 1, 2 };//测试数据
14. [NonSerialized]
15. public Vector3[] a2 = new Vector3[] { new Vector3(1, 2, 3), new Vector3(4, 5, 6) };
16. [NonSerialized]
17. public MyStruct[] a3 = new MyStruct[] { new MyStruct(1, 2), new MyStruct(3, 4) };
18. [NonSerialized]
19. public MyEnum[] a4 = new MyEnum[] { MyEnum.E1, MyEnum.E2 };
20. [NonSerialized]
21. public decimal[] a5 = new decimal[] { 1.00001M, 2.00002M };

复制代码

接下来定义几个方法供lua调用测试

1. [LuaCallCSharp]
2. public float FloatParamMethod(float p)
3. {
4.     return p;
5. }
6. [LuaCallCSharp]
7. public Vector3 Vector3ParamMethod(Vector3 p)
8. {
9.     return p;
10. }
11. [LuaCallCSharp]
12. public MyStruct StructParamMethod(MyStruct p)
13. {
14.     return p;
15. }
16. [LuaCallCSharp]
17. public MyEnum EnumParamMethod(MyEnum p)
18. {
19.     return p;
20. }
21. [LuaCallCSharp]
22. public decimal DecimalParamMethod(decimal p)
23. {
24.     return p;
25. }

复制代码

编写lua测试代码

在lua中根据刚刚定义的数据结构，生成表和方法

1. A = { B = { C = 789}};--定义一个结构体
2. GDATA = 1234;--定义一个num类型
3. local v3 = CS.UnityEngine.Vector3(7, 8, 9);--调用c#类中的参数
4. local vt = CS.MyStruct(5, 6);--调用c#类中的参数
5. --相当于泛型
6. function id(...)
7.         return ...;
8. end
9. --简单的相加方法
10. function add(a, b)
11.         return a + b ;
12. end
13. --数组index0 和 index1的交换
14. function array_exchange(arr)
15.         arr[0], arr[1] = arr[1], arr[0];
16. end
17. --测试访问C#中的方法
18. function lua_access_csharp()
19.         self:FloatParamMethod(123); --primitive
20.         self:Vector3ParamMethod(v3); --vector3
21.         local rnd = math.random(1, 100);
22.         local r = self:Vector3ParamMethod({x = 1, y = 2, z = rnd}); --vector3
23.         assert(r.x == 1 and r.y == 2 and r.z == rnd);
24.         self:StructParamMethod(vt); --custom struct
25.         r = self:StructParamMethod({a = 1, b = rnd, e = {c = rnd}});
26.         assert(r.b == rnd and r.e.c == rnd);
27.         self:EnumParamMethod(CS.MyEnum.E2); --enum
28.         self:DecimalParamMethod(self.a5[0]);
29.         self.a1[0], self.a1[1] = self.a1[1], self.a1[0]; -- field
30. end
31. --对应C#类中的IExchanger接口
32. exchanger = {
33.         exchange = function(self, arr)
34.                 array_exchange(arr);
35.         end
36. };

复制代码

获取lua中的方法

1. scriptEnv = LuaEnvExtension.Instance.NewTable();//在主lua环境中创建一个新的表作为当前脚本的环境
2. LuaTable meta = LuaEnvExtension.Instance.NewTable();//创建一个新的表格存全局变量
3. meta.Set("__index", LuaEnvExtension.Instance.Global);//获取全局变量作为元方法
4. scriptEnv.SetMetaTable(meta);//设置meta为当前脚本的元表
5. meta.Dispose();//回收meta
6. LuaEnvExtension.Instance.DoString(luaText.text, "NoGCTest", scriptEnv);//拷贝lua脚本的方法到scriptEnv中
7. scriptEnv.Set("self", this);//设置自身
8. scriptEnv.Get("id", out f1);//获取泛型测试方法，我们并没有传给id方法参数，所以f1-f5都是空的
9. scriptEnv.Get("id", out f2);
10. scriptEnv.Get("id", out f3);
11. scriptEnv.Get("id", out f4);
12. scriptEnv.Get("id", out f5);
13. scriptEnv.Get("array_exchange", out farr);//获取lua中的方法
14. scriptEnv.Get("lua_access_csharp", out flua);
15. scriptEnv.Get("exchanger", out ie);
16. scriptEnv.Get("add", out add);
17. scriptEnv.Set("g_int", 123);
18. scriptEnv.Set(123, 456);
19. int i;
20. scriptEnv.Get("g_int", out i);
21. scriptEnv.Get(123, out i);

复制代码

调用测试方法

1. private void Update()
2. {
3.     //测试f1-f5方法
4.     f1(1);
5.     f2(new Vector3(1, 2, 3));
6.     MyStruct mystruct1 = new MyStruct(5, 6);
7.     f3(mystruct1);
8.     f4(MyEnum.E1);
9.     decimal dec1 = -32132143143100109.00010001010M;
10.     f5(dec1);
11.     add.Func<int, int, int>(34, 56); // LuaFunction.Func<T1, T2, TResult>是个方便调用的类型，可以自定义其他方法快捷调用
12.                                      //测试a1-a5数据
13.     farr(a1); //primitive value type array
14.     farr(a2); //vector3 array
15.     farr(a3); //custom struct array
16.     farr(a4); //enum arry
17.     farr(a5); //decimal arry
18.     flua();//调用lua中的lua_access_csharp方法测试C#中的数据
19.     ie.exchange(a2);//接口测试
20.     scriptEnv.Set("g_int", 456);//调用lua数据测试
21.     int i;
22.     scriptEnv.Get("g_int", out i);
23.     scriptEnv.Set(123.0001, mystruct1);
24.     MyStruct mystruct2;
25.     scriptEnv.Get(123.0001, out mystruct2);
26.     decimal dec2 = 0.0000001M;
27.     scriptEnv.Set((byte)12, dec1);
28.     scriptEnv.Get((byte)12, out dec2);
29.     int gdata = scriptEnv.Get<int>("GDATA");
30.     scriptEnv.SetInPath("GDATA", gdata + 1);
31.     int abc = scriptEnv.GetInPath<int>("A.B.C");
32.     scriptEnv.SetInPath("A.B.C", abc + 1);
33.     //检测是否满足gc回收条件
34.     if (Time.time - LuaEnvExtension.lastGCTime > gcInterval)
35.     {
36.         LuaEnvExtension.Instance.GC();
37.         LuaEnvExtension.lastGCTime = Time.time;
38.     }
39. }

复制代码

回收内存

1. private void OnDestroy()
2. {
3.     //回收内存
4.     f1 = null;
5.     f2 = null;
6.     f3 = null;
7.     f4 = null;
8.     f5 = null;
9.     a1 = null;
10.     a2 = null;
11.     a3 = null;
12.     a4 = null;
13.     a5 = null;
14.     farr = null;
15.     flua = null;
16.     ie = null;
17.     add = null;
18.     scriptEnv.Dispose();
19. }

复制代码

完整代码

C#部分的代码

1. using System;
2. using UnityEngine;
3. using XLua;
5. #region test struct and method
6. [GCOptimize]//只包含值类型的结构体，可以打GCOptimize标签，并生成代码，优化gc
7. [LuaCallCSharp]//lua中使用C#，打标签生成代码做优化，否则会使用反射的方式访问，非常耗资源
8.                //测试结构体
9. public struct Pedding
10. {
11.     public byte c;
12. }
13. [GCOptimize]
14. [LuaCallCSharp]
15. //测试结构体
16. public struct MyStruct
17. {
18.     public MyStruct(int p1, int p2)
19.     {
20.         a = p1;
21.         b = p2;
22.         c = p2;
23.         e.c = (byte)p1;
24.     }
25.     public int a;
26.     public int b;
27.     public decimal c;
28.     public Pedding e;
29. }
30. [LuaCallCSharp]
31. //测试枚举
32. public enum MyEnum
33. {
34.     E1,
35.     E2
36. }
37. [CSharpCallLua]
38. public delegate int IntParam(int p);//测试方法
39. [CSharpCallLua]
40. public delegate Vector3 Vector3Param(Vector3 p);//测试方法
41. [CSharpCallLua]
42. public delegate MyStruct CustomValueTypeParam(MyStruct p);//测试方法
43. [CSharpCallLua]
44. public delegate MyEnum EnumParam(MyEnum p);//测试方法
45. [CSharpCallLua]
46. public delegate decimal DecimalParam(decimal p);//测试方法
47. [CSharpCallLua]
48. public delegate void ArrayAccess(Array arr);//测试方法
49. [CSharpCallLua]
50. //测试接口
51. public interface IExchanger
52. {
53.     void exchange(Array arr);
54. }
55. #endregion
56. public class NoGCTest : MonoBehaviour
57. {
58.     private const float gcInterval = 1f;//gc回收间隔 1秒
59.     public TextAsset luaText;//lua脚本
60.     private LuaTable scriptEnv;//脚本的lua环境
61.     #region test method params
62.     IntParam f1;//测试方法
63.     Vector3Param f2;
64.     CustomValueTypeParam f3;
65.     EnumParam f4;
66.     DecimalParam f5;
67.     ArrayAccess farr;
68.     IExchanger ie;
69.     Action flua;
70.     LuaFunction add;
71.     #endregion
72.     #region test data
73.     [NonSerialized]
74.     public double[] a1 = new double[] { 1, 2 };//测试数据
75.     [NonSerialized]
76.     public Vector3[] a2 = new Vector3[] { new Vector3(1, 2, 3), new Vector3(4, 5, 6) };
77.     [NonSerialized]
78.     public MyStruct[] a3 = new MyStruct[] { new MyStruct(1, 2), new MyStruct(3, 4) };
79.     [NonSerialized]
80.     public MyEnum[] a4 = new MyEnum[] { MyEnum.E1, MyEnum.E2 };
81.     [NonSerialized]
82.     public decimal[] a5 = new decimal[] { 1.00001M, 2.00002M };
83.     #endregion
84.     #region test lua call c#
85.     //lua中调用的测试方法
86.     [LuaCallCSharp]
87.     public float FloatParamMethod(float p)
88.     {
89.         return p;
90.     }
91.     [LuaCallCSharp]
92.     public Vector3 Vector3ParamMethod(Vector3 p)
93.     {
94.         return p;
95.     }
96.     [LuaCallCSharp]
97.     public MyStruct StructParamMethod(MyStruct p)
98.     {
99.         return p;
100.     }
101.     [LuaCallCSharp]
102.     public MyEnum EnumParamMethod(MyEnum p)
103.     {
104.         return p;
105.     }
106.     [LuaCallCSharp]
107.     public decimal DecimalParamMethod(decimal p)
108.     {
109.         return p;
110.     }
111.     #endregion
112.     private void Awake()
113.     {
114.         scriptEnv = LuaEnvExtension.Instance.NewTable();//在主lua环境中创建一个新的表作为当前脚本的环境
115.         LuaTable meta = LuaEnvExtension.Instance.NewTable();//创建一个新的表格存全局变量
116.         meta.Set("__index", LuaEnvExtension.Instance.Global);//获取全局变量作为元方法
117.         scriptEnv.SetMetaTable(meta);//设置meta为当前脚本的元表
118.         meta.Dispose();//回收meta
119.         LuaEnvExtension.Instance.DoString(luaText.text, "NoGCTest", scriptEnv);//拷贝lua脚本的方法到scriptEnv中
120.         scriptEnv.Set("self", this);//设置自身
121.         scriptEnv.Get("id", out f1);//获取泛型测试方法，我们并没有传给id方法参数，所以f1-f5都是空的
122.         scriptEnv.Get("id", out f2);
123.         scriptEnv.Get("id", out f3);
124.         scriptEnv.Get("id", out f4);
125.         scriptEnv.Get("id", out f5);
126.         scriptEnv.Get("array_exchange", out farr);//获取lua中的方法
127.         scriptEnv.Get("lua_access_csharp", out flua);
128.         scriptEnv.Get("exchanger", out ie);
129.         scriptEnv.Get("add", out add);
130.         scriptEnv.Set("g_int", 123);
131.         scriptEnv.Set(123, 456);
132.         int i;
133.         scriptEnv.Get("g_int", out i);
134.         Debug.Log("g_int:" + i);
135.         scriptEnv.Get(123, out i);
136.         Debug.Log("123:" + i);
137.     }
138.     private void Update()
139.     {
140.         //测试f1-f5方法
141.         f1(1);
142.         f2(new Vector3(1, 2, 3));
143.         MyStruct mystruct1 = new MyStruct(5, 6);
144.         f3(mystruct1);
145.         f4(MyEnum.E1);
146.         decimal dec1 = -32132143143100109.00010001010M;
147.         f5(dec1);
148.         add.Func<int, int, int>(34, 56); // LuaFunction.Func<T1, T2, TResult>是个方便调用的类型，可以自定义其他方法快捷调用
149.         //测试a1-a5数据
150.         farr(a1); //primitive value type array
151.         farr(a2); //vector3 array
152.         farr(a3); //custom struct array
153.         farr(a4); //enum arry
154.         farr(a5); //decimal arry
155.         flua();//调用lua中的lua_access_csharp方法测试C#中的数据
156.         ie.exchange(a2);//接口测试
157.         scriptEnv.Set("g_int", 456);//调用lua数据测试
158.         int i;
159.         scriptEnv.Get("g_int", out i);
160.         scriptEnv.Set(123.0001, mystruct1);
161.         MyStruct mystruct2;
162.         scriptEnv.Get(123.0001, out mystruct2);
163.         decimal dec2 = 0.0000001M;
164.         scriptEnv.Set((byte)12, dec1);
165.         scriptEnv.Get((byte)12, out dec2);
166.         int gdata = scriptEnv.Get<int>("GDATA");
167.         scriptEnv.SetInPath("GDATA", gdata + 1);
168.         int abc = scriptEnv.GetInPath<int>("A.B.C");
169.         scriptEnv.SetInPath("A.B.C", abc + 1);
170.         //检测是否满足gc回收条件
171.         if (Time.time - LuaEnvExtension.lastGCTime > gcInterval)
172.         {
173.             LuaEnvExtension.Instance.GC();
174.             LuaEnvExtension.lastGCTime = Time.time;
175.         }
176.     }
177.     private void OnDestroy()
178.     {
179.         //回收内存
180.         f1 = null;
181.         f2 = null;
182.         f3 = null;
183.         f4 = null;
184.         f5 = null;
185.         a1 = null;
186.         a2 = null;
187.         a3 = null;
188.         a4 = null;
189.         a5 = null;
190.         farr = null;
191.         flua = null;
192.         ie = null;
193.         add = null;
194.         scriptEnv.Dispose();
195.     }
196. }

复制代码

lua部分的代码

1. A = { B = { C = 789}};--定义一个结构体
2. GDATA = 1234;--定义一个num类型
3. local v3 = CS.UnityEngine.Vector3(7, 8, 9);--调用c#类中的参数
4. local vt = CS.MyStruct(5, 6);--调用c#类中的参数
5. --相当于泛型
6. function id(...)
7.         return ...;
8. end
9. --简单的相加方法
10. function add(a, b)
11.         return a + b ;
12. end
13. --数组index0 和 index1的交换
14. function array_exchange(arr)
15.         arr[0], arr[1] = arr[1], arr[0];
16. end
17. --测试访问C#中的方法
18. function lua_access_csharp()
19.         self:FloatParamMethod(123); --primitive
20.         self:Vector3ParamMethod(v3); --vector3
21.         local rnd = math.random(1, 100);
22.         local r = self:Vector3ParamMethod({x = 1, y = 2, z = rnd}); --vector3
23.         assert(r.x == 1 and r.y == 2 and r.z == rnd);
24.         self:StructParamMethod(vt); --custom struct
25.         r = self:StructParamMethod({a = 1, b = rnd, e = {c = rnd}});
26.         assert(r.b == rnd and r.e.c == rnd);
27.         self:EnumParamMethod(CS.MyEnum.E2); --enum
28.         self:DecimalParamMethod(self.a5[0]);
29.         self.a1[0], self.a1[1] = self.a1[1], self.a1[0]; -- field
30. end
31. --对应C#类中的IExchanger接口
32. exchanger = {
33.         exchange = function(self, arr)
34.                 array_exchange(arr);
35.         end
36. };

复制代码