lua debug库的一些玩法

lua一直是游戏领域广泛使用的脚步语言，但从整个IT行业来说确实特别小众，所以和python比起来网络上使用lua的“奇技淫巧”特别少，本文简单介绍一些对debug的一些奇妙用法。

本文对debug的一些用法大部分是从mobdebug（https://github.com/pkulchenko/MobDebug）总结来，推荐大家看看mobdebug的实现源码，里面把coroutine用的特别奇妙，简化了很多实现思路。（里面用源代码方式内嵌了serpent，用来序列化以及反序列化lua数据，作者能写一行就绝对不写两行，特别难看懂）

• get/setfenv实现

过了lua5.2之后就没有这两个函数了，替代方式是_ENV，下面给出实现方式

（实在不愿意用csdn的代码片功能了）

if not setfenv then

    local function findenv(f)

        local index = 1

        repeat

            local name, value = debug.getupvalue(f, index)

            if name == "_ENV" then

                return index, value

            end

            index = index + 1

        until name == nil

        return nil

    end

    getfenv = function (f) return (select(2, findenv(f)) or _G) end

    setfenv = function (f, t)

        local index = findenv(f)

        if index then debug.setupvalue(f, index, t) end

        return f

    end

end

其实就是找到_ENV变量提取出来，或者设置回去，可以用来实现跟复杂的沙盒功能

• 实现沙盒

lua一个特别实用的功能就是他可以简单的嵌入到别的程序中，特别容易执行字符串代码片段（load*函数），这样也带来了安全性问题，如果可以将代码放在沙盒中执行，而不污染全局环境最好。下面给出一个简单的实现：

local function create_sandbox()

    return merge(_G, _ENV)

end

local function call_inbox(func, env)

    if not env then env = create_sandbox() end

    local old_env = getfenv(func)

    setfenv(func, env)

    pcall(func)

    setfenv(func, old_env)

end

有一个缺陷就是不能对输入参数做赋值（当然是可以通过getlocal 负值索引来做，不过就有点太hack了）

可以这么用：

local function t2()
    for k, v in pairs(_G) do
        print(k, v)
    end 
    print("===================in sandbox====================")
    i = start
    j = 4 
    k = i + j 
    print(("i:%s j:%s k:%s"):format(i, j, k)) 
end
env.call_inbox(t2, merge(_ENV, merge(_G, { start = 3 })))
print("=====================outside======================")
print(("i:%s j:%s k:%s"):format(i, j, k))

》》

===================in sandbox====================
i:3 j:4 k:7
=====================outside======================
i:nil j:nil k:nil

没有污染全局

• 单步调试修改局部变量

debug.sethook(debugfunc, "l")这个用来单步hook的用法就不多说了，每次单步的时候getfenv-》修改local 变量-》setfenv回去，就可以修改局部变量了

local function testee2()
    local upper = 1
    return upper
end
                                                                                                                                                                             
local function t1()
    if upper then
        upper = 10
    end
end
env.set_change_var_func(t1)
debug.sethook(env.trace_env, "l")
print(testee2())
debug.sethook()
print(upper)

》》

10

nil

里面主要是trace_env函数：

local function trace_env(event, line)                                                 
    if not M.change_var_func then return end                                          
    local level = 2                                                                   
    vars = capture_vars(level + 1)                                                    
    call_inbox(M.change_var_func, vars)                                               
    restore_vars(level + 1, vars)                                                                                
end

其中的capture_vars和restore_vars是get/setfenv的进阶版，实现可以参考mobdebug库的源码

• 总结

虽然专研奇技淫巧不是正途，但是lua社区的确太小，很多东西都要自己研究一番，甚至要自己修各种bug或者5.1到5.2的兼容问题（在我至今学习1个月lua的时间里，已经不下10次修改第三方的代码了），所以专研奇技淫巧，提高自己对于lua语言的使用和理解也是一种快速的学习方式。