如何记录Ruby程序中调用的每个方法?

aurhwmvo  于 2022-12-26  发布在  Ruby
关注(0)|答案(3)|浏览(119)

我继承了一大堆Ruby代码,坦率地说,对于像我这样的凡人来说,这些代码几乎是不可能理解的。实际上,这些代码是Rspec单元测试代码,但其结构"非常不寻常"。
我希望能够运行代码,并将以下信息记录在某个位置:

  • 每个被调用的方法,包括定义该方法的类名,以及定义被调用方法的文件名(是的,我们在多个不同的文件中定义了相同的类/方法,很难知道哪个被调用)
  • (可选)传递给调用的每个方法的参数

有了它,我就可以开始尝试重构它了,没有它,由于代码库的大小(20k+单元测试用例),要理顺它将是一项非常困难的任务。
我无法对正在运行的代码进行大规模的编辑,因为即使你使用了苛刻的语言,它也会崩溃(例如频繁地)。相反,我需要能够在现有状态下插入代码,或者对现有状态进行最小的更改。
有没有一种方法可以在不对代码库进行大规模修改的情况下记录这种级别的细节呢?我已经看过Ruby分析器,看看它是否有帮助,它可能有帮助;我很好奇是否有更好的方法(特别是记录包含被调用方法的文件名)。
先谢了

4nkexdtk

4nkexdtk1#

这绝对是可能的--事实上,甚至有一个方法可以实现它!只要在你的代码中你想开始记录事情之前的某个地方添加这个方法:

set_trace_func proc { |event, file, line, id, binding, classname|
  printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
}

您想要的秘密酱料来自**Kernel#set_trace_func**,如上所述:

  • 设置跟踪函数(处理)=〉处理
  • 设置跟踪函数(无)=〉无

proc建立为跟踪的处理程序,如果参数为nil,则禁用跟踪。proc最多使用六个参数:事件名称、文件名、行号、对象ID、绑定和类名。每当事件发生时,都会调用proc。事件包括:c-call(调用C语言例程),c-return(从C语言例程返回),call(调用Ruby方法),class(开始类或模块定义),end(完成类或模块定义),line(在新行上执行代码)、raise(引发异常)和return(从Ruby方法返回)。在proc的上下文中禁用跟踪。
下面是一个简单的例子:

class Test
  def test
    a = 1
    b = 2
  end
end

set_trace_func proc { |event, file, line, id, binding, classname|
  printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
}

t = Test.new
t.test

(Note:不要在irb中尝试此操作,除非您想要一个巨大的文本滚动屏幕。)结果输出为:

line test.rb:11               false
  c-call test.rb:11        new    Class
  c-call test.rb:11 initialize   Object
c-return test.rb:11 initialize   Object
c-return test.rb:11        new    Class
    line test.rb:12               false
    call test.rb:2        test     Test
    line test.rb:3        test     Test
    line test.rb:4        test     Test
  return test.rb:4        test     Test

您可以随意使用上面的格式化字符串,以获得您想要记录的结果(例如,听起来您只对call事件感兴趣)。

zynd9foi

zynd9foi2#

最近,set_trace_func被弃用:
注意:此方法已过时,请改用TracePoint。
我们可以使用TracePoint,它支持set_trace_func

trace = TracePoint.new(:call) do |tp|
  puts "#{tp.defined_class}##{tp.method_id} got called (#{tp.path}:#{tp.lineno})"
end

trace.enable
# do stuff here
trace.disable

这实际上比set_trace_func更强大,因为您可以在方便的时候启用和禁用它。:line, :class, :end, :call, :return, :c_call, :c_return, :raise, :b_call, :b_return, :thread_begin, :thread_end
下面是一个完整的例子:

class MyClass
  def initialize
  end
  def y
    z
  end
  def z
   1 + 1
  end
end

trace = TracePoint.new(:call) do |tp|
  puts "#{tp.defined_class}##{tp.method_id} got called (#{tp.path}:#{tp.lineno})"
end

trace.enable # note
MyClass.new.y
trace.disable
  # MyClass#initialize got called (./trace.rb:4)
  # MyClass#y got called (./trace.rb:7)
  # MyClass#z got called (./trace.rb:10)
aor9mmx1

aor9mmx13#

我想包括事件发生的时间以及在每个函数中花费的时间

start = DateTime.now.strftime('%Q').to_i / 1000.0
set_trace_func proc { |event, file, line, id, binding, classname|
  now_ms = DateTime.now.strftime('%Q').to_i / 1000.0
  duration = '%.3f' % (now_ms - start)
  start = DateTime.now.strftime('%Q').to_i / 1000.0
  printf "%s %s %8s %s:%-2d %10s %8s\n", DateTime.now.strftime("%S.%L"), duration, event, file, line, id, classname
}

AdminUser.create(password: "password", password_confirmation: "password", email: email)

set_trace_func nil

我试图调试为什么创建用户和登录ActiveAdmin要花这么长时间。

05.761 0.000 c-return /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:51       to_s   String
05.761 0.000   c-call /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:51 __bc_crypt BCrypt::Engine
09.736 63.975 c-return /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:51 __bc_crypt BCrypt::Engine
09.736 0.000   return /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/engine.rb:59 hash_secret BCrypt::Engine
09.736 0.000   c-call /Users/nperry/.rvm/gems/ruby-2.1.2@rxair/gems/bcrypt-3.1.7/lib/bcrypt/password.rb:46        new    Class

从那我知道Ruby花了不止一分钟在__bc_crypt上。

相关问题