背景
我看到了有关错误消息的 reddit 讨论,其中一位用户的关于信号与噪声比率的评论引起了我的共鸣,并促使我思考REPL如何向用户展示堆栈跟踪。
上下文
我查阅了该领域的各种发展,包括:
- Stuart Holloway的观点 认为堆栈跟踪总是正确的长度
- clj-stacktrace 库
- pretty 库
- clojure存档页面,其中包含关于堆栈跟踪的设计迭代,包括此片段
我认为现有的库要么试图隐藏太多(pretty),要么主要关注于展示/格式化而忽略了实际内容(clj-stacktrace)。我通常同意Stuart的观点,即堆栈跟踪的长度是正确的,因为每个堆栈元素都是真实的信息,是对异常发生时执行的方法堆栈的不模糊描述。
范围
本次讨论关于在REPL中展示给程序员的堆栈跟踪,考虑Throwable->map
和 clojure.core/print-throwable
,而不是重新封装所有抛出的异常。
问题
堆栈跟踪的目的是展示关于已执行方法的有用信息,这些信息为异常提供上下文。我认为使这些信息有用的一个方面是能够查看/导航到导致异常的代码。在Clojure代码中定义的函数的情况下,因为没有方法/封装的类可以查看/导航到,因为这些函数的字节码是从函数定义动态生成的。此外,看似单一函数调用的堆栈跟踪通常含有多个元素,其中一些指向了函数定义的行,这也不太有用。
示例
给定一个文件repro.clj
(我包含行号)
1 (defn foo []
2 (/ 1 0))
3
4 (defn bar []
5 (foo))
6
7 (bar)
在REPL中加载此文件并显示错误将显示以下堆栈跟踪
clj
Clojure 1.10.1
user=> (load-file "repro.clj")
Syntax error (ArithmeticException) compiling at (C:\Users\Vlaaad\Projects\vlaaad.github.io\repro.clj:7:1).
Divide by zero
user=> *e
#error {
:cause "Divide by zero"
:via
[{:type clojure.lang.Compiler$CompilerException
:message "Syntax error compiling at (C:\\Users\\Vlaaad\\Projects\\vlaaad.github.io\\repro.clj:7:1)."
:data #:clojure.error{:phase :compile-syntax-check, :line 7, :column 1, :source "C:\\Users\\Vlaaad\\Projects\\vlaaad.github.io\\repro.clj"}
:at [clojure.lang.Compiler load "Compiler.java" 7648]}
{:type java.lang.ArithmeticException
:message "Divide by zero"
:at [clojure.lang.Numbers divide "Numbers.java" 188]}]
:trace
[[clojure.lang.Numbers divide "Numbers.java" 188]
[clojure.lang.Numbers divide "Numbers.java" 3901]
[user$foo invokeStatic "repro.clj" 2]
[user$foo invoke "repro.clj" 1]
[user$bar invokeStatic "repro.clj" 5]
[user$bar invoke "repro.clj" 4]
[user$eval140 invokeStatic "repro.clj" 7]
[user$eval140 invoke "repro.clj" 7]
[clojure.lang.Compiler eval "Compiler.java" 7177]
[clojure.lang.Compiler load "Compiler.java" 7636]
[clojure.lang.Compiler loadFile "Compiler.java" 7574]
[clojure.lang.RT$3 invoke "RT.java" 327]
[user$eval1 invokeStatic "NO_SOURCE_FILE" 1]
[user$eval1 invoke "NO_SOURCE_FILE" 1]
[clojure.lang.Compiler eval "Compiler.java" 7177]
[clojure.lang.Compiler eval "Compiler.java" 7132]
[clojure.core$eval invokeStatic "core.clj" 3214]
[clojure.core$eval invoke "core.clj" 3210]
[clojure.main$repl$read_eval_print__9086$fn__9089 invoke "main.clj" 437]
[clojure.main$repl$read_eval_print__9086 invoke "main.clj" 437]
[clojure.main$repl$fn__9095 invoke "main.clj" 458]
[clojure.main$repl invokeStatic "main.clj" 458]
[clojure.main$repl_opt invokeStatic "main.clj" 522]
[clojure.main$main invokeStatic "main.clj" 667]
[clojure.main$main doInvoke "main.clj" 616]
[clojure.lang.RestFn invoke "RestFn.java" 397]
[clojure.lang.AFn applyToHelper "AFn.java" 152]
[clojure.lang.RestFn applyTo "RestFn.java" 132]
[clojure.lang.Var applyTo "Var.java" 705]
[clojure.main main "main.java" 40]]}
让我们专注于属于repro.clj
的堆栈跟踪元素
[clojure.lang.Numbers divide "Numbers.java" 188]
[clojure.lang.Numbers divide "Numbers.java" 3901]
[user$foo invokeStatic "repro.clj" 2]
[user$foo invoke "repro.clj" 1]
[user$bar invokeStatic "repro.clj" 5]
[user$bar invoke "repro.clj" 4]
[user$eval140 invokeStatic "repro.clj" 7]
[user$eval140 invoke "repro.clj" 7]
代码中每个Clojure函数调用都对应两个栈元素:invoke
和invokeStatic
。对于类user$foo
和user$bar
的invoke
方法,它们指向第1和第4行。如果您看看repro.clj
,您会注意到这些是函数foo
和bar
定义所在的行——这些信息并不有用,一般来说,Java代码的堆栈跟踪不会指向方法定义所在的行,而只有指向方法体内调用更高层栈上方法的行。虽然可以使用interop直接调用.invoke
,因为这在IFn中有定义,但invokeStatic
是编译器生成的方法,可以认为是一个实现细节。
可能的解决方案?
不采取任何行动
Stuart可能是对的——如果我在调试与字节码相关的问题,我当然会对这些细节感兴趣。此外,Clojure的某些未来版本可能会以不同的方式生成函数字节码,从而导致更少的、更易读的堆栈跟踪。
合并堆栈元素
这种方法将同一函数的堆栈元素合并,只保留可见的公共invoke
方法,并报告实际调用下一方法所在行的行号。这是一种相当微小的过滤,使得堆栈跟踪对异常复制 looks like like
[clojure.lang.Numbers divide "Numbers.java" 188]
[clojure.lang.Numbers divide "Numbers.java" 3901]
[user$foo invoke "repro.clj" 2]
[user$bar invoke "repro.clj" 5]
[user$eval140 invoke "repro.clj" 7]
[clojure.lang.Compiler eval "Compiler.java" 7177]
[clojure.lang.Compiler load "Compiler.java" 7636]
[clojure.lang.Compiler loadFile "Compiler.java" 7574]
[clojure.lang.RT$3 invoke "RT.java" 327]
[user$eval1 invoke "NO_SOURCE_FILE" 1]
[clojure.lang.Compiler eval "Compiler.java" 7177]
[clojure.lang.Compiler eval "Compiler.java" 7132]
[clojure.core$eval invoke "core.clj" 3214]
[clojure.main$repl$read_eval_print__9086$fn__9089 invoke "main.clj" 437]
[clojure.main$repl$fn__9095 invoke "main.clj" 458]
[clojure.main$repl invoke "main.clj" 458]
[clojure.main$repl_opt invoke "main.clj" 522]
[clojure.main$main invoke "main.clj" 667]
[clojure.lang.RestFn invoke "RestFn.java" 397]
[clojure.lang.AFn applyToHelper "AFn.java" 152]
[clojure.lang.RestFn applyTo "RestFn.java" 132]
[clojure.lang.Var applyTo "Var.java" 705]
[clojure.main main "main.java" 40]
我认为这已经很好地减少了信号与噪声比例,如果您调试与字节码相关的问题,您仍然可以通过在异常对象上使用.getStackTrace
来获取完整的堆栈跟踪。
使Clojure堆栈元素像代码一样
Clojure哲学的一部分是偏好函数而不是方法,也许堆栈元素指向Clojure函数时应该看起来像函数而不是方法?大多数时候代码中没有.invoke
interop。我更喜欢处理user/foo
而不是user$foo invoke
,因为这在我看得见的代码中。有人可能会争辩说,像clojure.lang.AFn applyToHelper
和clojure.lang.RestFn invoke
这样的堆栈元素也是不必要的,因为它们是实现细节,使得Clojure函数可以使用可变参数进行调用(已经有一些过滤了这些细节!)。在这个方向上有许多未知的事物,我没有尝试回答,因为我不确定是否值得追求,但下面是堆栈跟踪可能看起来是什么样的示意图
[clojure.lang.Numbers.divide "Numbers.java" 188]
[clojure.lang.Numbers.divide "Numbers.java" 3901]
[user/foo "repro.clj" 2]
[user/bar "repro.clj" 5]
[user/eval140 "repro.clj" 7]
[clojure.lang.Compiler.eval "Compiler.java" 7177]
[clojure.lang.Compiler.load "Compiler.java" 7636]
[clojure.lang.Compiler.loadFile "Compiler.java" 7574]
[clojure.lang.RT$3.invoke "RT.java" 327]
[user/eval1 "NO_SOURCE_FILE" 1]
[clojure.lang.Compiler.eval "Compiler.java" 7177]
[clojure.lang.Compiler.eval "Compiler.java" 7132]
[clojure.core/eval "core.clj" 3214]
[clojure.main/repl/read-eval-print--9086/fn--9089 "main.clj" 437]
[clojure.main/repl/fn--9095 "main.clj" 458]
[clojure.main/repl "main.clj" 458]
[clojure.main/repl-opt "main.clj" 522]
[clojure.main/main "main.clj" 667]
[clojure.main.main "main.java" 40]
一些开放性问题
将Clojure函数调用表示为单个符号而不是类+方法对意味着将Java方法调用表示为单个符号,它们应该如何体现?clojure.lang.Compiler/eval
与clojure.lang.Compiler.eval
还是其他什么形式?
如何展示deftypes/reifies的方法调用?这两个都是Clojure和方法的...
Var/AFn/RestFn堆栈元素真的无关紧要吗?
其他方案
可能还有其他选择...
您觉得呢?