背景

时光华丽丽的来到了2023年，首先在这里祝大家新年快乐，希望大家在新的一年里都能心想事成，万事如意，最重要的是身体健康。过去的2022年里，大家一定都是收获满满。不论是技术的，家庭的，事业的，爱情的。生活就是这样，一直熙熙攘攘的往前走，除了收获沿途的风景，还能收获最终的果实。

在之前的博文里，陆续给大家介绍了JavaFX爱好者看过来，这款工具值得拥有和通过debug深度解析xJavaFxTool的源码，相信对于xJavaFxTool已经有了初步的认识和简单的了解，知道它的使用场景和一般的调试开发模式。但是，这款软件默认带的功能是有限的，如果想更大的发挥或者扩展软件的功能，各位开发者一定会进行定制，甚至是二次开发。因此，很有必要将讲讲如何基于xJavaFxTool来进行相应的软件开发，官方带了哪些扩展包，怎么去开发一个扩展功能，怎么集成自己的包到平台上来就显得非常迫切。本文围绕插件开发的模式，深度讲解如何定制开发插件，帮助大家掌握基于插件的开发方式，提高生产力和工作效率。

一、xcore核心库

1、xcore简介

xcore核心库是xJavaFxTool中的一个非常重要的基础库，里面封装了关于JavaFx和框架的基础运行包，如果仅仅是或者使用xJavaFxTool,可能您没必要关心，甚至不用去看它的核心代码。不过，如果想看它的具体工作机制，比如页面UI的工作线程和设置方式，很有必要对这个包进行编译。截止目前，xcore一共有6个Tag,从v0.0.1到v0.07,最新的版本是0.0.7,但需要注意的是，0.0.7tag是使用jdk17来进行开发的，如果您当前还是采用jdk1.8来进行开发，请选择0.0.6的版本。

我们通过TortoiseGit 将0.0.6版本的代码拉取下来，并在本地进行版本编译。

将xcore的代码导入到ide中，可以看到如下的工程，打开工程中的pom.xml文件，确定工程的版本是0.0.6的，如果不是，需要重新进行上一步，保证代码的版本一致性。

<modelVersion>4.0.0</modelVersion>

<groupId>com.xwintop</groupId>
<artifactId>xcore</artifactId>
<version>0.0.6</version>
<packaging>jar</packaging>

<name>xcore</name>
<description>xcore核心jar包</description>
<url>https://gitee.com/xwintop/xcore</url>

<properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

2、xcore本地编译

由于很多插件，都会依赖xcore，因此有必要对xcore进行本地编译，同时xcore在公开的maven仓库中是没有的。因此如果想进行插件的调试和开发，则必须将xcore安装到本地的私有maven仓库中，在前面的步骤中，只要保证配置没有报错，就可以对xcore进行编译安装，这里使用的命令是：mvn install

如果能看到以上的窗口说明xcore编译安装成功，在本地maven仓库中可以看到编译好的jar，如下图所示：

扫描二维码关注公众号，回复： 14807235 查看本文章

二、插件扩展简介

一个好的产品，离不开成熟的生态，可以兼容种类丰富的外部插件。同时，很方便的帮助开发者，基于一些公共的api来开发扩展基础应用，也是一项非常加分的能力。xJavaFxTool就是这么一款对开发者友好的开发框架。而xJavaFxTool的扩展能力，第一大语言优势就是，基于java开发语言，java语言的动态反射机制，有了反射机制，让动态调用得以实现，并在这里发光发热，项目的高效扩展集成得到了实现。

1、插件开发的一些坑

在作者的开源列表中，其实也开放了一些基础的应用插件，这些插件都是可以直接使用的，给大家提供了一种开发的案例。大家可以按照作者的例子进行改写，得到自己的插件。这里给大家列几个坑，在编译作者的开源插件中，有一些要注意的点，不至于大家在遇到问题时摸不着头脑。

这里举一个json转换插件的例子，x-JsonConvertTool。将代码从gitee上clone下来后，可以看到爆红的地方。这里的例子中xcore依赖是正常的，有一些工程，它引用的xcore的版本是老的版本，比如是0.0.3版本的，甚至是0.0.7版本的。所以，下载下来的包要主要xcore版本问题。

