问题描述
我正在 Clojure 中编写一个名为 OneCLI 的 CLI 框架。这个框架的主要核心部分是一个名为 go!
的函数,它“为你”解析命令行、环境变量和配置文件,并根据这些输入中提供的内容运行几个不同的用户提供的函数之一。
通常,从用户调用 Clojure 程序的 go!
函数调用 -main
。例如,我在另一个名为 zic 的“uberjar”样式应用程序中使用我自己的库。函数 go!
调用 System/exit
作为其运行的一部分,向它传递来自用户提供函数结果的退出代码。这在“生产中”效果很好,但这也意味着我无法从 REPL 运行 zic.cli/-main
函数,因为每当我这样做时,它都会调用 System/exit
并且 REPL 退出。
在您询问之前,在树莓派上开发时从 REPL 运行它可以避免运行 lein uberjar
/1 分 30 秒运行 clj -X:depstar uberjar :jar ...
所需的昂贵的 45 秒。
我的问题是:是否有一些 var 或值可以作为 Clojure 标准库的一部分进行检查,以告诉我的 OneCLI 代码它是从 REPL 运行还是从 JAR 运行? >
这样的变量将使我能够在 OneCLI 中检测到我们正在从 REPL 运行,从而避免调用 System/exit
。
解决方法
与其尝试让一个函数神奇地检测您正在运行的环境,不如让两个行为不同的函数变得非常简单。
- 将共享行为提取到不属于
-main
的函数。称之为run
或其他。 - 让
-main
调用那个函数,然后调用System/exit
- 如果您希望使用来自复制的程序,请调用
run
而不是-main
。它将正常结束,不会调用System/exit
。
我不知道如何检测您是否在 REPL 上运行。我快速浏览了 Clojure's launching code (clojure.main),但与通过 clojure -m
运行的某些内容相比,我没有看到任何可以检测您是否处于 REPL 中的钩子。
如果您正在使用 AOT(就像您在 zic
中一样),那么您可以检查是否有任何“REPL”变量(*1
、*2
、*3
,和 *e
) 是绑定的。
;; returns true in a REPL and `clojure -m`,and
;; returns false in an AOT jar file run with java -jar
(bound? #'*1)
这解决了您提出的问题,但我不喜欢这种猜测程序员意图的“神奇”机制。它可能适用于您的用例(鉴于我认为 AOT 可以节省启动时间,而且 CLI 工具可能希望快速启动),但我所从事的项目都没有使用 AOT。
在 clojure -m
情况下解决您的问题的另一种选择是要求开发人员明确选择退出“完成时退出”行为。一种方法是使用属性。
(defn maybe-exit [exit-code]
(cond
(= (System/getProperty "onecli.oncompletion") "remain") (System/exit exit-code)
(= exit-code 0) nil
:else (throw (ex-info "Command completed unsuccessfully" {:exit-code exit-code}))))
使用此代码,在开发环境中可以添加
:jvm-opts ["-Donecli.oncompletion=remain"]
到您的 deps.edn
或 project.clj
文件,但在“生产中”运行时将其保留。这样做的好处是更加明确,但代价是开发者必须更加明确。
每个 Java JAR 文件都必须有文件 META-INF/MANIFEST.MF
添加。如果它不存在,则不能在(普通)JAR 文件中运行。虽然您可以通过在类路径上放置一个虚假文件(例如在 ./resources
中)来欺骗这个检测器,但它是检测正常 JAR 文件的可靠方法。
问题:
Dependency JAR 文件有时很草率,会用自己的 META-INF/MANIFEST.MF
文件污染类路径,因此任何随机 META-INF/MANIFEST.MF
的存在都不足以在存在“噪音”文件的情况下确定答案.因此,您需要检查您自己的特定 META-INF/MANIFEST.MF
文件是否存在。如果您知道 ArtifactId
和 GroupId
的 Maven 值,这很容易做到。
在 Leiningen 项目中,project.clj
的第一行看起来像
(defproject demo-grp/demo-art "0.1.0-SNAPSHOT"
对于 demo-grp
的组 ID 和 demo-art
的工件 ID。如果您的文件如下所示:
(defproject demo "0.1.0-SNAPSHOT"
那么组 ID 和工件 ID 都是 demo
。您的特定 MANIFEST.MF 看起来像
> cat META-INF/MANIFEST.MF
Manifest-Version: 1.0
Created-By: Leiningen 2.9.1
Built-By: alan
Build-Jdk: 15
Leiningen-Project-ArtifactId: demo-art
Leiningen-Project-GroupId: demo-grp
Leiningen-Project-Version: 0.1.0-SNAPSHOT
Main-Class: demo.core
使用 to ID 字符串设置一个函数来检测您的特定项目 MANIFEST.MF 的存在:
(ns demo.core
(:require [clojure.java.io :as io])
(:gen-class))
(def ArtifactId "demo-art")
(def GroupId "demo-grp")
(defn jar-file? []
(let [re-ArtifactId (re-pattern (str ".*ArtifactId.*" ArtifactId))
re-GroupId (re-pattern (str ".*GroupId.*" GroupId))
manifest (slurp (io/resource "META-INF/MANIFEST.MF"))
f1 (re-find re-ArtifactId manifest)
f2 (re-find re-GroupId manifest)
found? (boolean (and f1 f2))]
found?))
(defn -main []
(println "main - enter")
(println "Detected JAR file: " (jar-file?))
)
您现在可以测试代码:
~/expr/demo > lein clean ; lein run
main - enter
Detected JAR file: false
~/expr/demo > lein clean ; lein uberjar
Compiling demo.core
Created /home/alan/expr/demo/target/uberjar/demo-art-0.1.0-SNAPSHOT.jar
Created /home/alan/expr/demo/target/uberjar/demo-art-0.1.0-SNAPSHOT-standalone.jar
~/expr/demo > java -jar /home/alan/expr/demo/target/uberjar/demo-art-0.1.0-SNAPSHOT-standalone.jar
main - enter
Detected JAR file: true
“噪音”JAR 文件示例:如果我们执行 lein clean; lein run
,并在我们的主程序中添加一行
(println (slurp (io/resource "META-INF/MANIFEST.MF")))
我们出去:
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Built-By: jenkins
Created-By: Apache Maven 3.2.5
Build-Jdk: 1.8.0_111
我不知道这是从哪里进入 CLASSPATH。
P.S.用于 Leiningen JAR 文件
当使用 lein
构建 JAR 文件时,它总是在以下位置放置 project.clj
文件的副本:
META-INF/leiningen/demo-grp/demo-art/project.clj
所以你也可以使用这个文件的存在/不存在作为检测器。
更新
好的,看起来 MANIFEST.MF 文件高度依赖于您的构建工具。见
- https://docs.oracle.com/javase/tutorial/deployment/jar/defman.html
- https://www.baeldung.com/java-jar-manifest
因此,您的选择似乎是:
- 对于
lein
,您可以使用上述技术。 - 您可以使用另一个答案中
*1
的 REPL 技巧。 - 您始终可以让您的构建工具在清单中包含一个自定义键值对,然后检测它。
更新 #2
另一种可能更简单的答案是使用 lein-environ
插件和 environ
库(您需要两者)来检测环境(假设您使用 lein
来创建您的REPL)。您的 project.clj
应如下所示:
:dependencies [
[clojure.java-time "0.3.2"]
[environ "1.2.0"]
[org.clojure/clojure "1.10.2-alpha1"]
[prismatic/schema "1.1.12"]
[tupelo "21.01.05"]
]
:plugins [[com.jakemccrary/lein-test-refresh "0.24.1"]
[lein-ancient "0.6.15"]
[lein-codox "0.10.7"]
[lein-environ "1.2.0"]
]
并且您需要一个 profiles.clj
:
{:dev {:env {:env-mode "dev"}}
:test {:env {:env-mode "test"}}
:prod {:env {:env-mode "prod"}}}
和命名空间 demo.config
像:
(ns demo.config
(:require
[environ.core :as environ]
))
(def ^:dynamic *env-mode* (environ/env :env-mode))
(println " *env-mode* => " *env-mode*)
然后你会得到如下结果:
*env-mode* => dev ; for `lein run`
*env-mode* => test ; for `lein test`
*env-mode* => nil ; from `java -jar ...`
您需要输入:
lein with-profile :prod run
生产
*env-mode* => prod
,
这是一个有趣的问题,因为将 JVM 关闭放入库中通常是可怕的,但另一方面,“真正的应用程序”涉及许多非常适合分享的样板……例如隐藏 jar 的飞溅 gif在正确的时间,或者(重新)打开 Windows 终端(如果应用需要 stdio)。
您的 uberjar 将包含 clojure.main
,因此在您的 uberjar (java -cp my-whole-app.jar clojure.main
) 中运行 REPL 很有可能(并且很有用)。因此,“检测”类路径上的线索可能无济于事。
相反,在您的 jar 清单声明为其 -main
的命名空间中的 Main-Class
中管理 JVM 关闭工作。也就是说:如果您以 java -jar my-whole-app.jar
的身份运行它,那么它应该正确关闭一切。
但我并不总是希望 -main
关闭一切,你说。那么你需要两个 -main
。在不同的命名空间中创建第二个 -main
。让 jar 的 Main-Class -main
除了 (1) 委托给第二个 main 和 (2) 最后关闭 JVM 之外什么都不做。当您在 REPL 中时,调用第二个 -main
,它不会破坏 JVM。您可以将每个 -main
的大部分分解为一个库。如果你使用“完整框架”,你甚至可以让框架拥有超强的进程和主类。