克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

maven-jfx-plugin

一般情况下,第三方jar并不提供模块下信息,导致使用官方打包插件会带来诸多问题,特编写次此插件,来解决非模块化打包的问题,由于没有使用模块化,打包体积会较大

插件介绍

此项目为javafx-非模块打包插件,模块化打包请使用官方插件javafx-maven-plugin,官方插件的方式自行搜索

使用说明

jpackage是jdk14提供的用于打包自包含Java应用程序的工具。使用方法基本是对[官方说明文档](https: //docs.oracle.com/en/java/javase/21/docs/specs/man/jpackage.html)的翻译,部分属性未包含

用例

引入依赖

<build>
    <plugins>
        <plugin>
            <groupId>io.gitee.podigua</groupId>
            <artifactId>maven-jfx-plugin</artifactId>
            <version>0.0.2</version>
            <configuration>
                <mainClass>com.podigua.example.Launch</mainClass>
            </configuration>
        </plugin>
    </plugins>
</build>

打包

执行 mvn jfx:package

参数说明

通用选项

imagePath: image 路径

模块化打包时使用此参数

type: 类型

要创建的包的类型 有效值为: {"app-image", "exe", "msi", "rpm", "deb", "pkg", "dmg"} 如果未指定此选项,将创建特定于平台的默认类型。

appVersion: 版本

应用程序和/或包的版本(一般使用三段式版本比如1.0.2),默认值: ${project.version}

copyright: 版权

应用程序的版权

description: 描述

应用程序的描述

icon: 图标路径

应用程序包的图标路径(绝对路径或相对于${project.basedir})

name: 名称

应用程序和/或包的名称,默认值: ${project.name}

vendor: 供应商

应用程序的供应商

verbose:

启用详细输出 默认值: false

mainClass: 类名

要执行的应用程序主类的限定名称

options: vm java-options(数组)

传递给Java运行时的选项,例如

<options>
    <arg>-Xms100m</arg>
    <arg>-Xmx500m</arg>
</options>

arguments: 参数数组

传递给启动器的主类的命令行参数,例如

<arguments>
    <arg>Lucy</arg>
    <arg>18</arg>
    <arg>girl</arg>
</arguments>

Windows

winConsole

为应用程序创建控制台启动器,应指定需要控制台交互的应用程序,默认值: false

winDirChooser

添加对话框,以便用户选择安装产品的目录。默认值: false

winHelpUrl: url

用户可以获取更多信息或技术支持的URL

winMenu

请求为此应用程序添加开始菜单快捷方式默认值: false

winMenuGroup: menu-group-name

将此应用程序放置在的开始菜单组

winPerUserInstall

将此应用程序放置在的开始菜单组。默认值: false

winShortcut

请求为此应用程序创建桌面快捷方式。默认值: false

winShortcutPrompt

添加对话框,以便用户选择是否由安装程序创建快捷方式。默认值: false

winUpdateUrl

可用应用程序更新信息的URL

winUpgradeUuid: id

与此软件包升级相关联的UUID

Mac

macPackageIdentifier: 标识符

唯一标识macOS应用程序的标识符,默认为主类名。只能使用字母数字(A-Z,a-z,0-9),连字符(-)和句点(.)字符。

macPackageName: 名称

在菜单栏中显示的应用程序名称,这可以与应用程序名称不同。此名称必须少于16个字符,并适合在菜单栏和应用程序信息窗口中显示。默认为应用程序名称

macPackageSigningPrefix: 前缀

在签署应用程序包时,此值将添加到所有需要签名但没有现有包标识符的组件之前。

macSign

请求对包或预定义应用程序映像进行签名。

macSigningKeychain: 钥匙链名称

用于搜索签名标识的钥匙链的名称,如果未指定,将使用标准钥匙链。

macSigningKeyUserName: 名称

Apple签名标识中的团队或用户名部分

macAppStore

指示 jpackage 输出适用于Mac App Store。默认值: false

macEntitlements: 路径

包含在签署包中的可执行文件和库时使用的授权的文件路径

macAppCategory: 类别

用于构造应用程序plist中的LSApplicationCategoryType的字符串,默认值为"utilities"。

Linux

linuxPackageName:

Linux软件包的名称,默认为应用程序名称

linuxDebMaintainer: 邮件地址

.deb包的维护者

linuxMenuGroup: 菜单组名称

将此应用程序放置在的菜单组

linuxShortcut

为应用程序创建快捷方式,默认值: false

用于创建应用程序包的选项

aboutUrl: url

应用程序主页的URL

installDir: 路径

应用程序安装目录的绝对路径(在macOS或Linux上),或安装目录的相对子路径,如“Program Files”或“AppData”(在Windows上)

resourceDir:资源路径

用于覆盖jpackage资源的路径,根据平台不通,读取:${project.basedir/javafx},下的mac,windows,linux文件夹,不需要配置,文件夹存在即可

资源目录

通过向此目录添加替换资源,可以覆盖jpackage的图标、模板文件和其他资源。jpackage将在资源目录中按特定名称查找文件。读取:${project.basedir/javafx},下的mac**,windows,linux文件夹**

仅在Linux上运行时考虑的资源目录文件:

{launcher-name}.png

应用程序启动器图标,默认资源为JavaApp.png

{launcher-name}.desktop

与xdg-desktop-menu命令一起使用的桌面文件,用于已注册文件关联的应用程序启动器和/或具有图标的应用程序启动器 ,默认资源为template.desktop

仅在构建Linux DEB/RPM安装程序时考虑的资源目录文件:

-{launcher-name}.service

注册为后台服务类型应用程序的应用程序启动器的systemd单元文件,默认资源为unit-template.service

仅在构建Linux RPM安装程序时考虑的资源目录文件:

.spec

RPM规范文件,默认资源为template.spec

仅在构建Linux DEB安装程序时考虑的资源目录文件:

control

控制文件,默认资源为template.control

copyright

版权文件,默认资源为template.copyright

preinstall

预安装shell脚本,默认资源为template.preinstall

prerm

预删除shell脚本,默认资源为template.prerm

postinstall

后安装shell脚本,默认资源为template.postinstall

postrm

后删除shell脚本,默认资源为template.postrm

仅在Windows上运行时考虑的资源目录文件:

{launcher-name}.ico

应用程序启动器图标,默认资源为JavaApp.ico

{launcher-name}.properties

应用程序启动器可执行文件的属性文件,默认资源为WinLauncher.template

仅在构建Windows MSI/EXE安装程序时考虑的资源目录文件:

-post-image.wsf

用于构建应用程序镜像后运行的Windows脚本文件(WSF)

main.wxs

主WiX项目文件,默认资源为main.wxs

overrides.wxi

覆盖WiX项目文件,默认资源为overrides.wxi

service-installer.exe

服务安装程序可执行文件,如果某些应用程序启动器注册为后台服务类型应用程序,则会考虑

{launcher-name}-service-install.wxi

服务安装程序WiX项目文件,如果某些应用程序启动器注册为后台服务类型应用程序,则会考虑,默认资源为service-install.wxi

{launcher-name}-service-config.wxi

服务安装程序WiX项目文件,如果某些应用程序启动器注册为后台服务类型应用程序,则会考虑,默认资源为service-config.wxi

InstallDirNotEmptyDlg.wxs

用于安装程序UI对话框检查安装目录不存在或为空的WiX项目文件,默认资源为InstallDirNotEmptyDlg.wxs

ShortcutPromptDlg.wxs

用于安装程序UI对话框配置快捷方式的WiX项目文件,默认资源为ShortcutPromptDlg.wxs

bundle.wxf

应用程序镜像组件层次结构的WiX项目文件

ui.wxf

用于安装程序UI的WiX项目文件,仅在构建Windows EXE安装程序时考虑的资源目录文件:WinInstaller.properties,安装程序可执行文件的属性文件,默认资源为WinInstaller.template

-post-msi.wsf

用于构建EXE安装程序的嵌入式MSI安装程序后运行的Windows脚本文件(WSF)

仅在macOS上运行时考虑的资源目录文件

{launcher-name}.icns

应用程序启动器图标,默认资源为JavaApp.icns

Info.plist

应用程序属性列表文件,默认资源为Info-lite.plist.template

Runtime-Info.plist

Java运行时属性列表文件,默认资源为Runtime-Info.plist.template

.entitlements

签名授权属性列表文件,默认资源为sandbox.plist

仅在构建macOS PKG/DMG安装程序时考虑的资源目录文件:

-post-image.sh

用于构建应用程序镜像后运行的Shell脚本

仅在构建macOS PKG安装程序时考虑的资源目录文件:

uninstaller

卸载程序Shell脚本,如果某些应用程序启动器注册为后台服务类型应用程序,则会考虑,默认资源为uninstall.command.template

preinstall

预安装Shell脚本,默认资源为preinstall.template

postinstall

后安装Shell脚本,默认资源为postinstall.template

services-preinstall

服务包的预安装Shell脚本,如果某些应用程序启动器注册为后台服务类型应用程序,则会考虑,默认资源为services-preinstall.template

services-postinstall

服务包的后安装Shell脚本,如果某些应用程序启动器注册为后台服务类型应用程序,则会考虑,默认资源为services-postinstall.template

-background.png

背景图片,默认资源为background_pkg.png

-background-darkAqua.png

深色背景图片,默认资源为background_pkg.png

product-def.plist

包属性列表文件,默认资源为product-def.plist

-{launcher-name}.plist

用于将应用程序启动器注册为后台服务类型应用程序的launchd属性列表文件,默认资源为launchd.plist.template

仅在构建macOS DMG安装程序时考虑的资源目录文件:

-dmg-setup.scpt

设置AppleScript脚本,默认资源为DMGsetup.scpt

-license.plist

许可属性列表文件,默认资源为lic_template.plist

-background.tiff

背景图片,默认资源为background_dmg.tiff

-volume.icns

卷图标,默认资源为JavaApp.icns

贡献与支持

只在mac上进行了测试

您可以通过下面的方法来贡献和支持该项目:

  1. 在 Gitee 上为项目加注星标
  2. 给予反馈
  3. 提交PR
  4. 贡献您的想法建议
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

javafx-非模块化,模块化打包 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化