ULua与Unity交互原理

1.ulua为tolua原班人马开发，现已不在维护，因为公司项目目前使用ulua实现，故写一篇博客记录所学，以期在工作中使用ulua更加得心应手。

首先：附上ulua官网地址：http://www.ulua.org/download.html。

由于原班人马不在维护，所贴unitypackage链接也已失效，现在只能在githup上下载ulua示例工程，附上地址：https://github.com/jarjin/uLua

下载完成之后直接使用unity打开，unity版本可以选择unity5也可以选择更高版本，如果选择更高级版本例如unity2017，则打开时需更新api，否则可能造成无法使用的后果。

我这里使用unity2017.4.19打开

其中包含两个文件夹：

1.Plugins文件夹：ulua底层库所在的目录，里面存放的是不同平台的底层库，之所以ulua效率高，就是它是纯c的lua虚拟机，而不是c#解释型的。
 ---Andriod：安卓lua虚拟机底层库，里面分为armv7-a与Intel x86平台。
 ---iOS：里面就是苹果lua虚拟机底层库。
 ---ulua.bundle：里面是Mac机器的底层库。
 ---x86：里面是Win32/Linux32位机器的lua虚拟机底层库。
 ---x86_64：里面是Win64/Linux64位机器的lua虚拟机底层库。

plugins(插件)文件夹：放到plugins下的最先编译。所以一些dll这些的都放到这里。一般是放插件的，你用c++写的插件，java写的插件，为ios写的插件，为android写的插件，都是放在这里的。

2.uLua文件夹：ulua/cstolua的核心目录，里面还有经过我们修缮后ulua的基础使用例子，用户初学者最佳。
 ---Core：顾名思义，ulua的核心目录，所有c#与lua的交互都是通过它进行调度的。
 ---Docs：ulua自带的文档目录，因为ulua基于LuaInterface，所以这里面就是它的文档。
 ---Editor：这是供cstolua去反射定义Wrap文件列表的工具类目录。
 ---Examples：经过我们修改增加后ulua自带的例子。
 ---Source：这个是cstolua的核心目录，里面有Base核心目录，与动态生成用于存放LuaWrap类的缓存目录。

什么是wrap： wrap是对c#类的成员函数，成员变量，通过映射的方式。

Lua文件夹(该文件夹被放到了ulua下面)：框架自带的Lua源码目录，用户自定义的Lua脚本也就是放在这里面，最后打包的时候，打包脚本会将其按目录结构生成到StreaminAssets目录里面去，然后在将其上传到游戏的Web服务器上面，用于准备被每个游戏客户端下载更新他们本地的Lua脚本。达到热更目的。
 ---3rd：里面是第三方的一些插件lua、实例源码文件，比如：cjson、pbc、pblua、sproto等。
 ---Common：公用的lua文件目录，如define.lua文件，一些变量声明，全局配置等，functions.lua常用函数库，通讯的protocal.lua协议文件。
 ---Logic：目录里面存放的是一些管理器类，比如GameManager游戏管理器、NetworkManager网络管理器，如果你有新的管理器可以放到里面。
 ---System：这个目录是cstolua的系统目录，里面存放都是一些常用的lua类，为了优化lua调用速度，用lua重写的unity常用类。
 ---View(1.25的没有)：这是面板的视图层，里面都是一些被Unity调用的面板的变量，走的是Unity GameObject的生命周期的事件调用。
 ---Controller(1.25的没有)：控制器目录，它不依赖于某一个Lua面板，它是独立存活在Luavm中的一个操作类，操作数据、控制面板显示而已。

Ulua是一款非常实用的unity插件，它能让unity支持Lua语言，而且运行效率还不错。
Lua代码都是运行时才编译的，所以更新逻辑只需要更新脚本，不需要再编译，因而Lua能轻松实现“热更新”。热更新指的是在不关闭服务器的前提下，对上线的项目进行修改。 
unity的热更新可以通过发布dll动态链接库的方式进行线上更新，dll的反射机制在苹果平台不被支持，因此大多数情况都采用lua进行热更新。

