Unity3D热更新LuaFramework入门实战(1)——代码热更新

小篱

文/罗培羽

这些日子在找Unity3D的现成框架，希望能给后续项目开发带来便利。找着找着，便关注到了LuaFramework，这是一套基于tolua的框架，可以实现热更新。然而相关的资料太少，磕磕碰碰的尝试之后，便有写一篇入门教程的想法。这套文章应该会有4篇左右，涉及LuaFramework的安装、代码热更新、资源热更新、lua文件的编写等几项内容。

1、安装框架

只要在http://www.ulua.org/index.html下载LuaFramework，然后用Unity3D打开，这里用的是LuaFramework_UGUI-1.0.4.109版本以及Unity3D 5.2，其他版本理应相似。打开之后需要点击lua菜单里面的Generate All和LuaFramework菜单里Build XXX Resources，以生成一些必要的文件。

安装过程可以参见http://pan.baidu.com/s/1gd8fG4N里面的01_uLua_Windows.avi和02_SimpleFramework_UGUI_Windows.avi两个视频（如果在windows系统下）。框架结构请参见http://doc.ulua.org/article/ngui/simpleframework_base1.html，这里不再复述。

若运行后能够弹出示范界面，证明安装成功，可以进入下一步。

成功运行示范界面（可要客户端能够运行起来就行）

2、运行Lua代码

这一步的目标很简单，就是让框架运行我们自己写的lua代码，显示一句“helloWorld”。下一步再考虑代码的热更新问题。

1）新建场景

在任意物体中添加Main组件。其实Main组件里面只是调用了AppFacade.Instance.StartUp()，这是框架的起点。框架将会自动完成资源加载、热更新等等事项。

添加Main组件

2）删掉示例的调用

现在不需要框架自带的示例了，需要删掉一些代码，使框架只运行我们编写的lua文件。打开Assets\LuaFramework\Scripts\Manager\GameManager.cs，将OnInitalize修改成下图这个样子。这是lua的入口，框架会调用Main.lua的Main方法。

修改GameManager的lua入口

3）编写lua代码

打开Assets\LuaFramework\Lua\main.lua，编写lua代码。这里只添加一句“LuaFramework.Util.Log("HelloWorld");”（如下所示），它的功能相当于Debug.Log("HelloWorld")。

--主入口函数。从这里开始lua逻辑

1. --主入口函数。从这里开始lua逻辑
   
2. function Main()
   
3.     LuaFramework.Util.Log("HelloWorld");
   
4. end

复制代码

“LuaFramework.Util.Log("HelloWorld")”中的Util是c#里定义的类，供lua中调用。可以打开Assets\LuaFramework\Editor\CustomSettings.cs看到所有可以供lua调用的类，如下图是CustomSettings.cs的部分语句。

CustomSettings.cs的部分语句

再由具体的类可以查找所有的API（参见下面两个图），如下图是Util类的部分语句。

Util类（Assets\LuaFramework\Scripts\Utility\Util.cs）的部分语句

4）运行游戏

点击菜单栏中LuaFramework→Build Windows Resource，生成资源文件。然后运行游戏，即可在控制台中看到打印出的HelloWorld。

生成资源文件

运行结果

按照默认的设置，每更改一次lua代码，都需要执行Build XXX Resource才能生效。读者可以将Assets\LuaFramework\Scripts\ConstDefine\AppConst.cs中的LuaBundleMode修改为false，这样代码文件便不会以AssetBundle模式读取，会直接生效，以方便调试。

设置LuaBundleMode

3、热更新的原理

接下来便要尝试代码热更新，让程序下载服务器上的lua文件，然后运行它。在说明热更新之前，需要先看看Unity3D热更新的一般方法。如下图所示，Unity3D的热更新会涉及3个目录。

热更新的过程

游戏资源目录：里面包含Unity3D工程中StreamingAssets文件夹下的文件。安装游戏之后，这些文件将会被一字不差地复制到目标机器上的特定文件夹里，不同平台的文件夹不同，如下所示（上图以windows平台为例）

Mac OS或Windows：Application.dataPath+"/StreamingAssets";

IOS：Application.dataPath+"/Raw";

Android：jar:file://"+Application.dataPath+"!/assets/";

数据目录：由于“游戏资源目录”在Android和IOS上是只读的，不能把网上的下载的资源放到里面，所以需要建立一个“数据目录”，该目录可读可写。第一次开启游戏后，程序将“游戏资源目录”的内容复制到“数据目录中”（步骤1，这个步骤只会执行一次，下次再打开游戏就不复制了）。游戏过程中的资源加载，都是从“数据目录”中获取、解包（步骤3）。不同平台下，“数据目录”的地址也不同，LuaFramework的定义如下：

Android或IOS：Application.persistentDataPath+"/LuaFramework"

Mac OS或Windows：c:/LuaFramework/

调试模式下：Application.dataPath+"/StreamingAssets/"

注：”LuaFramework”和”StreamingAssets”由配置决定，这里取默认值

网络资源地址：存放游戏资源的网址，游戏开启后，程序会从网络资源地址下载一些更新的文件到数据目录。

这些目录包含着不同版本的资源文件，以及用于版本控制的files.txt。Files.txt的内容如下图所示，里面存放着资源文件的名称和md5码。程序会先下载“网络资源地址”上的files.txt，然后与“数据目录”中文件的md5码做比较，更新有变化的文件（步骤2）。

files.txt

LuaFramework的热更新代码定义在Assets\LuaFramework\Scripts\Manager\GameManager.cs，真正用到项目时可能还需少许改动。

4、开始热更新代码吧！

那么开始测试热更新代码的功能吧！热更上述实现的“HelloWorld”。

1）修改配置

框架的默认配置是从本地加载文件，需要打开AppConst.cs将UpdateMode设置为true（才会执行步骤2），将LuaBundleMode设置为true，将WebUrl设置成服务器地址。如下图所示。

AppConst的配置

2）配置“网络资源”

笔者使用iis开启本地服务器，然后将StreamingAssets里面的所有内容复制到服务器上面。必要时要配置一些权限，让所有文件都都可以下载。

通过网络访问文件

3）测试热更新

改一下Lua脚本（如将HelloWorld改为Hello Lpy2），点击Build Windows Resource，将“工程目录/StreamingAssets”里面的文件复制到服务器上。再将脚本改成其他内容，然后Build Windows Resource，覆盖掉本地资源。运行游戏，如果程序显示“Hello Lpy2”的代码，证明成功从网上拉取了文件。

代码热更新

笔者也是刚刚接触LuaFramework，想看看该框架是否适用于团队接下来的项目。感谢ToLua和LuaFramework作者的无私奉献。下一节将会介绍使用LuaFramework做资源热更新的内容。谢谢支持。

最后是广告时间

笔者即将出版的一本Unity3D实战类书籍《Unity3D网络游戏实战》。该书通过一个完整的多人坦克对战实例，详细介绍网络游戏开发过程中涉及到的知识和技巧。书中还介绍了服务端框架、客户端网络模块、UI系统的架构等内容。相信透过本书，读者能够掌握Unity3D网络游戏开发的大部分知识，也能够从框架设计中了解商业游戏的设计思路，感谢大家支持。

通过《Unity3D网络游戏实战》读者便可以学会制作这样的多人对战游戏

专栏地址：https://zhuanlan.zhihu.com/p/21386682