clojure - 哪些变量会影响 Clojure 函数？

Question

如何以编程方式找出哪些变量可能影响 Clojure 中定义的函数的结果？

考虑 Clojure 函数的定义:

(def ^:dynamic *increment* 3)
(defn f [x]
  (+ x *increment*))

这是 x 的函数，也是 *increment* 的函数(也是 clojure.core/+^{( 1)}；但我不太关心这一点)。在为此函数编写测试时，我想确保控制所有相关输入，因此我执行以下操作:

(assert (= (binding [*increment* 3] (f 1)) 4))
(assert (= (binding [*increment* -1] (f 1)) 0))

(想象一下 *increment* 是一个有人可能会合理更改的配置值；我不希望在发生这种情况时需要更改此函数的测试。)

我的问题是:如何编写一个断言，使 (f 1) 的值可以依赖于 *increment* 但不依赖于任何其他 Var？因为我预计有一天有人会重构一些代码并导致该功能

(defn f [x]
  (+ x *increment* *additional-increment*))

并且忽略更新测试，即使 *additional-increment* 为零，我也希望测试失败。

这当然是一个简化的示例 - 在大型系统中，可能有很多动态变量，并且可以通过一长串函数调用来引用它们。即使 f 调用 g，而 g 又调用了引用 Var 的 h，该解决方案也需要正常工作。如果它没有声明 (with-out-str (prn "foo")) 依赖于 *out* 那就太好了，但这不太重要。如果被分析的代码调用 eval 或使用 Java 互操作，当然所有的赌注都会失败。

我可以想到三类解决方案:

1. 从编译器获取信息

   我想象编译器会扫描函数定义以获取必要的信息，因为如果我尝试引用一个不存在的 Var，它会抛出:

   user=> (defn g [x] (if true x (+ *foobar* x)))
   CompilerException java.lang.RuntimeException: Unable to resolve symbol: *foobar* in this context, compiling:(NO_SOURCE_PATH:24) 
   

   请注意，这发生在编译时，无论违规代码是否会被执行。因此编译器应该知道函数可能引用哪些变量，并且我希望能够访问该信息。

2. 解析源代码并遍历语法树，并记录引用 Var 的时间

   因为代码就是数据等等。我想这意味着调用 Macroexpand 并处理每个 Clojure 原语以及它们采用的每种语法。这看起来非常像一个编译阶段，如果能够调用编译器的某些部分，或者以某种方式将我自己的钩子(Hook)添加到编译器中，那就太好了。

3. 检测 Var 机制，执行测试并查看哪些 Var 被访问

   不像其他方法那么完整(如果在我的测试无法执行的代码分支中使用 Var 会怎么样？)但这就足够了。我想我需要重新定义 def 来生成类似 Var 的东西，但以某种方式记录其访问。

<小时/>

^{(1) 实际上，如果您重新绑定(bind) +，该特定函数不会改变；但在 Clojure 1.2 中，您可以通过设置 (defn f [x] (+ x 0 *increment*)) 来绕过该优化，然后您就可以享受 (binding [+ -] 的乐趣(f 3))。在 Clojure 1.3 中尝试重新绑定(bind) + 会引发错误。}

Answer 1

关于你的第一点，你可以考虑使用 analyze图书馆。有了它，您可以很容易地找出表达式中使用了哪些动态变量:

user> (def ^:dynamic *increment* 3)
user> (def src '(defn f [x]
                  (+ x *increment*)))
user> (def env {:ns {:name 'user} :context :eval})
user> (->> (analyze-one env src) 
           expr-seq 
           (filter (op= :var)) 
           (map :var) 
           (filter (comp :dynamic meta)) 
           set)
#{#'user/*increment*}