1，IntPtr 结构
一、什么是IntPtr
先来看看MSDN上说的:用于表示指针或句柄的平台特定类型。这个其实说出了这样两个事实，IntPtr 可以用来表示指针或句柄、它是一个平台特定类型。
C#中的IntPtr类型称为“平台特定的整数类型”，它们用于本机资源，如窗口句柄。资源的大小取决于使用的硬件和操作系统，但其大小总是足以包含系统的指针（因此也可以包含资源的名称）。 所以，在您调用的API函数中一定有类似窗体句柄这样的参数，那么当您声明这个函数时，您应该将它显式地声明为IntPtr类型。
二、这里有两点比较重要
（1）在C#中声明Win32API时，一定要按照WinAPI的原型来声明，不要改变它的数据类型；
（2）尽量不要过多使用类型强制转换或构造函数的方式初始化一个IntPtr类型的变量，这样会使程序变得难于理解并容易出错。
三、用在什么地方
（1）C#调用WIN32 API时
（2）C#调用C/C++写的DLL时（其实和1相同，只是这个一般是我们在和他人合作开发时经常用到）

句柄：句柄在windows编程中是一个很重要的概念，在许多地方都扮演着重要的角色。在windows环境中，句柄是用来标识项目的，这些项目包括：模块（module）任务（task）文件（file）内存块（block of memory）菜单（menu）字体（font）资源（recource），包括图标（icon），光标（cursor），字符串（string）等

1.如果一个C#方法要被Lua调用，则首先要将其注册到Lua虚拟机中（LuaState.RegisterFunction）。之后，在Lua中就可以通过注册的名称来调用这个C#方法。
2.如果C#要调用Lua中的函数，则
（1）首先要在Lua虚拟机中加载该函数（LuaState.DoFile）。
（2）拿到目标函数（LuaState.GetFunction）。　　
（3）执行目标函数（LuaFunction.Call）。

https://www.cnblogs.com/xixidaguai/p/5556791.html uLua Unity工作机制
基于ulua 1.25版本,开启C#类型动态注册.

1，注册需要Wrap的C#类型.
在WrapFile.cs类中,使用_GT(typeof(XXX)), 注册需要Wrap的C#类型，注册的C#类型被包装成BindType对象,在BindType构造函数里获取注册类型的类名,注册给Lua的名称,基类名称,Wrap的文件名称等信息,并保存在相应的BindType对象中.(这些是在WrapFile类创建时就生成的)
2. 执行编辑器脚本,生成Wrap的C#类, LuaBinder类,以及Wrap.lua文件.

关于Lua与NGUI的适配：
调用Lua的主要方式就是callFunction，而对于NGUI来说，一般都是按钮触发某C#脚本的函数，那么如何用按钮触发Lua的函数呢？这就需要有个C#脚本作为“中介”，这个“中介”需要有自己的LuaState实例，当执行“中介”的某个方法时，由该方法调用callFunction。至于具体调用Lua脚本的哪个方法，可以通过传参的方式告诉这个“中介”——修改NGUI的ButtonMessage类，加入新的public string LuaFunctionName成员，以后由它来制定要调用的Lua方法名就好了。而通过NGUI的UIButton等调用C#的方法，也是同理的（NGUI3.5.6版以后，可以给UIButton等等组件的触发方法添加参数了）。

现版本的ulua（tolua）中lua调用C#是基于去反射。

去反射的意思是：

把所有的c#类的public成员变量、成员函数，都导出到一个相对应的Wrap类中，而这些成员函数通过特殊的标记，映射到lua的虚拟机中，当在lua中调用相对应的函数时候，直接调用映射进去的c# wrap函数，然后再调用到实际的c#类，完成调用过程。

具体调用过程可参考： Unity3d ulua c#与lua交互+wrap文件理解

因为反射在效率上存在不足，所以通过wrap来提升性能。但是因为wrap需要自己去wrap，所以在大版本更新是可以用到的，小版本更新还是使用反射。

当lua虚拟机启动的时候，会将此wrap文件加载进lua虚拟机，然后lua就可以识别此调用了，最后就形成了

Lua 调用 Wrap , Wrap调用C#的模式，实现了Lua调用C#

那么我们怎么来生成Wrap 呢 ？ 

生成Wrap文件需要使用者自己手动的去WrapFile 文件填写需要Wrap的文件，大概像下面这个样子

_GT(typeof(LoginData))

 

点击Gen Lua Wrap Files，即生成对应wrap文件。

例：

vscode中在lua工程中新建lua脚本 TestDebug.lua

 

 

新建c#脚本

 

 

点击运行

 

luaIDE调试ulua教程：附官网教程：https://www.showdoc.com.cn/luaide?page_id=713946796715920

OnBundleLoaded之中调用ConnectDebugger

LuaScriptsMg构造函数中打开luaSocket

 

断点成功。