Unity3D热更新技术点——ToLua（上）

注： 本文主要介绍tolua的基本原理及其在unity中的使用，希望阅读本文的读者有lua基础，可通过 Lua教程 （其中也有IDE的推荐等）或其他途径先进行lua 的学习

热更新

在介绍tolua前，我们首先来了解一下在游戏开发中，热更新的概念。

热更新是一种手游及App常用的更新方式，举例来说，游戏上线后，玩家需要通过应用商店及其他渠道下载第一个版本。在运营的过程中，如游戏需要更换UI、修改逻辑、开放功能等，此时若不使用热更新技术，就需要重新打包，那么玩家也就需要通过应用商店或其他渠道重新下载游戏。 热更新可以在不重新下载客户端的情况下，更新游戏的内容。

目前手游这部分做得普遍比较成熟，大大小小的内容升级基本都通过热更新来完成

然而c#是一门编译型语言，其运行之前需要进行编译，而编译的过程在移动平台无法完成，所以当我们游戏的逻辑更改，代码发生变化时，我们就需要重新在开发环境下编译，然后重新打包，让玩家下载最新版本。这个过程中，会下载很多不需要更新的资源，便会增加玩家的时间及流量消耗，造成不好的用户体验。因此在移动平台中便就出现了热更新技术。

• 在unity中，主要的热更新方式有如下三种：

1.使用Lua编写游戏逻辑；
Lua是一个小巧的脚本语言，由标准C编写而成，几乎在所有操作系统和平台上都可以编译，运行。
使用lua热更新就是在Unity环境里内嵌一个lua虚拟机，经常变动的和对执行效率没要求的逻辑用Lua实现，游戏启动时加载服务器上最新的lua字节码来执行游戏。lua代码都是运行时才编译的，不运行的时候就如同一张图片、一段音频一样，都是文件资源；所以更新逻辑只需要更新脚本，不需要再编译，因而lua能轻松实现“热更新”。
其实诸如python，javascript等脚本语言的话，都是可以实现这个功能的。只不是目前几个开源的、成熟的热更新方案都是基于lua的。
 

2.C#Light
C#Light是一个简单的嵌入式脚本，模仿c#的语法风格，完全由pure c#写成
 

3.C#反射技术
可以将部分逻辑提取至一个单独的代码库工程中，打包为DLL，将DLL打包为AssetBundle，Unity程序动态加载AssetBundle中的DLL文件，使用反射机制来调用代码。用C#反射加载程序集的方式可以动态的从assetBundle资源包或其他资源包里加载脚本到工程中。但因为苹果官方禁止iOS下的程序热更新，JIT在iOS下无效，所以这种方式无法在ios使用
 

本文中主要来了解第一种方式，在unity的lua热更新中，有ulua、slua、xlua、tolua等多种热更新方案，这些方案提供了C#与Lua的互相调用机制。在本文我们以现今市面最常见的tolua为例，通过一个小项目给读者介绍tolua在unity中的使用方法。

注：本文中仅介绍tolua的用法，不会详细介绍tolua热更新的方法，如需要了解tolua热更新可以通过 toluaLuaFramework框架作者的博客及 LuaFramework基础来了解、学习。

---

ToLua使用

Tolua是Unity静态绑定lua的一个解决方案，它通过C#中集成lua的插件，可以自动生成用于在lua中访问Unity的绑定代码，并把C#中的常量、变量、函数、属性、类以及枚举暴露给lua。其从cstolua衍变而来。

既然要了解Tolua，第一步肯定是先从Tolua作者的GitHub下载Tolua资源GitHub - topameng/tolua: The fastest unity lua binding solution 同时我们可以通过其GitHub来了解Tolua的主要特性，也可以加tolua技术交流群进行讨论及学习（在GitHub中有群号）。

下载完成后可以看到tolua文件夹中的目录结构，如下图：

我们只需要将「Assets」、「Unity5.x」、「Luajit64」、「Luajit」四个文件夹复制到我们的工程文件夹中。 加载完成后，Unity中会出现如下提示框，我们点击确定

然后在unity中就可以看到Tolua的主要文件列表

---

ToLua案例

在了解了基本的热更新概念，及ToLua资源的加载后，我们通过一个小的案例，来初步的掌握ToLua在Unity中的使用方法。 在本文中，我们使用ToLua来制作一个可以用按键控制滚动的小球，如下图所示：

学习或使用过Unity的读者应该能够非常轻松的使用C#写出这个小游戏，那么我们现在来看使用ToLua是如何达到上图效果的。

我们直接来看代码，下面会对代码进行逐行解释：

Control.lua

Control = {}
local this = Control
require('Music')
local GameObject = UnityEngine.GameObject
local Input = UnityEngine.Input
local AudioSource = UnityEngine.AudioSource
local Rigidbody = UnityEngine.Rigidbody
local Color = UnityEngine.Color
local Sphere
local rigi
local force

function this.Start()
    Sphere = GameObject.Find('Sphere')
    Sphere : GetComponent('Renderer').material.color = Color(1, 0.1, 1)
    Sphere : AddComponent(typeof(AudioSource))
    coroutine.start(Music.PlaySound)
    Sphere : AddComponent(typeof(Rigidbody))
    rigi = Sphere : GetComponent('Rigidbody')
    force = 5
end

function this.Update()
    local h = Input.GetAxis('Horizontal')
    local v = Input.GetAxis('Vertical')
    rigi : AddForce(Vector3(h, 0, v) * force)
end 

Music.lua

