如何在2021年4月20日让JavaFX项目：IDE内运行正常， jar包导出后也能顺利运行的问题解决方案

0.前言

• 当一个JavaFX项目结束了，剩下的就是导出发布了。原本以为是一件很简单的事情，可是没那么容易，导出的jar包无法运行，报错无数。。。。。
• 网上有很多导出教程。。可是当你照搬运用的时候，还是一样报错无数。有一些细节方面的东西，包括lib文件夹和bin文件夹的相对位置都会导致报错。
• JDK版本不一样、导出方法不一样、项目结构不一样、项目main方法不一样都会导致导出的jar包无法运行。报错无数。
• 以下我按照简单到复杂逐一解决各种坑，尽量适用于各种JDK等。IDE以idea为例。

1.普通java项目的jar包的导出

• 普通java项目是指不包含JavaFX GUI的项目。
• 这个就比较简单了。也是基础操作。。。任何JDK版本都能实现。。。但是也是有几个小坑。
• 步骤如下：

1.1 选中java项目，选择 File -> Project Structure (快捷键：Ctrl+Alt+Shift+S)。

1.2 在弹出的窗口中左侧选中"Artifacts"，点击"+"选择jar，然后选择"from modules with dependencies"。

1.3 选择Main入口

1.4 回到IDEA的主菜单，选择“Build - Build Artifacts”下的“Build”或者“Rebuild”即可生成最终的可运行的jar包

1.5 坑1：导出的jar包无法双击运行

• 这个一般是注册表没修改正确。没有增加-jar 这个前缀。。。
• 重新安装一遍jdk就行了
• 或者修改注册表

HKEY_CLASSES_ROOT\jarfile\shell\open\command下
修改值为"C:\Program Files\Java\jdk-13.0.1\bin\javaw.exe" -jar "%1" %*

2.JDK10之前的版本（含JDK10）的JavaFX项目的导出

• 这个也比较简单，因为JDK10之前的版本（含JDK10）已经内置了JavaFX，所以直接参照第一点操作即可，导出的jar可以直接运行。
• 而且这个版本可以直接导出为exe文件。其他版本的jdk就不能导出为exe文件,会报错：Can't build artifact - fx:deploy is not available in this JDK
• 唯一的问题是jdk10是2018年发布的，不支持部分新语言特征。且不能使用JavaFX的新版本
• 据资料说有一个jpackage可以在jdk11版本后导出exe文件。。日后完善如何使用。

• 导出exe的操作步骤

  
  
  

  image.png
  
  
  

  image.png

3. jdk11及后续版本的JavaFX项目导出（方式1：不包含JavaFX SDK的small jar包）

• 这个就开始有很多坑了。。。
• 当在idea中配置JavaFX项目的时候，必须添加如下VM选项才能正常运行JavaFX项目（详细参看我之前的文章）

--module-path d:\Java\lib\openjfx-11.0.2_windows-x64_bin-sdk\javafx-sdk-11.0.2\lib\ --add-modules javafx.controls,javafx.fxml

• 按照方法1导出jar包后，直接运行会有如下错误提示 ：

错误：找不到或无法加载主类Address.Main
原因：java.lang.NoClassDefFoundError:javafx/application/Application

• 这个比较好解决，增加VM选项即可运行这个jar包.（命令行或bat文件或修改注册表）

java --module-path d:\Java\lib\javafx-sdk-16\lib\ --add-modules javafx.controls,javafx.fxml -jar address.jar

• 因为JavaFX和操作系统有很大关联，所以推荐用这个方法，导出的jar包不包含JavaFXSDK。导出的jar包比较小。这样，可以在其他平台运行。但是，也因为如此，JavaFX SDK文件夹必须完整，不能仅仅包含lib目录。比如在Windows系统下JavaFX SDK的lib目录，必须同时放有bin目录。如下图。否则会有如下报错。

Graphics Device initialization failed for : d3d,sw

4. jdk11及后续版本的JavaFX项目导出（方式2：包含JavaFX SDK的fat jar包）

• 也可以在jar包中包含JavaFX库，直接双击运行jar包即可。
• 导出的jar包体积较大。
• 只能在特定平台运行
• 步骤如下

4.1 新建一个启动类替代原本的Main作为主入口

public class AppMain {
    public static void main(String[] args){
        Main.main(args);
    }
}

4.2 添加JavaFX SDK库

• 这个比较简单。把JavaFX的lib的jar文件和项目导出的jar包放一起就可以了。（具体要看你的META_INF文件的Class-path的定义）
• 然后比较重要的来了。。idea不会自己打包JAVA SDK的其他文件（如bin文件）。将导致jar包运行后无法运行（参照第3点的报错）

• 网上的一个教程如下操作：Directory Content -> path-to/JavaFX SDK/bin on Windows

  
  
  

  image.png
  
  
  

  image.png

• 然后。。你会发现jar运行后GUI显示不正常，有黑边且控件无法正常显示。主要原因是lib和bin文件的相对位置不正确。lib包的上级必须有bin包。如下

  
  
  

  image.png
• 如下是我的MANIFEST.MF文件

Manifest-Version: 1.0
Main-Class: DocMaker.AppMain
Class-Path: lib/Spire.Doc.jar lib/javax.activation-1.2.0.jar lib/jaxb-impl-2.3.0.jar
  lib/jaxb-api-2.3.0.jar lib/jaxb-core-2.3.0.jar lib/luaj-jme-3.0.1.jar lib/luaj-jse-3.0
 .1.jar lib/luaj-sources-3.0.1.jar JavaFX_SDK/lib/src.zip JavaFX_SDK/lib/javafx-swt.jar JavaFX_SDK/lib/javafx.web.jar JavaFX_SDK/lib/jav
 afx.base.jar JavaFX_SDK/lib/javafx.fxml.jar JavaFX_SDK/lib/javafx.media.jar JavaFX_SDK/lib/javafx.swing.jar JavaFX_SDK/lib/javafx.c
 ontrols.jar JavaFX_SDK/lib/javafx.graphics.jar lib/controlsfx-11.0.3.jar JavaFX_SDK/lib/javafx-graphics-1
 1.0.2.jar JavaFX_SDK/lib/javafx-graphics-11.0.2-win.jar JavaFX_SDK/lib/javafx-base-11.0.2.jar JavaFX_SDK/lib/javafx-
 base-11.0.2-win.jar JavaFX_SDK/lib/javafx-media-11.0.2.jar JavaFX_SDK/lib/javafx-media-11.0.2-win.jar
  JavaFX_SDK/lib/javafx-controls-11.0.2.jar JavaFX_SDK/lib/javafx-controls-11.0.2-win.jar

• 如下是output layout页面的设置（Directory Content -> path-to/JavaFX SDK/bin on Windows）

  
  
  

  output layout页面的设置

5.终极BOSS

• 你以为导出的jar可以运行就OK了？错了。。还有一个终极大BOSS，这个问题没解决，你就会发现导出的jar包。。一些能运行，一些不能运行。。偏偏在idea都能正常运行。。
• 主要原因都涉及到外部文件调用和css文件调用上。
• （挖坑，后面补充）

6.继续挖坑Jlink

7.继续挖坑之Jpackage

参考文章

1.Maven Shade JavaFX runtime components are missing
2.How to open JavaFX.jar file with JDK 11
3.