原地址：http://www.xuanyusong.com/archives/3075

李剑英的CSLight入门指南
文档撰写者：Graphic
QQ: 1065147807

一． CSLIGHT 作者简介

CSLight的作者是李剑英，一个有着美丽心灵的游戏圈程序员，群中人称李总，他的技术群是：【低端编程高端研究–223823428】。

二． CSLIGHT 为何而生

CSLight 最初出现的目的是为了解决Unity3D在IOS平台上的代码热更新的问题。 因为IOS平台上的代码热更新问题无法通过Mono Reflection机制来解决，故而只能引入脚本。
目前市面上的U3D脚本解决方案不多，被听说过的大致有三种： CSLight UniLua SSharp，三者中CSLight的优点较为出众：
1. 脚本执行性能最佳， 这个是因为李总的CSLight脚本解释器实现的非常轻量， 不刻意追求语言基础设施的完善性，
在保证充分可用性的前提下，完全的走实用主义道路，故而执行性能最佳。
2. 脚本语法兼容U3D项目开发中的标配C# 语言的大多数常用语法，借助李总的CSLightFramework，
可以在源文件级别上一定程度的做到 原生C# 和 脚本C# 文件的无缝切换。
3. CSLight有商业严肃项目的考验经历。

故，CSLight是Unity3D脚本解决方案的充分可行之选。

三． CSLIGHT 框架说明
CSLight从宏观上来看，只有两个部分，一个是CSLight解释器，另一个是CSLight框架。
对于刚接触CSLight的新人来说，CSLight最重要的是CSLight框架→ CSLightFramework，这个轻量级的框架设计的很漂亮， 这里先大致扫一眼该框架的结构和类图：

这个框架简洁优雅的实现了如下的两个目的：
1. 开发者可以快速的上手开发，通过框架的封装，使得开发者不需要关心底层解释器的机制。
2. 借助框架，一个C# 脚本文件，可以选择以【原生模式（Mono虚拟机）】 或 【CSLight脚本模式（CSLight解释器）】这两种不同的执行模式来运行。
那么为何需要两种运行模式呢？这是为了方便在IDE中调试脚本代码，因为只有在【原生模式】下运行才能借用IDE的断点调试等功能。可等代码稳定之后再切换到【CSLight脚本模式】。
参照上面的类结构图：
【原生模式的执行】是通过CodeFile_Debug类 的包装来达成的，其借助了反射机制来做到本地化运行。
【CSLight脚本模式的执行】是通过 CodeFile_CLScript类 的包装来达成的，其调用了CSLight底层解释器的接口来做到解释型的运行。

嗯，是时候需要一个典型的HelloWorld的例子，来进一步的理解这个框架了，这里就用经常有人问到的【CSLight如何与NGUI交互】来作为例子。
嗯，One more thing，在进入入门示例章节之前，有个非常重要的问题必须要先提一下，就是【脚本】与【宿主环境】如何交互的问题！熟悉Lua的朋友会知道，Lua是通过
【设置Lua虚拟机堆栈】的这种方式来和C/C++的【宿主环境】进行交互的。那CSLight的【脚本】是如何与Unity3D原生C#的【宿主环境】进行交互的呢？嗯，答案是：在宿主环境中的自定义接口！
看一下CSLightFramework框架中 ICodeFile 的定义如下：

其中的泛型T 就是【脚本】与【宿主环境】之间交互的关键所在，也正是上文强调过的【在宿主环境中的自定义接口】！
下面开始进行【CSLight如何与NGUI进行交互】的实例演示。

四． CSLIGHT 入门示例 — CSLIGHT 如何与 NGUI 进行交互

一个有意义的，同时又简洁的示例不太好找。这里随便选的一个示例是：【如何用CSLight脚本来控制NGUI中一个元素的缩放。】
虽然这个例子本身没有实际的意义，但通过这个例子搞懂框架的原理后，就可以很容易的做出一大堆有意义的事情来。

1. 新建一个Unity3D工程和场景，并把CSLight和CSLightFramework 这两份工程代码拷贝进去。
2. 新建一个NGUI_Root，并在 默认的Panel 节点下新建一个UISprite，然后随便弄个图片显示。
此时的大概情形如下所示：

3. 在项目中新建一个代码接口文件，作为【在宿主环境中的自定义接口】，大致如下面所示的样子：

其中第一个接口：SetNGUIElementScale(float scale); 设置NGUI某个元素的缩放，这个就没什么好说的了，届时CSLight脚本会调用这个宿主环境中的接口，传入想要缩放的数值。
其中第二个接口：IScript对象的getter方法，这个也没什么好说的，这个接口是框架约定必须要实现的，因为CSLight脚本方法之间的互相调用需要用到这个。

4. 回到Unity3D中，在NGUI默认生成的那个Panel 对象上绑定一个控制脚本（继承自MonoBehaviour），比如叫 TestController .cs，大体情形如下图所示：（记得要给那个 UISprite 对象赋上引用）

5. 通过继承框架中的 ScriptMgr类来创建自己的脚本管理器，代码大致如下图所示：

注意这一步需要继承并实现 ICLS_Logger 的三个接口（Log, Log_Warn, Log_Error），因为在 ScriptMgr 脚本管理器 实例化的时候，构造函数需要一个实现了ICLS_Logger 的对象作为参数。

6. 开始编写CSLight 真.脚本文件 ：Script_Test .cs，如下图所示，注意这个脚本文件要放到 Assets/StreamingAssets 目录中，以方便后面使用WWW来加载，用于模拟热更新时的远程脚本加载机制。

这个 真.脚本文件 的写法有几处地方要特别注意：
6.1 所有的方法必须是静态方法，否则无法切换到【原生模式】来运行，也就无法用IDE来Debug了，这是框架内用反射模拟原生模式时的约定。
6.2 必须有一个静态方法名叫：_new，类似 int main() { } 。
6.3 每个静态方法之间不能直接互相调用，需要通过图片中注释的说明方法来调用.
6.4 所有方法的第一个参数，必须是 【宿主环境中的接口】→ Interface_Test 对象.
7. 最后一步： 在TestController .cs 中继承并实现 【宿主环境中的接口】，然后加载上面的那个脚本并执行。
7.1 实现【宿主环境中的接口】→ Interface_Test，代码如下所示：

7.2 加载脚本并执行，代码如下所示：

至此，这个例子就结束了。