--协程下载
--这里使用Tolua中提供的coroutine.www
Music = {}
local this = Music
function this.PlaySound()
    local audio = UnityEngine.GameObject.Find('Sphere') : GetComponent('AudioSource')
    local url = UnityEngine.WWW('https://etnly.oss-cn-shanghai.aliyuncs.com/%E5%B2%A1%E9%83%A8%E5%95%93%E4%B8%80%20-%20%E9%81%BA%E3%82%B5%E3%83%AC%E3%82%BF%E5%A0%B4%E6%89%80%EF%BC%8F%E6%96%9C%E5%85%89.ogg')
    coroutine.www(url)
    audio.clip = url : GetAudioClip()
    audio : Play()
end

• 首先，我们在project面板中创建Script文件夹，下一层创建Lua文件夹，这个文件夹会存放我们所有的lua脚本。

• 然后我们来详细解释上方的代码：

1. Control = {} ： 在lua中没有类的概念，第一行中我们用lua表模拟一个类，类名为Control；
2. local this = Control ： 既然在lua中不存在类的概念，那也不会存在this的用法，这里同样的，我们模拟一个this，让this = Control类；
3. require('Music’) ： lua通过require函数来加载模块（希望读者可以自行了解lua中模块的含义）在本行中Muisc模块是一个下载并播放音乐的协程模块，具体代码在Muisc.lua中；
4. local GameObject = UnityEngine.GameObject ： 这里及其以下四行都是对Unity中的类、方法进行加载或者说调用，我们可以直接在代码中使用UnityEngine.GameObject，或把UnityEngine.GameObject赋给一个变量（如第一行中，lua使用表来模拟类，那这里的GameObject也就是一个table类型）；
5. local Sphere ： 这里及以下两行，我们定义了几个变量；
6. function this.Start() end ：这是lua中的函数，this的含义在之前有提到，我们也可以写成Control.Start()， 我们在start函数中进行一些必要的初始化操作，可以把它看成Unity中的start（我们也可以给它起别的名字，这个函数的名字和之后我们在Unity中的调用没有必然联系），不要忘了加后面的end，这句话代表此方法的结尾；
7. Sphere = GameObject.Find('Sphere') ： 我们通过GameObject.Find来找到Unity中的小球（需要注意，lua脚本无法绑定在Unity中的物体上，所以也无法直接在Unity的面板中绑定Unity中的对象，我们只有通过查找的方式来找到Unity中的物体）；
8. Sphere : GetComponent('Renderer').material.color = Color(1, 0.1, 1) ：这一行中，我们使用GetComponent通过获取Renderer组件，改变小球的颜色 ；
9. Sphere : AddComponent(typeof(AudioSource)) ： 使用AddComponent，给小球添加AudioSource组件；
10. coroutine.start(Music.PlaySound) ： 开启协程， 我们可以直接看到 Music.lua这个脚本，在脚本中，我们使用ToLua封装的coroutine.www()方法，来下载音乐，并通过之后的代码来播放音乐；
11. Sphere : AddComponent(typeof(Rigidbody)) ： 给小球添加刚体 ；
12. rigi = Sphere : GetComponent('Rigidbody') ： 获取小球的刚体，将其赋给rigi ；
13. force = 5 ： 这里作为力的大小；
14. function this.Update() end ： 与之前start函数类似，我们可以将其看作是Unity中的Update（再次声明，此处Lua函数名和Unity中的调用没有必然联系）；
15. local h = Input.GetAxis('Horizontal') ： 这一行及下一行，就是获取按下相应按键，相应轴上的位移量 ；
16. rigi : AddForce(Vector3(h, 0, v) * force) ： 通过刚体的AddForce方法，给小球施加力；
     

这就是我们整个例子的Tolua脚本使用说明，那么我们该如何在Unity中来调用这些脚本呢。 下面我们来了解在C#中调用ToLua的方法，代码如下所示：

using UnityEngine;
using LuaInterface;
public class Control : MonoBehaviour {
    LuaState lua = null;
    LuaFunction luaFunc = null;
    void Start () {
        new LuaResLoader();
        lua = new LuaState();
        lua.Start();
        LuaBinder.Bind(lua);
        string luaPath = Application.dataPath + "/Scripts/Lua";//注意这里的文件位置
        lua.AddSearchPath(luaPath);
        lua.DoFile("Control.lua");
        CallFunc("Control.Start", gameObject);//调用lua中的this.Start函数
    }
    void Update () {
        CallFunc("Control.Update", gameObject);调用lua中的this.Update函数
    }
    private void OnApplicationQuit()
    {
        lua.Dispose();
        lua = null;
    }
    void CallFunc(string func, GameObject obj){
        luaFunc = lua.GetFunction(func);
        luaFunc.Call(obj);
        luaFunc.Dispose();
        luaFunc = null;
    }
}

我们可以通过这段代码来了解一些C#中调用Tolua的基本操作：

1.new LuaState() ： 初始化Lua虚拟机
2.LuaState.Start() ：开启Lua虚拟机
3.LuaState.AddSearchPath(fullPath)：添加目录地址
4.LuaBinder.Bin(LuaState)：向Lua虚拟机注册Wrap类
5.new LuaResLoader() ：自定义加载器加载lua文件
6.LuaState.DoFile()、LuaState.Require()：加载Lua文件/模块
7.LuaState.GetFunction：获取Lua方法
8.LuaState.GetFunction.Call()：调用Lua函数
9.Luafunction.Dispose(),LuaState.Dispose()：释放内存

到此为止，我们已经了解了如何在Unity中使用ToLua来进行逻辑编写，读者可以根据以上的例子来扩展，实现更多的功能，或在自己的项目中加入lua代码来深入学习lua。