首页 / 技术文章地图 / 正文

【工程效率】luacheck + busted:Lua 代码规范与自动化测试

发布:2026-09-20 07:41 | 作者:996 技术组 | 1 阅读
完整课程入口:996 全套课程体系Lua 学习路径幂尔框架 mirs.cn

脚本多到必须上工具

项目过了几千个 Lua 文件,纯靠人眼 review 必然失控:未使用变量、全局污染、空函数、循环里悄悄改循环变量……这些低级但高发的问题,静态检查工具一次全扫出来。工具链的价值不在于"代码写得更漂亮",而在于把review 精力留给真正的业务逻辑。

luacheck:把规范变成机器执行

luacheck 是 Lua 生态最常用的静态检查器,检查的是"结构性问题"而非功能:未定义全局(手滑没写 local 的第一现场)、未使用变量与参数、遮蔽上层变量、空代码块、行宽等。它有官方的告警编号体系,团队可以按需开关:

bash
luacheck src/ --globals release_print SL lib996 --no-max-line-length
luacheck src/ --std luajit --codes

--globals 用于登记引擎注入的全局(SL、lib996 这类),否则满屏误报没人会坚持用。真正落地时配一个 .luacheckrc 配置文件进版本库,全员同一套标准;再接进构建流水线,检查不过就不出包——规范只有自动执行才叫规范,靠自觉的规范活不过三个月。

busted:给核心逻辑上保险

busted 是 Lua 的行为驱动测试框架,语法接近自然语言:

lua
describe("爆率计算", function()
    it("千分比概率应落在 0-1000", function()
        local r = calcDropRate( { base = 500 } )
        assert.is_true(r >= 0 and r <= 1000)
    end)

    it("幸运值满值必出", function()
        assert.equals(1000, calcDropRate( { base = 500, lucky = 500 } ))
    end)
end)

不必追求全覆盖,只测"值得测的":爆率与数值公式、存档合并、协议解析、热更状态迁移——这些出一次事故就很疼的纯逻辑函数,是单测性价比最高的地方。写测试还会倒逼函数设计变纯(输入决定输出、不偷偷改全局),而纯函数恰恰是最容易热更和测试的。

流水线串起来

最小可用流水线三步:提交前本地跑 luacheck;构建机自动跑 busted 全量用例;任一步失败即中止出包。有条件再加一步:用测试跑出来的覆盖率报告约束核心模块不低于目标行数。半天就能搭完,之后每次热更、每次改爆率,都有一层机器兜底——这比事后在群里问"谁动了这个文件"有效得多。

测试输出

release_print(msg)

打印消息到控制台,断言失败与用例名输出到控制台,开发期足够用

参数类型说明
msgany打印内容

logact(play, logAct, loginfo, nParam1, nParam2, nParam3, nParam4, nParam5)

自定义日志,把用例结果写入日志通道,便于与构建记录对应

参数类型说明
playobject玩家对象
logActinteger日志ID大于等于10000以上
loginfostring日志内容
nParam1integer整数型(可空)最大支持21亿
nParam2integer整数型(可空)最大支持21亿
nParam3integer整数型(可空)最大支持21亿

耗时基线

printusetime(play, on, off)

打印脚本总耗时(微秒),给关键用例加耗时基线,性能回退能被测试拦住

参数类型说明
playobject玩家对象
oninteger1=开始技术2=结束计时并打印耗时
offinteger2=结束计时

用例装载

require(path)

加载文件,测试用例与业务模块走同一套加载机制,避免环境差异

参数类型说明
pathany文件名两种加载接口起始路径不同

规范校核

checkcontainstextlist(path, str,model, result)

检查字符串是否在指定文件中,规范清单类校验可以直接读文件比对

参数类型说明
pathstring文件路径(必填参数)
strstring字符串(必填参数)
modelinteger检测模式0=列表中,是否包含被检测的字符1=被检测的字符是否包含列表中的某一行内容(必填参数)
resultboolture=在文件中false=不正文件中(必填参数)
作者履历与出处
本文由 996 技术组基于 996 引擎官方知识库与浮生梦老师课程体系整理,讲解体系出自多年商业端开发生产一线。作者团队长期从事传奇类引擎 Lua 后端逻辑、客户端界面与版本交付,内容以官方知识库与真实项目为出处,按版本持续修订。
© 威海旷世互娱 · 返回文章地图 · 课程体系 · 幂尔框架