如何创建一个在某个函数被调用时调用另一个函数的函数?

我一直在尝试创建一个函数,它会在某个函数被调用时运行一个事件/函数。 我希望使用方式如下:

local a = nil

a = hookfunction(print, function() -- 当print()被调用时……
    warn("print(...) called.")
    return nil
end)

我知道有一个debug.sethook()函数,但我不太知道如何使用它。

点赞
用户7396148
用户7396148

最简单的方法是包装原始函数:

do
  local _print = print

  function print(...)
    _print("print(...) 被调用。")
    _print(...)
  end
end

print("你好,世界")

输出:

print(...) 被调用。

你好,世界

我们在这里所做的是,将原始的 print 存储在本地变量 _print 中,它是新创建的全局打印函数的上值,我们在存储原始函数之后创建它。

2020-04-02 18:22:55
用户1442917
用户1442917

有两种方法可以实现这一点,但是每种方法都有一些需要解决的 pitfalls。

一种方法是使用 monkeypatching。这会将 print 函数更改为执行所需操作的不同函数,然后调用原始函数。

类似于这样:

local origprint = print;
(_G or _ENV).print = function(...)
  io.write("print is called\n")
  return origprint(...)
end
print("foo", 1)

此选项的主要陷阱是,如果某个组件在 monkeypatched 之前保存了 print 的值,则随后使用它不会受到您的 patch 的影响。

另一种选择是使用调试钩子:

debug.sethook(function()
    local info = debug.getinfo(2)
    if info.name then
      io.write(info.name, " is called\n")
    end
  end, "c")
function foo()
  print("do something")
end
foo()

这应该打印:

foo is called
print is called
do something

此方法的主要陷阱在于,它不能保证输出函数名称与您预期的相同,因为 values 可能与它们的不同名称/容器相关联。

例如,这将打印 a is called

local a = print
a("do something")

而这将打印 ? is called

local a = {print}
a[1]("do something")
2020-04-02 18:29:19
用户4984564
用户4984564

问题缺少一个非常重要的细节:为什么?

如果您想用于调试,那么 debug.sethook 可能是更适合的选项。正如 Paul Kulchenko 指出的那样,debug.getinfo 可能会返回错误的函数名称,但它也返回函数对象本身,您可以使用它查找表中的规范名称。这也可以作为要监视哪些函数的过滤器:

local watch = {}
debug.sethook(function()
   local info = debug.getinfo(2)
   if watch[info.func] then
      print(watch[info.func], "was called")
      -- 这不应该会递归,因为
      -- 钩子应该在钩子回调函数中被禁用
   end
end, "c")

-- 在代码中的某个其他位置
watch[print] = "print"

print("foobar")

但是,如果您想将其用于除调试外的任何内容,则应尽可能避免使用 debug.sethook,因为它可能会干扰依赖调试钩子的其他库(例如 luacov);在这种情况下,最好替换函数:

do local p = print
   function print(...)
      p("Print was called!")
      return p(...)
   end
end

但请记住,您不应更改任何函数的行为,否则可能会在其他地方破坏代码。这也包括运行时;如果您使非常高效的函数执行大量繁重的工作,这可能会以意想不到的方式完全破坏性能。

还要记住,某些库会本地化它们希望使用的全局函数。虽然这通常是非常糟糕的做法,但似乎有一个神话,认为这会使 Lua 代码变得更快(这个神话有理由存在,但在大多数情况下并不正确);这意味着您的替换必须在加载这些库之前发生。

顺便提一下,出于同样的原因,通常不应本地化全局变量,除非您知道需要对原始函数进行持续引用,就像上面示例中的 p 变量一样。

2020-04-03 07:25:20