sbt-native-packager与JavaFX打包的现代解决方案

背景介绍

sbt-native-packager是一个流行的Scala构建工具插件，用于将Scala/Java应用程序打包成各种格式。其中JDKPackager插件原本设计用于创建JavaFX应用程序的本地安装包，但随着JavaFX的发展，特别是从Oracle JDK迁移到OpenJFX后，一些传统打包方式已不再适用。

问题分析

传统JDKPackager插件依赖于ant-javafx.jar文件，该文件在Oracle JDK 8中存在，但在现代JavaFX发行版中已被移除。这导致使用新版JavaFX(如22.0.0)时，sbt-native-packager的JDKPackager插件无法正常工作。

现代解决方案

1. 使用jpackage工具

现代Java(从Java 14开始)提供了jpackage工具，可以直接将Java应用程序打包为本地安装包。这是官方推荐的JavaFX应用程序打包方式。

实现步骤：

1. 首先使用sbt-assembly插件创建可执行的fat jar
2. 然后使用jpackage命令创建原生安装包

2. sbt-assembly配置要点

对于JavaFX应用程序，需要特别注意assembly的合并策略：

assembly / assemblyMergeStrategy := {
  case x if Assembly.isConfigFile(x) =>
    MergeStrategy.concat
  case PathList(ps @ _*) if Assembly.isReadme(ps.last) || Assembly.isLicenseFile(ps.last) =>
    MergeStrategy.rename
  case PathList("META-INF", xs @ _*) =>
    (xs map { _.toLowerCase }) match {
      case ("manifest.mf" :: Nil) | ("index.list" :: Nil) | ("dependencies" :: Nil) =>
        MergeStrategy.discard
      case ps @ (x :: xs) if ps.last.endsWith(".sf") || ps.last.endsWith(".dsa") =>
        MergeStrategy.discard
      case "plexus" :: xs =>
        MergeStrategy.discard
      case "services" :: xs =>
        MergeStrategy.filterDistinctLines
      case ("spring.schemas" :: Nil) | ("spring.handlers" :: Nil) =>
        MergeStrategy.filterDistinctLines
      case ("substrate" :: xs) => MergeStrategy.discard
      case _                   => MergeStrategy.deduplicate
    }
  case "module-info.class" => MergeStrategy.concat
  case _                   => MergeStrategy.deduplicate
}

关键点：

• 处理module-info.class文件使用MergeStrategy.concat
• 特殊处理substrate相关文件

3. jpackage使用示例

构建完成后，可以使用以下命令创建安装包：

jpackage --input target/scala-2.13 \
  --name MyApp \  
  --main-jar my-app-assembly-0.0.1.jar \
  --type dmg 

参数说明：

• --input: 指定包含jar文件的目录
• --name: 应用程序名称
• --main-jar: 主jar文件
• --type: 包类型(dmg/pkg/deb/rpm/msi等)

跨平台注意事项

不同平台需要不同的JavaFX依赖配置：

lazy val osName = (System.getProperty("os.name"), System.getProperty("os.arch")) match {
  case (n, _) if n.startsWith("Linux")       => "linux"
  case (n, "aarch64") if n.startsWith("Mac") => "mac-aarch64"
  case (n, _) if n.startsWith("Mac")         => "mac"
  case (n, _) if n.startsWith("Windows")     => "win"
  case _                                     => throw new Exception("Unknown platform!")
}

总结

虽然sbt-native-packager的JDKPackager插件在现代JavaFX环境下不再适用，但通过结合sbt-assembly和jpackage工具，我们可以实现更现代、更灵活的打包方案。这种方法不仅支持最新的JavaFX版本，还能生成各种平台的原生安装包，是JavaFX应用程序打包的推荐做法。