sbt-onejar 技术文档

本文档旨在帮助用户了解和使用 sbt-onejar 插件，该插件用于将您的代码及其依赖项打包成一个单独的可执行 JAR 文件。

1. 安装指南

环境要求

• SBT 0.12.x 或 0.13.x 版本

如果您使用的是 SBT 0.7.x 版本，请参考 v0.2 分支。

安装步骤

1. 打开您的 project/plugins.sbt 文件。
2. 添加以下依赖项：

addSbtPlugin("org.scala-sbt.plugins" % "sbt-onejar" % "0.8")

2. 使用说明

配置设置

在您的 SBT 项目中包含以下设置：

import com.github.retronym.SbtOneJar._

oneJarSettings

您可以配置主类：

mainClass in oneJar := Some("com.acme.Woozler")

默认情况下，它将使用 mainClass in run in Compile。

示例配置

• 简单配置示例
• 完整配置示例

打包命令

运行以下命令来生成一个 JAR 文件：

run one-jar

生成的 JAR 文件可以通过以下命令运行：

java -jar <jarname>

3. 项目 API 使用文档

sbt-onejar 提供了以下主要设置和任务：

• oneJarSettings：包含所有 sbt-onejar 需要的设置。
• mainClass in oneJar：指定打包 JAR 文件的主类。
• oneJar：生成一个包含所有代码和依赖项的 JAR 文件的任务。

4. 项目安装方式

安装 sbt-onejar 无需额外步骤。只需在 project/plugins.sbt 文件中添加依赖项，然后重新启动 SBT 即可。

---

本文档基于 sbt-onejar 的 README 文件和 GitHub 项目 Wiki 编写。希望它能帮助您更好地理解和使用 sbt-onejar。