第二章 LuaFramework - 2.27 代码热更新 - 《Lua程序设计》

代码热更新

代码热更新

一、新建场景

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

二、删掉事例的调用

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

    void OnInitialize() {
        LuaManager.InitStart();
        // LuaManager.DoFile("Logic/Game");         //加载游戏
        // LuaManager.DoFile("Logic/Network");      //加载网络
        // NetManager.OnInit();                     //初始化网络
        // Util.CallMethod("Game", "OnInitOK");     //初始化完成
        // ...
        initialize = true;
    }

三、编写lua代码

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

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

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

        //for LuaFramework
        _GT(typeof(RectTransform)),
        _GT(typeof(Text)),
        _GT(typeof(Util)),
        _GT(typeof(AppConst)),
        _GT(typeof(LuaHelper)),
        _GT(typeof(ByteBuffer)),
        _GT(typeof(LuaBehaviour)),
        _GT(typeof(GameManager)),
        _GT(typeof(LuaManager)),
        _GT(typeof(PanelManager)),
        _GT(typeof(SoundManager)),
        _GT(typeof(TimerManager)),
        _GT(typeof(ThreadManager)),
        _GT(typeof(NetworkManager)),
        _GT(typeof(ResourceManager)),

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

        public static void Log(string str) {
            Debug.Log(str);
        }
        public static void LogWarning(string str) {
            Debug.LogWarning(str);
        }
        public static void LogError(string str) {
            Debug.LogError(str);
        }

四、运行游戏

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

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

    //Lua代码AssetBundle模式
    public const bool LuaBundleMode = false;

五、热更新原理

接下来便要尝试代码热更新，让程序下载服务器上的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）。

    StreamingAssets|1738a512698f18f78bfca1591edcf5ae
    StreamingAssets.manifest|1994f53ee73e2badeddd65601d587f38
    message.unity3d|1ab91c2ccd6a03232c0255c1895c6435
    message.unity3d.manifest|9f46935cf1de80e8fab9927c6a25803f
    prompt.unity3d|01b68a164fa653bf853bedbda3a5f3d0
    prompt.unity3d.manifest|9ebfa552ca1e8a84360944c0dee65bb3
    prompt_asset.unity3d|1655812ce2260a4747a7fdb8e39fc007
    prompt_asset.unity3d.manifest|ed9d66a485b1d96d504f7002c52ef9a4
    shared_asset.unity3d|17ce04b42949f651895d634f852dd972
    shared_asset.unity3d.manifest|71721e8dbf69055affcf2a2e0b551f01
    tank.unity3d|a5f10487d490d13642d40fce937c195c
    tank.unity3d.manifest|202261f1e418ab2bbb8384ed6f54f958
    lua/Build.bat|4cfc2f258ecdb9bb43756a2e737c7a1d

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

六、开始热更新代码

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

1）、修改配置

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

    public class AppConst {
            public const bool DebugMode = true;                       //调试模式-用于内部测试
            /// <summary>
            /// 如果想删掉框架自带的例子，那这个例子模式必须要
            /// 关闭，否则会出现一些错误。
            /// </summary>
            public const bool ExampleMode = true;                       //例子模式 
            /// <summary>
            /// 如果开启更新模式，前提必须启动框架自带服务器端。
            /// 否则就需要自己将StreamingAssets里面的所有内容
            /// 复制到自己的Webserver上面，并修改下面的WebUrl。
            /// </summary>
            public const bool UpdateMode = true;     ✅                  //更新模式-默认关闭 
            public const bool LuaByteMode = false;                       //Lua字节码模式-默认关闭 
            public const bool LuaBundleMode = true;   ✅                 //Lua代码AssetBundle模式
            public const int TimerInterval = 1;
            public const int GameFrameRate = 30;                        //游戏帧频
            public const string AppName = "LuaFramework";               //应用程序名称
            public const string LuaTempDir = "Lua/";                    //临时目录
            public const string AppPrefix = AppName + "_";              //应用程序前缀
            public const string ExtName = ".unity3d";                   //素材扩展名
            public const string AssetDir = "StreamingAssets";           //素材目录 
            public const string WebUrl = "http://localhost/StreamingAssets/";    ✅  //测试更新地址
            public static string UserId = string.Empty;                 //用户ID
            public static int SocketPort = 0;                           //Socket服务器端口
            public static string SocketAddress = string.Empty;          //Socket服务器地址
            public static string FrameworkRoot {
                get {
                    return Application.dataPath + "/" + AppName;
                }
            }
    }

2）、配置“网络资源”

IIS（Internet Information Services）是一种Web（网页）服务组件，其中包括Web服务器、FTP服务器、NNTP服务器和SMTP服务器，分别用于网页浏览、文件传输、新闻服务和邮件发送等方面，它使得在网络（包括互联网和局域网）上发布信息成了一件很容易的事。控制面板 > 程序和功能 > 启用或关闭Windows功能 > 开启 “Internet Information Services”。打开IIS，win + R > inetMgr

创建ASP.NET项目 MyHotUpdateWebTest

添加index.html

    // index.html
    <!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
        <title></title>
        <meta charset="utf-8" />
    </head>
    <body>
        Hello MyFrameWork!
    </body>
    </html>

添加一般处理程序

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Script.Serialization;
    namespace MyHotUpdateWebTest
    {
        /// <summary>
        /// Login 的摘要说明
        /// </summary>
        public class Login : IHttpHandler
        {
            public void ProcessRequest(HttpContext context)
            {
                context.Response.ContentType = "text/plain";
                //context.Response.Write("Hello World");
                Dictionary<string, object> dic = new Dictionary<string, object>();
                dic["result"] = "success";
                JavaScriptSerializer jss = new JavaScriptSerializer();
                string result = jss.Serialize(dic);
                context.Response.Write(result);
                context.Response.End();
            }
            public bool IsReusable
            {
                get
                {
                    return false;
                }
            }
        }
    }

配置Web.config

    <?xml version="1.0" encoding="utf-8"?>
    <!--
      有关如何配置 ASP.NET 应用程序的详细信息，请访问
      http://go.microsoft.com/fwlink/?LinkId=169433
      -->
    <configuration>
      <system.web>
        <compilation debug="true" targetFramework="4.5" />
        <httpRuntime targetFramework="4.5" />
      </system.web>
      <system.webServer>
        <staticContent>
          <mimeMap fileExtension=".list" mimeType="application/octet-stream" />
          <mimeMap fileExtension=".ab" mimeType="application/octet-stream" />
        </staticContent>
        <directoryBrowse enabled ="true" />
      </system.webServer>
    </configuration>

3）、测试热更新

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

打包资源需要确认AppConst

    public const bool ExampleMode = true;                       //例子模式