调试(Debug)

调试是软件开发过程中非常重要的一环，它可以帮助我们找出并修复程序中的错误。本章节将介绍 Lua 中的调试工具和技术。

debug 库

Lua 提供了一个 debug 库，用于调试 Lua 程序。

debug.getinfo

debug.getinfo 函数用于获取函数的信息：

function foo(a, b)
  local info = debug.getinfo(1)
  print("函数名：" .. info.name)
  print("文件名：" .. info.source)
  print("行号：" .. info.currentline)
  return a + b
end

foo(10, 20)

输出：

函数名：foo
文件名：@test.lua
行号：3

debug.traceback

debug.traceback 函数用于获取当前的调用栈：

function bar()
  print(debug.traceback())
end

function foo()
  bar()
end

foo()

输出：

stack traceback:
	@test.lua:3: in function 'bar'
	@test.lua:7: in function 'foo'
	@test.lua:10: in main chunk

debug.debug

debug.debug 函数用于进入交互式调试模式：

function foo()
  local x = 10
  debug.debug()
  return x
end

foo()

当执行到 debug.debug() 时，会进入交互式调试模式，此时可以输入 Lua 命令来查看和修改变量的值。

debug.setlocal 和 debug.getlocal

debug.setlocal 和 debug.getlocal 函数用于设置和获取函数的局部变量：

function foo()
  local x = 10
  local y = 20
  local i = 1
  while true do
    local name, value = debug.getlocal(1, i)
    if not name then
      break
    end
    print(name .. " = " .. value)
    i = i + 1
  end
  return x + y
end

foo()

输出：

x = 10
y = 20
i = 1

debug.sethook 和 debug.gethook

debug.sethook 和 debug.gethook 函数用于设置和获取钩子函数，钩子函数可以在特定的事件发生时被调用：

-- 设置钩子函数，在每次执行一行代码时被调用
debug.sethook(function(event, line)  
  local info = debug.getinfo(2)
  print(info.source .. ":" .. line)
end, "l")

function foo()
  local x = 10
  local y = 20
  return x + y
end

foo()

-- 移除钩子函数
debug.sethook()

输出：

@test.lua:12
@test.lua:13
@test.lua:14

调试技巧

打印变量值

最简单的调试方法是使用 print 函数打印变量的值：

function foo(x, y)
  print("x = " .. x)
  print("y = " .. y)
  return x + y
end

foo(10, 20)

使用 assert

assert 函数可以在条件不满足时抛出错误：

function divide(a, b)
  assert(b ~= 0, "除数不能为零")
  return a / b
end

divide(10, 0)

输出：

lua: test.lua:3: 除数不能为零
stack traceback:
	[C]: in function 'assert'
	@test.lua:3: in function 'divide'
	@test.lua:6: in main chunk

使用 pcall

使用 pcall 函数可以捕获错误并继续执行：

function riskyOperation()
  error("发生错误")
end

local status, result = pcall(riskyOperation)
if not status then
  print("错误：" .. result)
  -- 处理错误
end

使用 xpcall

使用 xpcall 函数可以捕获错误并调用错误处理函数：

function errorHandler(err)
  print("错误处理：" .. err)
  print(debug.traceback())
  return err
end

function riskyOperation()
  error("发生错误")
end

local status, result = xpcall(riskyOperation, errorHandler)
if not status then
  print("错误：" .. result)
  -- 处理错误
end

调试工具

ZeroBrane Studio

ZeroBrane Studio 是一个专为 Lua 设计的轻量级 IDE，它提供了以下调试功能：

• 断点设置
• 单步执行
• 变量查看
• 调用栈查看

Visual Studio Code

Visual Studio Code 配合 Lua 插件也可以用于调试 Lua 程序：

• 安装 Lua 插件
• 配置 launch.json 文件
• 设置断点并开始调试

调试的最佳实践

1. 使用断点：在关键位置设置断点，观察程序的执行流程
2. 检查变量：在断点处检查变量的值，确保它们符合预期
3. 使用日志：在关键位置添加日志，记录程序的执行状态
4. 隔离问题：将问题隔离到最小的代码片段，便于分析
5. 重现问题：确保能够稳定重现问题，便于验证修复

示例：调试一个函数

function factorial(n)
  if n < 0 then
    error("参数不能为负数")
  elseif n == 0 then
    return 1
  else
    return n * factorial(n - 1)
  end
end

-- 调试 factorial 函数
local status, result = pcall(factorial, 5)
if status then
  print("5! = " .. result)
else
  print("错误：" .. result)
end

local status, result = pcall(factorial, -1)
if status then
  print("-1! = " .. result)
else
  print("错误：" .. result)
end

输出：

5! = 120
错误：参数不能为负数

小结

本章节介绍了 Lua 中的调试工具和技术，包括 debug 库的使用、调试技巧、调试工具和最佳实践。掌握这些内容，对于编写和调试 Lua 程序非常重要。