1 Star 7 Fork 2

Notar开发组 / lab-JavaFx

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

LabmemFX

描述

框架设计思路根据大佬的 Biubiuyuyu/JavaFX-Plus 的一些实用的方法搭建,因为大佬咕咕就自我实现适合自己的框架

目的简化javafx开发

环境 依赖

[IDEA]
[jdk 17]
[openjfx 19]
[编程语言:Kotlin]
[UI库引用:materialfx、bootstrap]
[控件库引用:controlsfx]
[工具依赖: Hutool、bytebuddy等]
[核心包:fx-core]

已实现的功能

项目入口

FXAppLauncher是你的程序Application所在的类

companion object {
    @JvmStatic
    fun main(args: Array<String>) {
        FXApplication.run(FXAppLauncher::class.java, args)
    }
}

FXAppLauncher 需继承JAVAFX:Application并注解@LabFXApplication 扫描当前类包路径 或 @LabFXApplication(["com.labmem.modular"]) 去扫描包注册controller

@LabFXApplication
class FXAppLauncher : Application() {
    override fun start(primaryStage: Stage) {
        FXApplication.start(primaryStage)
        FXApplication.close {
            //正常关闭程序后执行
            Console.log("程序关闭啦!")
        }
    }
}

FXApplication是框架启动入口start开始启动主窗口 close方法结束程序也可以传结束前回调

注解

@LabFXApplication 框架扫描入口
@FXController 定义窗口Controller
@FXLoadController 定义加载框窗口,需@FXController
@FXAspect 指定Controller的切面(只对非FXML controller有效),需@FXController
@FXRedirect 方法重定向Controller(只对非FXML controller有效),需@FXController

使用示例

Controller 控制器

@FXController(
    fxmlPath = "fxml/main.fxml",    //fxml的resources路径(可空,为空时创建非fxml Controller),**[fxml必须以Pane为根控件,不用填写controller]**
    title = "hello world",          //stage title(可空)
    icon = "icon.jpg",              //icon的resources路径(可空)
    main = true,                    //是否为主程序启动的窗口(默认 false)
    tray = false,                   //当前窗口是否需要系统托盘(默认 false)
    myTray = MyTray::class,         //当需要系统托盘时可自定义托盘(可空,默认托盘)
    loadContrName = "AppLoadingController",     //跳转当前窗口显示前的加载窗口类名(可空)
    only = false,   //唯一窗口,只显示一个并只创建一次
)
class MainController : BaseController() {       //以@FXController注册controller时一定继承BaseController
    override fun initialize() { //可重写fxml加载初始化模块
    }
    override fun initStage() {   //可重写【controller初始化执行,用于设计stage】
        //初始化后会注入
        root:Pane=根控件
        stage:Stage=当前窗口
        request:FXRedirectParam?=重定向过来的参数
        loading:Loading=lab载入框工具
        alert:AlertUtil=lab弹窗工具

        //甚至可以操作重定向之前的控制器,去修改它的控件的骚操作
        val testStage=request.redirectController as TestSatge
        testStage.textFie1?.let{
            it.text="你好"
        }
    }
    override fun onShow() { //展示前执行,用于业务逻辑(ps:使用的渲染主线程,若异步逻辑请使用协程避免阻塞)
    }   
}

FXLoadController 加载窗

@FXController(title = "App Loading..", icon = "icon.jpg")
@FXLoadController   //加载窗所需的注解,其余和普通controller一样
class AppLoadingController : BaseController() {
    override fun loadingInit() {    //可重写加载方法,因为是加载框肯定需要加载东西,就写这里。该方法完成后关闭加载窗跳转原目标窗口
        request:FXRedirectParam?=也能获取到重定向到窗口的参数,以便处理
        Thread.sleep(2000)
    }
}

Tray 自定义托盘

class MyTray : SystemTrayInterFace() {  //自定义托盘需要实现SystemTrayInterFace接口
    override fun listen(controller: BaseController) { //并重写listen方法以便去监听操作这个窗口,甚至不用托盘,去实现其他操作窗口的工具
    }
}

@FXAspect Aop(只对非FXML controller有效 新版本已支持FXML的动态代理)

class MainAspect : BaseFXAspect() {     //切面需继承BaseFXAspect
    //就能重写以下方法
    override fun before(target: Any, method: Method, args: Array<out Any>?): Boolean
    override fun after(target: Any, method: Method, args: Array<out Any>?, returnVal: Any?): Boolean
    open fun afterException(target: Any, method: Method, args: Array<out Any>?, e: Throwable?): Boolean
}

@FXController()                     //一定是非FXML controller
@FXAspect(MainAspect::class)        //就能注册上面的切面了
class TestStage :BaseController(){}

重定向

【FXML controller】 可以使用父类的redirect()方法

val test = FXRedirectParam(TestStage::class)    //创建FXRedirectParam对象,重定向控制器可传String或KClass
test.addParams("msg", "hello")                  //FXRedirectParam是<Stirng,Any>类型
test.addParams("back", {                        //甚至可以传个回调函数
    AlertUtil().successAlert()
})
test.ownerRedirect = true                       //跳转的窗口是否为当前的子窗口(包括在当前窗口内),默认为true
input1?.let { test.addParams("input", it) }     //也可以传fxml控件,到目标控制器可操作性
redirect(test)

另一种选择@FXRedirect

@FXML
@FXRedirect                 //可直接在任意方法使用注解
fun open(event: ActionEvent):FXRedirectParam{//返回类型为FXRedirectParam
    return FXRedirectParam("TestStage")
}

工具(xyz.labmem.core.util)

1、ResourceFile

基于hutool获取resources文件和当前运行的路径(包括打包后jar包路径)

2、WindowPointerTool

获取stage窗口在windows下的句柄,用于c++嵌入渲染

3、xyz.labmem.core.util.gui

弹窗、加载、托盘等工具

使用graalvm编译器打包(将实现)

桌面端

首先初始化x64编译环境

call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"

Run the application on JVM/HotSpot:

mvn gluonfx:run

Run the application and explore all scenarios to generate config files for the native image with:

mvn gluonfx:runagent

Build a native image using:

mvn gluonfx:build

Run the native image app:

mvn gluonfx:nativerun

安卓

Build a native image for Android using:

mvn gluonfx:build -Pandroid

Package the native image as an 'apk' file:

mvn gluonfx:package -Pandroid

Install it on a connected android device:

mvn gluonfx:install -Pandroid

Run the installed app on a connected android device:

mvn gluonfx:nativerun -Pandroid

iOS

Build a native image for iOS using:

mvn gluonfx:build -Pios

Install and run the native image on a connected iOS device:

mvn gluonfx:nativerun -Pios

Create an IPA file (for submission to TestFlight or App Store):

mvn gluonfx:package -Pios

PS:当高版本JDK反射FXML为null指针报错,需在VM options加上 --add-opens java.base/java.lang.reflect=ALL-UNNAMED

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 桌面开发框架 展开 收起
Kotlin 等 3 种语言
Apache-2.0
取消

发行版 (4)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Kotlin
1
https://gitee.com/notar_development_group/lab-java-fx.git
git@gitee.com:notar_development_group/lab-java-fx.git
notar_development_group
lab-java-fx
lab-JavaFx
master

搜索帮助