Unity+VSCode+XLua+断点调试

Unity安装

去官网下个相对较新的版本,我这里是使用的2020.2.6f1,证书选择个人版。Unity下载页面

IDE安装

个人习惯使用VSCode,去官网下个新版就行。Visual Studio Code - Code Editing. Redefined

为了保证能对C#代码进行断点调试,我们还需要给IDE装上这个C#和DebuggerForUnity的插件。

编写C#代码并断点调试

新建一个Unity项目并打开,在编辑器顶部菜单栏找到Edit > Preferences > ExternalTools将External Script Editor引用改成VSCode。然后再回到Unity编辑器顶部菜单栏找到Assets > Open C# Project 打开我们的工程代码。

新建一个HelloWorld.cs
Ctrl+Shift+P呼出面板
按F5进入调试模式,选择当前正在运行的Unity程序
再回到Unity工程将HelloWorld.cs挂载到当前场景内,点击运行

正常情况下是能断点成功的,如果不正常,多半是系统的.NET版本没对,用这个试试NET Framework 4.7.1 Developer Pack-enu

代码热更方案

我选择的是腾讯的XLua,虽然没怎么深入了解过,但市面上已经有很多商业游戏对其进行过了验证,要满足我们的需求那自然是绰绰有余。

到GitHub上找到当前最新的发布版本 Release Tag:v2.1.16_android_release_lib · Tencent/xLua · GitHub 下载完成后解压一下,由README.md我们能得知一些XLua的基础概念与以下几点:

1.需要将Assets文件夹内的东西拷进Unity工程目录下的Assets文件夹内。(当然如果你有目录洁癖也可以删掉XLua文件夹下的Doc、Examples、Tutorial)

2.用c#执行一个Lua脚本。新建一个c#脚本,挂载到当前Unity场景内,脚本内容如下:

using XLua;
using System.IO;

    void Start()
    {
        // 启动lua管理器
        LuaEnv _luaEnv = new LuaEnv();
        // 重写lua内的require函数回调,方便自定义载入路径
        _luaEnv.AddLoader(CustomLoader);
        // 启动一个脚本载体
        LuaTable _scriptEnv = _luaEnv.NewTable();

        // 为该脚本添加XLua提供的全局变量及函数
        LuaTable meta = _luaEnv.NewTable();
        meta.Set("__index", _luaEnv.Global);
        _scriptEnv.SetMetaTable(meta);
        meta.Dispose();
        _scriptEnv.Set("self", this);

        // 执行该脚本
        var _luaScript = LoadLuaFile("HelloWorld");
        _luaEnv.DoString(_luaScript, "HelloWorld", _scriptEnv);

        // 取到Lua脚本内的指定名称函数并运行
        Action _luaFunction;
        _scriptEnv.Get("MyFunction", out _luaFunction);
        _luaFunction();
        // 最后当你不再需要的时候,记得使用.Dispose()销毁脚本载体及管理器
    }
    /// <summary>
    /// 自定义载入回调
    /// </summary>
    /// <param name="filepath"></param>
    /// <returns></returns>
    byte[] CustomLoader(ref string filepath)
    {
        filepath = filepath.Replace(".", "/");
        return LoadLuaFile(filepath);
    }

    // 将自定义目录下指定名字的lua脚本加载为字节流
    byte[] LoadLuaFile(string filePath)
    {
        var fileAddress = Path.Combine(Application.dataPath + "/Lua/", filePath + ".lua");
        FileInfo _info = new FileInfo(fileAddress);
        if (_info.Exists)
        {
            StreamReader r = new StreamReader(fileAddress);
            return System.Text.Encoding.UTF8.GetBytes(r.ReadToEnd());
        }
        return null;
    }

3.在Unity工程内Assets/Lua 目录下新建一个文本文档"HelloWorld.lua",打开进行如下编辑

print("Hello World")

function MyFunction()
    print("This is MyFunction")
end

最后回到Unity运行场景,正常情况下这时控制台就会打印出你的"Hello World"和"This is MyFunction"了。

VSCode上断点调试Lua

我是使用的luaide,它除了能断点调试之外还有很多便捷功能,虽然是付费插件,但是100块买断的价格也算很亲民了,换设备也能继续使用,强烈推荐。


安装插件

安装完毕之后进行调试设置


打开VSCode设置界面,找到这个打钩

重启VSCode,正常情况等待片刻就会自动下载调试文件到本地

点击找到调试文件

把整个luadebug文件夹拷贝到Unity工程的Asstes/Lua下面,之后会看到Unity报LuaDebugTool.cs文件有错,点开纠正下语法错误,把无关的代码注释一下就好了。

然后把下面代码放在lua脚本内,保证它在最开始被执行到

local breakSocketHandle,debugXpCall = require("luadebug.LuaDebugjit")("localhost",7003)
breakSocketHandle()

之后我们配置调试参数



会自动创建launch.json文件并且进行各种lua框架的调试配置,如果有代码洁癖的话,我们可以只保留XLua的,即

        {
            "name": "Unity-xlua",
            "type": "lua",
            "request": "attach",
            "runtimeType": "Unity",
            "localRoot": "${workspaceRoot}",
            "fileExtNames": [
                ".lua",
                ".txt",
                ".lua.txt",
                ".bytes"
            ],
            "port": 7003,
            "printType": 1
        },

完事后我们验证下成功与否,按下F5进入调试模式,再运行Unity场景


OhYeah,大功告成
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容