clj-kondo 检测未使用的惰性序列表达式

在Clojure开发中，我们经常会遇到惰性序列(lazy sequence)的使用场景。惰性序列是Clojure的一个强大特性，它允许我们处理大量数据而不必立即加载所有内容到内存中。然而，如果不小心处理，惰性序列也可能导致一些难以发现的bug。

问题背景

最近在clj-kondo项目中，开发者发现了一个关于惰性序列表达式未被使用的潜在问题。具体场景是在一个函数中创建了一个for循环表达式，但由于for返回的是惰性序列，而该序列既没有被返回也没有被强制求值，导致这段代码实际上不会执行。

问题代码示例

(defn map->Headers [headers]
  (let [headers-obj ^Headers (Headers.)]
    (for [[k v] headers]  ; 这个for表达式返回惰性序列但未被使用
      (->> (cond-> v
             (not (coll? v)) vector)
           (map str)
           (.add headers-obj (name k))))
    headers-obj))

在这段代码中，for表达式会生成一个惰性序列，但由于没有对这个序列进行任何操作(如doall、dorun或将其作为返回值)，序列中的元素永远不会被实际计算。这意味着.add操作永远不会执行，而开发者可能误以为这些操作会被执行。

clj-kondo的改进

clj-kondo作为Clojure的静态分析工具，能够检测出这种潜在问题。在最新版本中，它会对以下情况发出警告：

1. 创建了惰性序列但未使用其结果
2. 可能期望立即执行但实际被惰性求值的表达式
3. 可能产生副作用的惰性序列未被强制求值

这种检测对于避免隐蔽的bug特别有用，尤其是在涉及副作用的操作时(如上面的.add方法调用)。

开发者建议

为了避免这类问题，开发者可以：

1. 对于需要立即执行的副作用操作，使用doall或dorun来强制求值惰性序列
2. 明确区分纯函数(无副作用)和有副作用的代码
3. 在可能产生副作用的地方添加注释说明
4. 启用clj-kondo的惰性序列检测功能

修正后的代码应该如下：

(defn map->Headers [headers]
  (let [headers-obj ^Headers (Headers.)]
    (dorun  ; 强制求值序列
      (for [[k v] headers]
        (->> (cond-> v
               (not (coll? v)) vector)
             (map str)
             (.add headers-obj (name k)))))
    headers-obj))

总结

clj-kondo的这一改进帮助Clojure开发者更容易发现潜在的惰性序列问题，特别是那些可能导致副作用未执行的场景。作为最佳实践，开发者应该：

1. 了解Clojure的惰性求值特性
2. 对有副作用的代码保持警惕
3. 使用静态分析工具如clj-kondo来捕捉潜在问题
4. 在适当的时候强制求值惰性序列

通过结合工具辅助和良好的编码习惯，可以显著减少这类问题的发生。