<dependencies>
   <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
       <version>4.12</version>
       <scope>test</scope>
   </dependency>
   <dependency>
       <groupId>com.xwintop</groupId>
       <artifactId>xcore</artifactId>
       <version>0.0.6</version>
       <scope>provided</scope>
   </dependency>

   <!--yaml解析工具-->
   <dependency>
       <groupId>org.yaml</groupId>
       <artifactId>snakeyaml</artifactId>
       <version>1.24</version>
 </dependency>

其次是IDE的jdk设置问题，有的时候IDE默认的jdk会被设置成默认的1.5，而我们的xcore编译的jdk是1.8，这样就容易导致运行有问题，所以需要将两者的JDK统一版本。

通常经过以上两步基本能解决80%的编译不通过的问题。如果还有其它的问题，可以在C站私信留言。

2、插件开发

为保证插件的代码也具有可读性，我们可以来看看开源的作者是怎么规划的。作者的包规划非常合理，符合mvc的开发设计理念。

包括入口函数、控制层、服务层、视图层。在资源目录包下面，有菜单配置xml、本地语言包配置文件。这些都是程序运行的基础，按照约定大于配置的设计理念，统一都按照这种方式进行归类整理，强烈建议各位小伙伴在自己开发的时候也同样按照这种目录进行组织自己的代码和实现。

3、菜单资源配置

作为独立的jar包，菜单的配置也是非常中，在xJavaFxTool插件开发中，菜单资源的配置采用一个xml配置文件来存储，在同一的展示前端，统一进行xml的解析和UI界面展示。

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<ToolFxmlLoaderConfiguration title="developTools" menuId="p-developTools" menuParentId="moreToolsMenu" isMenu="true" />
	<ToolFxmlLoaderConfiguration>
		<url>/com/xwintop/xJavaFxTool/fxmlView/developTools/JsonConvertTool.fxml</url>
		<resourceBundleName>locale.JsonConvertTool</resourceBundleName>
		<className></className>
		<title>Title</title>
		<isDefaultShow></isDefaultShow>
		<menuId></menuId>
		<menuParentId>p-developTools</menuParentId>
		<controllerType>Node</controllerType>
	</ToolFxmlLoaderConfiguration>
</root>

这个xml配置文件对应的每个节点含义见如下的实体类定义：

package com.xwintop.xJavaFxTool.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ToolFxmlLoaderConfiguration {
	private String url;//资源url
	private String resourceBundleName;//国际化资源文件
	private String className;//class名称
	private String title;//标题（配合国际化资源文件，无着默认显示原字符）
	private String iconPath;//图标路径
	private Boolean isDefaultShow = false;// 是否默认打开
	private String menuId;// 菜单id
	private String menuParentId;// 菜单父id
	private Boolean isMenu = false;//是否为菜单
	private String controllerType = "Node";// 内容类型
}

在程序启动的开始，会加载相应的配置，简单来看一下在程序的启动入口，是怎么被调用的吧？

@Override
    public void start(Stage primaryStage) throws Exception {
        FXMLLoader fXMLLoader = Main.getFXMLLoader();
        ResourceBundle resourceBundle = fXMLLoader.getResources();
        Parent root = fXMLLoader.load();
        primaryStage.setResizable(true);
        primaryStage.setTitle(resourceBundle.getString("Title"));
//        primaryStage.getIcons().add(new Image("/images/icon.jpg"));
        double[] screenSize = JavaFxSystemUtil.getScreenSizeByScale(0.74D, 0.8D);
        primaryStage.setScene(new Scene(root, screenSize[0], screenSize[1]));
        primaryStage.show();
        primaryStage.setOnCloseRequest(new EventHandler<WindowEvent>() {
            @Override
            public void handle(WindowEvent event) {
                System.exit(0);
            }
        });
    }

    public static FXMLLoader getFXMLLoader() {
        ResourceBundle resourceBundle = ResourceBundle.getBundle("locale.JsonConvertTool");
        URL url = Object.class.getResource("/com/xwintop/xJavaFxTool/fxmlView/developTools/JsonConvertTool.fxml");
        FXMLLoader fXMLLoader = new FXMLLoader(url, resourceBundle);
        return fXMLLoader;
    }

通过上述代码，经过运行之后可以看到以下的程序窗口：

三、总结

以上就是本文的主要内容，本文围绕xJavaFxTool插件开发的模式，深度讲解如何定制开发插件，帮助大家掌握基于xcore的插件开发方式，提高生产力和工作效率。心动不如行动，喜欢的朋友可以学习起来，给自己充电加油。

深入xJavaFxTool的插件开发模式

背景