Unity3D|-XLua热更新用法的大致流程

xlua是由腾讯维护的一个开源项目,我们可以在github上下载这个开源项目并查看一些相关文档

官网https://github.com/Tencent/xLua

配置文档https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/hotfix.md

常见问题解答https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/faq.md


接下来我们来走一遍使用xlua的大致流程:

第一步:下载xlua:进入官网并下载整个xlua项目

第二步:将xlua导入项目:将下载后的xLua-master文件夹下的Assets文件夹拷贝到项目文件夹下,将Tools文件夹拷贝到项目文件夹Assets的同级目录下并删除其中的System.Core.dll文件

  这一步完成后unity编辑器的工具栏会多出一个Xlua的选项,其中里面会有两个子选项(Gennerate Code生成脚本、Clear Gennerate Code清除脚本)

  

第三步:开启热更新:打开playersettings,开启脚本宏命令标志输入HOTFIX_ENABLE并按ENTER(即找到othersetins中的ScriptsingDefineSymbols输入HOTFIX_ENABLE并按ENTER)敲完按回车才会进行编译

  

  编译完成后Xlua选项中多了一项(Hofix Inject In Editor

  C#脚本发生了任何更改都需要按选项1来生成代码,有问题就选项2清楚脚本再重新生成,生成代码结束后会debug一个finished出来,此时再选项3进行注入

  

  图片来源:https://blog.csdn.net/ChinarCSDN/article/details/81124973

第四步:打开unity安装目录中的Editor\Data\Managed\Unity.Cecil.Pdb.cll、Mdb.dll、.cll三个文件拷贝到工程目录下的xula文件夹下的srceditor文件夹下


关于XLua的使用:

xlua在项目中的启动、调用、结束等全过程:

我们使用一个脚本来管理xlua的流程  HotfixScript

脚本中创建一个唯一的解释器 new LuaEnv()

加载自定义loader AddLoader()

搜寻并执行lua文件 Dostring(" require ‘lua文件名‘ ")

    private LuaEnv luaEnv;

    void Awake()
    {
        luaEnv = new LuaEnv();//创建解释器
        luaEnv.AddLoader(MyLoader);//加载自定义loader
        luaEnv.DoString("require ‘fish‘");//搜寻lua脚本
    }

自定义Loader需要传入一个文件路径再返回读取到的文件的byte数组

    private byte[] MyLoader(ref string filePath)
    {
        string absPath = @"E:\app\unity2018\products\FishXlua\" + filePath+".lua.txt";
        return System.Text.Encoding.UTF8.GetBytes(File.ReadAllText(absPath));
    }

最后的释放资源分两部分,一个是释放方法委托,一个是解释器,前者在OnDisable中调用lua代码来执行,后者在OnDestroy中来释放

    void OnDisable()
    {
        luaEnv.DoString("require ‘fishDispose‘");
    }

    void OnDestroy()
    {
        luaEnv.Dispose();
    }

如何使用lua代码对游戏内容进行更改?

在原来的可能出问题的C#类上打上hotfix标签,在方法上打上luacallcsharp标签

之后便可在lua脚本中进行更改

修改格式如下:

xlua.hotfix(CS.类名,‘方法名‘,function(self)

  具体实现的方法体

end)

PS:当在lua脚本中可能需要用到某个c#类中的私有访问属性字段时,可以使用以下格式来获取访问权限

xlua.private_accessible(CS.类名)

调用C#中的一些自带的类、方法

CS.UnityEngine、CS.类名.方法……

通过自身对象调用自身方法:self:方法名()   或者   self.方法名(self)  前者使用冒号的方式是为了简写传入self参数的过程

解绑委托:专门用一个lua脚本来负责解绑所有lua调用重写过的方法

例如:xlua.hotfix(CS.类名,‘方法名‘,nill)

与改写方法类型,只是在最后一个参数将function改成了nill表示置空


总结一下使用xlua热更新的开发过程:

  • 首先开发业务代码
  • 在所有可能出现问题的类上打上hotfix标签,在所有lua调用C#的方法上打上luacallcsharp标签,在所有csharp调用lua的方法上打上csharpcalllua标签
  • 打包发布
  • 修改bug时只需要更新lua文件,修改资源时只需要更新AB包,用户只需要去下载AB包和lua文件就可以了

原文地址:https://www.cnblogs.com/wq-KingStrong/p/10362331.html

时间: 2024-10-08 09:50:41

Unity3D|-XLua热更新用法的大致流程的相关文章

Unity3D逻辑热更新,第二代舒爽解决方案,L#使用简介

热更新 天下武功,无坚不破,唯快不破 热更新就是为了更快的把内容推到用户手中. 之前,我设计了C#Light,经过半年多的持续修补,勉强可用,磕磕绊绊.感谢那些,试过,骂过,用过的朋友,在你们的陪伴下一路走来,也让我更坚定了要把这件事做好的决心.于是就有了C#Light的2.0,L#. 为什么叫L#呢?因为这次是直接加载解析DLL执行,Load,有一个L因为直接执行的东西叫做IL,有一个L因为模拟CLR的工作,有一个L于是,就有了L# https://github.com/lightszero/

[Unity XLua]热更新XLua入门(二)-俄罗斯方块实例篇

前言 在xLua没出来之前,开源的lua框架基本都是以界面用Lua开发为主,核心战斗用C#开发,但xLua出来之后主推C#开发,Lua用作HotFix,这里我展示的第一个例子就是基于界面的经典2D小游戏--俄罗斯方块,界面逻辑是用C#写,启动加载逻辑是用lua,后面我会继续第二个同样的Demo,但是以纯Lua为主,这个案例明天更新. 效果图 由于我不会美术,所以这里使用的开源的游戏资源,感谢此作者. 游戏启动 C#启动Lua逻辑 using UnityEngine; using System.C

Xlua热更新

---恢复内容开始--- 1.当配置好xlua环境后,依次点击编辑栏的Xlua选项,如下: 2.在工程文件中找到Assets\Xlua\Resources,在此目录下新建两个txt文本,命名格式为xxx.lua.txt 3.在unity中创建编译脚本 using System.Collections; using System.Collections.Generic; using UnityEngine; using XLua; using System.IO; public class Xlu

Unity3D热更新方案网摘总结

参考:http://blog.csdn.net/guofeng526/article/details/52662994 http://blog.csdn.net/u010019717/article/details/50853207 "热更新"这个词,在Unity3D的应用下,是有些语义错误的,但是作为大家都熟知的一项技术,我们姑且这么叫它,相信很长时间内,大家依然还会这么叫,甚至有人叫它"暖更新". 一.什么是热更新? 广义定义 无需关闭服务器,不停机状态下修复漏

Unity3D游戏开发之Lua与游戏的不解之缘终结篇:UniLua热更新完全解读

----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 喜欢我的博客请记住我的名字:秦元培,我的博客地址是blog.csdn.net/qinyuanpei. 转载请注明出处,本文作者:

Unity3D热更新全书-何谓热更新,为何热更新,如何热更新

首先来赞叹一下中文,何谓为何如何,写完才发现这三个词是如此的有规律. 为何赞叹中文?因为这是一篇针对新手程序员的文字,是一节语文课. 然后来做一下说文解字,也就是 何谓热更新 热更新,每个程序员一听就明白,但是它语出何处,究竟表达了什么含义,到底代表了什么,对技术有什么要求,对经验相对较少的程序员来说可能就有一层神秘面纱了. 热更新,是对hot update 或者 hot fix的翻译,计算机术语,表示在不停机的前提下对系统进行更改. hot 就是热,机器运行会发烫,hot就是不停机的意思. 热

Unity3D热更新全书-重头再来

之前写了Unity3D热更新全书系列Blog 提出了下载.加载.脚本三个方面的开源类库 下载方面有EasyDown加载方面有GameObjParser脚本方面有C#Light另外有一个没有独立成库,但是到处都用的Myjson. 2015,重头思考这些事情,有了不一样的感悟,于是也有了新的规划 1.首先了C#Light的语法解释问题变得臃肿低效,重头开始了L#项目.目前L#项目已经进入Beta阶段,完全可以全面替换C#Light.MyJson也独立成库2.下载方面,Easydown是基于经典的文件

Unity3D热更新全书-下载 唯一的一篇

下载在这个时代实在是太平常了,每个人都深刻的理解着下载到底是什么. 这一篇文字只是把下载的代码分享并介绍,而已. 首先,下载系统担负着几个使命. 第一.是保持客户端版本库的最新. 第二.是下载要能够比对并最少下载 第三.是要尽量快一些. 其实我们并没有写一个下载系统,因为实在没有几行代码.我们这里介绍的是一个 Http下载并保存缓存,首包从StreamingAssets读取,加载资源,三个功能在一起的模块 源码位置https://github.com/lightszero/easydown 保持

Unity3D热更新全书-脚本(三) C#LightEvil语法与调试

调试,这是一个无法规避的问题 C#Light 由于有 词法解释.语法解释.运行时三种情况 所以和C#也是有类似的问题 出错大致可以分为编译错误和运行时错误 拼写出莫名的东西或者语法不正确,会在编译阶段报错,这种错误很好检查,因为 C#Light语法是C#的严格子集,所有的C#Light脚本都可以用C#的标准做语法检查 这也是C#Light基本上是用VisualStudio做编辑器的原因所在,直接作为C#代码编译,可以排除大部分的语法问题. 然后剩下的一些作为C#代码可以编译过,但是C#Light