Clojure 库中的动态变量

Question

TL;DR：以下是图书馆的好模式吗？

(def ^{:dynamic true} *var*)
(defn my-fn [{:keys [var]}]
  (do-smth (or var *var*)))

--

假设我想写一个情感分析库。

在get-sentiment fn 中接受可选情感标签但提供默认情感标签作为动态变量是否是好的设计？

(def ^:dynamic *sentiment-level-labels*
  ["Very Negative" "Negative" "Neutral" "Positive" "Very Positive"])

;;...

(defn get-sentiment-scores
  "Takes text and gives back a 0 to 4 sentiment score for each sentences."
  [text]
  ;;...)

(defn get-sentiment 
  "Gives back a sentiment map with sentences scores, 
   average score, rounded score and labeled score.
   Can accepts custom sentiment level labels under :labels opt."
  [text & {:keys [labels]}]
  (let [scores (get-sentiment-scores text)
        average-score (get-average scores)
        rounded-score (Math/round average-score)
        label (get (or labels *sentiment-level-labels*) rounded-score)]
    {:scores scores
     :average-score average-score
     :rounded-score rounded-score
     :label label}))

Clojure 库编码标准官方页面说：

如果你提供一个隐式传递参数的接口 动态绑定（例如 sql 中的 db），也提供相同的接口 但是显式传递的参数。

https://dev.clojure.org/display/community/Library+Coding+Standards

在我的示例中，我只提供了一个接口，但带有 opt 参数。

这样好吗？有没有更好的方法来处理这个问题？

谢谢！

Answer 1

动态变量是完整的还是有缺陷的。它们将您的 API 代码推向隐式环境耦合，并经常迫使您的调用代码添加许多 (binding ...) 子句，这首先违背了使用动态变量的简洁目的。如果控制从一个线程传递到另一个线程，它们还会导致棘手的边缘情况。

在您的情况下，我建议只需在 params 映射参数中传递标签：

(def default-sentiment-level-labels
  ["Very Negative" "Negative" "Neutral" "Positive" "Very Positive"])

(defn get-sentiment 
  "Gives back a sentiment map with sentences scores, 
   average score, rounded score and labeled score.
   Can accepts custom sentiment level labels under :labels opt."
  [text {:as params, :keys [labels] :or {labels default-sentiment-labels}}]
  ...))

请注意，map 的使用可能很有趣，因为 map 对中介是不透明的：您可以让算法的各种组件仅从 params 映射中读取与它们相关的键。