28

clojure.spec指南中的一个例子是一个简单的选项解析规范：

(require '[clojure.spec :as s])

(s/def ::config
  (s/* (s/cat :prop string?
              :val (s/alt :s string? :b boolean?))))

(s/conform ::config ["-server" "foo" "-verbose" true "-user" "joe"])
;;=> [{:prop "-server", :val [:s "foo"]}
;;    {:prop "-verbose", :val [:b true]}
;;    {:prop "-user", :val [:s "joe"]}]

稍后，在验证部分，定义了一个函数，该函数在内部conform使用此规范作为其输入：

(defn- set-config [prop val]
  (println "set" prop val))

(defn configure [input]
  (let [parsed (s/conform ::config input)]
    (if (= parsed ::s/invalid)
      (throw (ex-info "Invalid input" (s/explain-data ::config input)))
      (doseq [{prop :prop [_ val] :val} parsed]
        (set-config (subs prop 1) val)))))

(configure ["-server" "foo" "-verbose" true "-user" "joe"])
;; set server foo
;; set verbose true
;; set user joe
;;=> nil

由于该指南旨在易于从 REPL 中遵循，因此所有这些代码都在同一个命名空间中进行评估。不过，在这个答案中，@levand 建议将规范放在单独的命名空间中：

我通常将规范放在他们自己的名称空间中，以及他们所描述的名称空间中。

这会破坏::config上面的用法，但可以解决这个问题：

规范键名最好位于代码的命名空间中，而不是规范的命名空间。通过在关键字上使用命名空间别名仍然很容易做到这一点：

(ns my.app.foo.specs
  (:require [my.app.foo :as f]))

(s/def ::f/name string?)

他继续解释说，规范和实现可以放在同一个命名空间中，但这并不理想：

虽然我当然可以将它们放在同一个文件中的规范代码旁边，但这会损害 IMO 的可读性。

但是，我无法看到它如何与destructuring一起使用。作为一个例子，我把上面的代码翻译成多个命名空间放在了一个小的Boot项目中。

boot.properties：

BOOT_CLOJURE_VERSION=1.9.0-alpha7

src/example/core.clj：

(ns example.core
  (:require [clojure.spec :as s]))

(defn- set-config [prop val]
  (println "set" prop val))

(defn configure [input]
  (let [parsed (s/conform ::config input)]
    (if (= parsed ::s/invalid)
      (throw (ex-info "Invalid input" (s/explain-data ::config input)))
      (doseq [{prop :prop [_ val] :val} parsed]
        (set-config (subs prop 1) val)))))

src/example/spec.clj：

(ns example.spec
  (:require [clojure.spec :as s]
            [example.core :as core]))

(s/def ::core/config
  (s/* (s/cat :prop string?
              :val (s/alt :s string? :b boolean?))))

build.boot：

(set-env! :source-paths #{"src"})

(require '[example.core :as core])

(deftask run []
  (with-pass-thru _
    (core/configure ["-server" "foo" "-verbose" true "-user" "joe"])))

但是，当然，当我实际运行它时，我得到一个错误：

$ boot run
clojure.lang.ExceptionInfo: Unable to resolve spec: :example.core/config

(require 'example.spec)我可以通过添加to来解决这个问题build.boot，但这很丑陋且容易出错，并且只会随着我的规范命名空间数量的增加而变得更多。由于几个原因，我不能require从实现命名空间中指定规范命名空间。这是一个使用fdef.

boot.properties：

BOOT_CLOJURE_VERSION=1.9.0-alpha7

src/example/spec.clj：

(ns example.spec
  (:require [clojure.spec :as s]))

(alias 'core 'example.core)

(s/fdef core/divisible?
  :args (s/cat :x integer? :y (s/and integer? (complement zero?)))
  :ret boolean?)

(s/fdef core/prime?
  :args (s/cat :x integer?)
  :ret boolean?)

(s/fdef core/factor
  :args (s/cat :x (s/and integer? pos?))
  :ret (s/map-of (s/and integer? core/prime?) (s/and integer? pos?))
  :fn #(== (-> % :args :x) (apply * (for [[a b] (:ret %)] (Math/pow a b)))))

src/example/core.clj：

(ns example.core
  (:require [example.spec]))

(defn divisible? [x y]
  (zero? (rem x y)))

(defn prime? [x]
  (and (< 1 x)
       (not-any? (partial divisible? x)
                 (range 2 (inc (Math/floor (Math/sqrt x)))))))

(defn factor [x]
  (loop [x x y 2 factors {}]
    (let [add #(update factors % (fnil inc 0))]
      (cond
        (< x 2) factors
        (< x (* y y)) (add x)
        (divisible? x y) (recur (/ x y) y (add y))
        :else (recur x (inc y) factors)))))

build.boot：

(set-env!
 :source-paths #{"src"}
 :dependencies '[[org.clojure/test.check "0.9.0" :scope "test"]])

(require '[clojure.spec.test :as stest]
         '[example.core :as core])

(deftask run []
  (with-pass-thru _
    (prn (stest/run-all-tests))))

第一个问题是最明显的：

$ boot run
clojure.lang.ExceptionInfo: No such var: core/prime?
    data: {:file "example/spec.clj", :line 16}
java.lang.RuntimeException: No such var: core/prime?

在我的规范中factor，我想使用我的prime?谓词来验证返回的因子。这个factor规范很酷的一点是，假设prime?是正确的，它既完整地记录了factor函数，又消除了我为该函数编写任何其他测试的需要。但是，如果您认为这太酷了，您可以将其替换为pos?或其他东西。

不过，不出所料，当您再次尝试时，您仍然会收到一个错误boot run，这一次抱怨缺少or or or （无论哪个碰巧先尝试）的:args规范。这是因为，无论您是否使用名称空间，都不会使用该别名，除非您为其指定的符号命名为 var that already exists。如果 var 不存在，则符号不会被扩展。（为了更有趣，删除from看看会发生什么。）#'example.core/divisible?#'example.core/prime?#'example.core/factoraliasfdef:as corebuild.boot

如果要保留该别名，则需要删除(:require [example.spec])fromexample.core并添加(require 'example.spec)to build.boot。当然，这require需要在for之后example.core，否则它将不起作用。到那时，为什么不直接把它require放进example.spec去呢？

所有这些问题都可以通过将规范与实现放在同一个文件中来解决。那么，我真的应该将规范放在与实现不同的命名空间中吗？如果是这样，我上面详述的问题如何解决？

4

1 回答 1

13

这个问题展示了应用程序中使用的规范和用于测试应用程序的规范之间的重要区别。

应用程序中用于符合或验证输入的规范（如此:example.core/config处）是应用程序代码的一部分。它们可能位于使用它们的同一文件中，也可能位于单独的文件中。在后一种情况下，应用程序代码必须:require符合规范，就像任何其他代码一样。

用作测试的规范在它们指定的代码之后加载。这些是您fdef的 s 和生成器。您可以将它们放在与代码不同的命名空间中——甚至放在一个单独的目录中，而不是与您的应用程序打包在一起——它们将:require成为代码。

您可能拥有两种规范都使用的一些谓词或实用程序函数。这些将放在一个单独的名称空间中。

于 2017-06-09T19:56:08.937 回答