【转】封装Lua for C#

原文:http://blog.csdn.net/rcfalcon/article/details/5583095

为了搞懂LUA在我们的GDEX中到底怎么用,我决定研究一下如何比较好的在WPF里封装一个基于lua的APP  framework。

今天先对Lua for C#进行了一次简单的封装。

在C#下用过Lua的人都知道,用C#实现一个函数之后和LUA绑定,需要用到Lua类的RegisterFunction方法。

在函数很少的情况下很好用,但是若需要绑定C#里成百上千个函数,则麻烦了,添加一个函数,至少每次需要修改两个地方:函数实现,函数绑定(RegisterFunction)。并且如果在lua中绑定的名字和C#中不一样,则更麻烦,还需要维护一个函数映射。

今天翻了一下google,翻出GameDev.NET上一篇老外的文章,叫《Using Lua with C#》,看了一下,它的方法不错。(改天考虑翻译这篇文章),不过他的示例代码实在是太太太冗长了,大部分是生成函数介绍和函数帮助文档等,直接忽略。把它最核心的东西拿过来,然后自己封装了一下,用起来感觉不错。

基本思想是,使用C#的Attribute来标记函数,实现自动绑定。

核心部分代码如下(LuaFramework.cs):

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using System.Windows;
  6. using System.Reflection;
  7. using LuaInterface;
  8. namespace WPFLuaFramework
  9. {
  10. /// <summary>
  11. /// Lua函数描述特性类
  12. /// </summary>
  13. public class LuaFunction : Attribute
  14. {
  15. private String FunctionName;
  16. public LuaFunction(String strFuncName)
  17. {
  18. FunctionName = strFuncName;
  19. }
  20. public String getFuncName()
  21. {
  22. return FunctionName;
  23. }
  24. }
  25. /// <summary>
  26. /// Lua引擎
  27. /// </summary>
  28. class LuaFramework
  29. {
  30. private Lua pLuaVM = new Lua();//lua虚拟机
  31. /// <summary>
  32. /// 注册lua函数
  33. /// </summary>
  34. /// <param name="pLuaAPIClass">lua函数类</param>
  35. public void BindLuaApiClass( Object pLuaAPIClass )
  36. {
  37. foreach (MethodInfo mInfo in pLuaAPIClass.GetType().GetMethods())
  38. {
  39. foreach (Attribute attr in Attribute.GetCustomAttributes(mInfo))
  40. {
  41. string LuaFunctionName = (attr as LuaFunction).getFuncName();
  42. pLuaVM.RegisterFunction(LuaFunctionName, pLuaAPIClass, mInfo);
  43. }
  44. }
  45. }
  46. /// <summary>
  47. /// 执行lua脚本文件
  48. /// </summary>
  49. /// <param name="luaFileName">脚本文件名</param>
  50. public void ExecuteFile(string luaFileName)
  51. {
  52. try
  53. {
  54. pLuaVM.DoFile(luaFileName);
  55. }
  56. catch (Exception e)
  57. {
  58. MessageBox.Show(e.ToString());
  59. }
  60. }
  61. /// <summary>
  62. /// 执行lua脚本
  63. /// </summary>
  64. /// <param name="luaCommand">lua指令</param>
  65. public void ExecuteString(string luaCommand)
  66. {
  67. try
  68. {
  69. pLuaVM.DoString(luaCommand);
  70. }
  71. catch (Exception e)
  72. {
  73. MessageBox.Show(e.ToString());
  74. }
  75. }
  76. }
  77. }

我的LUA API类如下,用于实现C# for lua的函数(LuaAPI.cs)

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using System.Windows;
  6. namespace WPFLuaFramework
  7. {
  8. class LuaAPI
  9. {
  10. [LuaFunction("lua1")]
  11. public void a1()
  12. {
  13. MessageBox.Show("a1 called");
  14. }
  15. [LuaFunction("lua2")]
  16. public int a2()
  17. {
  18. MessageBox.Show("a2 called");
  19. return 0;
  20. }
  21. [LuaFunction("lua3")]
  22. public void a3(string s)
  23. {
  24. MessageBox.Show("a3 called");
  25. }
  26. }
  27. }

最后看调用代码,是不是很简单

  1. LuaFramework test = new LuaFramework();
  2. test.BindLuaApiClass(new LuaAPI());
  3. test.ExecuteFile("test.lua");
  4. test.ExecuteString("lua1()");

LUA代码如下

lua1();
lua2();
lua3("test");

上一篇:lua虚拟机概述


下一篇:大佬带你深入浅出Lua虚拟机