跳到正文
Code Review
← 规则库/语言与脚本

评审检查清单

Clojure

语言与脚本36 个检查项7 个章节
**/*.{clj,cljs,cljc,edn}
宁缺毋滥(重精确轻召回):只报告可能导致错误行为、资源泄漏、安全漏洞或实质性性能问题的内容。不要报告由 cljfmt 和 clj-kondo 处理的格式或命名问题。在提出问题前,先确定该文件是 Clojure、ClojureScript,还是行为随 reader conditional 而异的 .cljc 文件,并针对每个分支所面向的平台分别评审。
01

惰性、序列与资源作用域

6 项
  • with-open 或事务体的返回值是未实现的惰性序列(如 line-seq、map 或 filter);资源会在消费者读取之前关闭,因此应在该作用域内用 doall、into 或某个归约调用强制实现
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在消费尾部的同时持有长序列或无界序列头部的引用,保留了每个已实现的元素
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在只需副作用的场合使用 doall;或 doseq/run!/dorun 被换成惰性 map,其副作用可能永不执行或执行两次
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对流式或无限序列使用 count、last、sort 或 reduce
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对开销太小不足以抵消协调成本、或有副作用的函数体使用 pmap;它会超前于消费者运行,使副作用在从未被消费的元素上触发
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 不要报告结果在其输入生命周期内被消费的普通惰性管道
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

02

状态、并发与动态绑定

5 项
  • 将有副作用或非幂等的函数传给 swap!、alter 或 commute;它们会在重试时重新执行,副作用随之重复
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 读写分离分散在 @a 与 reset! 之间,或两个 swap! 调用之间,而该更新必须对组合值保持原子性
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 需要协调的多标识更新本应使用 ref 却使用了 atom;或无协调的独立值即可满足却使用了 ref
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 在裸 Thread、Java executor 任务、回调或 binding 形式退出后才实现的惰性序列中读取 binding 值;与 future、send、pmap 及 JVM core.async 的 go/thread 不同,这些场合不会传递绑定,因此应用 bound-fn 捕获该帧或显式传值
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 可变 Java 集合或数组跨线程共享而无同步;以及在驻留字符串、装箱数字或其他共享常量上 locking
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

03

命名空间、关键字与数据契约

5 项
  • map 跨越 JSON、HTTP 或存储边界时关键字键与字符串键不一致,典型情况是一条路径应用了 :key-fn keyword 而另一条没有
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 带命名空间的关键字在序列化过程中被展平、丢弃或静默改名空间
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • spec 或 malli 校验只应用于契约的某个入口,却未应用于接受相同数据的兄弟路径
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 用真值判断空性,如对可能为空的集合写 (if coll ...);空集合为真,应改用 seq 或 empty? 判定。同理,对向量使用 contains? 检查的是索引而非值
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对必须在命名空间重载后存续的状态使用 def,而此处需要 defonce
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

04

宏与编译期代码

4 项
  • 展开引入的符号未使用 gensym 或 sym# 自动 gensym,捕获了调用点的绑定
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 参数表达式被拼入展开体超过一次,导致有副作用或开销大的参数被重复求值;应先在 let 中绑定
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 普通函数即可胜任却写成宏,毫无收益地牺牲了可组合性与一等公民用法
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 符号未限定地输出而非通过 syntax-quote 输出,从而在调用方的命名空间而非定义处的命名空间中解析
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

05

互操作、反射与性能

5 项
  • 热点路径上的互操作调用缺少类型提示;对照命名空间中的 (set! *warn-on-reflection* true) 检查
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 意图使用原始数值运算的紧凑循环中出现装箱算术
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 链式 map/filter/remove 构建中间序列,而周围代码已在使用配 into 或 transduce 的 transducer
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • concat 跨循环迭代累积,构建嵌套惰性序列并在实现时溢出栈
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • transient 逃逸出创建它的作用域、被多个线程同时操作,或未将每次调用的返回值传给下一次而是原地修改
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

06

ClojureScript 与 JavaScript 互操作

4 项
  • 在 :advanced 优化下对外部提供的 JavaScript 对象做属性访问却没有 extern 或 goog.object/get;重命名后得到的是 undefined 而非报错
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 用 aget 做属性访问而非数组索引,这在高级编译下不可靠
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对大型对象或在热点路径上使用 js->clj 或 clj->js 深度转换;或生产者与消费者之间对 :keywordize-keys 的使用不一致
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 对可能为 nil 或 js/undefined 的值使用 .-prop 或方法访问,会在运行时抛出 TypeError
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

07

EDN 数据、配置与不可信输入

7 项
  • 对非开发者手写的数据使用 read-string 而非 clojure.edn/read-string;前者会遵循 *read-eval*,而 #=(...) 即远程代码执行
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 给 edn/read-string 传入宽松的 :default 或自定义 :readers 而重新引入求值;或对用户输入调用它却没有外层 try
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 使用 -SNAPSHOT、RELEASE、LATEST 或版本区间的 Maven 依赖而非精确版本,导致构建不可复现
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 测试或开发目录被加进顶层 :paths 而非别名的 :extra-paths,使其进入生产 classpath
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 秘密、令牌或凭据提交在配置 .edn 文件中
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 不可信值被拼进 clojure.java.shell/sh 参数;用字符串拼接构造 SQL 而非参数化查询;路径使用未约束遍历范围
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

  • 安全令牌或标识符用 java.util.Random 或 rand 生成,而非 SecureRandom
    内置
    来源与改动说明

    来源

    本站调整:沿用原规则,提供中文说明并补充编号。

返回本页顶部 ↑继续浏览规则库

手动复制规则链接

浏览器未允许自动复制,请选中下方链接复制。