使用PF4J实现插件化系统-入门

简介:

在进行业务平台型系统开发时,常常遇到接口大致相同,但是不同的业务的场景,其实现却有所不同。在分工方面,不同的业务场景,可能是不同的开发人员。这时就可以通过插件化的方式,针对不同的业务场景,实现不同的插件,来满足业务的需求。

PF4J是一个Java轻量级的插件框架,使用PF4J可以轻松的将一个Java应用转成一个插件化的应用。其拥有最小的依赖关系和很强的扩展性。

<dependency>
    <groupId>ro.fortsoft.pf4j</groupId>
    <artifactId>pf4j</artifactId>
    <version>${pf4j.version}</version>
</dependency>

目前pf4j的最新是1.3.0。以下示例我们都以这个版本为例。

工程结构

pf4j-plugin-demo

插件化的工程结构如上:

api:定义可扩展的接口,其他插件实现这里所定义的接口。在实际的工程中,定义可扩展点的接口是比较难的地方
app:运行程序,这里是程序的入口。插件直接拷贝至指定的目录,app就可以找到指定的插件
plugins:插件模块,这里实现api中所定义的接口。在实际的工程中,这部分可以是单独的代码库,其依赖api以及项目的一些基础模块
定义可扩展接口

我们先来定义api的接口

public interface Greeting extends ExtensionPoint {

    String message(String name);
}

这里我们定义了一个Greeting接口。

以上我们继承了ExtensionPoint接口,用于标记这个接口是提供一个扩展点。PF4J任何在接口和抽象类都可以继承它。

实现插件

接下来我们实现插件

public class ChinesePlugin extends Plugin {

    private static final Logger logger= LoggerFactory.getLogger(ChinesePlugin.class);

    public ChinesePlugin(PluginWrapper wrapper) {
        super(wrapper);
    }

    @Override
    public void start() throws PluginException {
        System.out.println("Chinese plugin start.");
        super.start();
    }

    @Override
    public void stop() throws PluginException {
        logger.info("Chinese plugin stop.");
        super.stop();
    }
}```
在实现插件时,首先我们继承Plugin类,实现其start和stop接口。在PluginManager加载完成之后,调用startPlugins就会执行这里的start方法。

@Extension
public class ChineseGreeting implements Greeting {

@Override
public String message(String name) {
    return "你好," + name;
}

}`
以上就实现了中文版的插件。

同样英文版插件如下:

public class EnglishPlugin extends Plugin {

    public EnglishPlugin(PluginWrapper wrapper) {
        super(wrapper);
    }

    @Override
    public void start() throws PluginException {
        System.out.println("English plugin start.");
        super.start();
    }

    @Override
    public void stop() throws PluginException {
        System.out.println("English plugin start.");
        super.stop();
    }
}
@Extension
public class EnglishGreeting implements Greeting {

    @Override
    public String message(String name) {
        return "Hi," + name;
    }
}```
插件打包

在插件编写完成之后,需要打包和进行版本管理。PF4j支持zip包的方式,在zip包中有classes和lib两个目录,classes中为插件的class文件,lib为插件依赖的第三方包。在maven中,我们可以使用maven-assembly插件,打出zip包。具体配置可下载demo代码查看。

插件加载、启动
public static void main(String[] args) {
    //使用默认的插件管理器
    PluginManager pluginManager = new DefaultPluginManager(new File("/app/plugins").toPath());

    //加载插件
    pluginManager.loadPlugins();

    //启动插件
    pluginManager.startPlugins();

    //获取所有的Greeting的扩展实现
    List<Greeting> greetings = pluginManager.getExtensions(Greeting.class);
    for (Greeting greeting : greetings) {
        System.out.println( greeting.message("yywang"));
    }
}```

在以上代码中,我们使用了DefaultPluginManager插件管理器,在实际使用中,也可以自己是插件管理器。在这里我们读取/app/plugins目录下的所有的插件。

第二步,加载插件。这里会把所有的插件的Class加载到PluginClassLoader中,为避免冲突,每个插件都有自己的PluginClassLoader。

第三步,启动插件。这里很简单就是把所有的插件调用start方法,启动插件,并且把插件的状态设置成STARTED

第四步,运行插件。这里我们通过获取所有Greeting的实现运行插件。pluginManager还有一些其他接口,满足我们不同的业务场景。

运行

对以上插件进行打包,并把插件拷贝至指定的目录,运行以上main方法,结果如下

>>> 你好,yywang
>>> Hi,yywang```
以上就是一个关于PF4J的入门,后面我们还会深入了解,如何定义插件管理、插件版本管理、插件生命周期、开发模式和线上模式等等。

目录
相关文章
|
8月前
|
JSON 机器人 Linux
推荐一款嵌入式Linux开源框架与封装-cpp-tbox
推荐一款嵌入式Linux开源框架与封装-cpp-tbox
156 3
|
3月前
|
存储 C++ UED
【实战指南】4步实现C++插件化编程,轻松实现功能定制与扩展
本文介绍了如何通过四步实现C++插件化编程,实现功能定制与扩展。主要内容包括引言、概述、需求分析、设计方案、详细设计、验证和总结。通过动态加载功能模块,实现软件的高度灵活性和可扩展性,支持快速定制和市场变化响应。具体步骤涉及配置文件构建、模块编译、动态库入口实现和主程序加载。验证部分展示了模块加载成功的日志和配置信息。总结中强调了插件化编程的优势及其在多个方面的应用。
449 67
|
5月前
|
监控 安全 网络安全
SOC:简介、功能及其优点
【8月更文挑战第19天】
298 0
|
7月前
|
Linux 芯片
Linux 驱动开发基础知识——查询方式的按键驱动程序_编写框架(十三)
Linux 驱动开发基础知识——查询方式的按键驱动程序_编写框架(十三)
81 2
|
8月前
|
开发工具 C语言 git
【嵌入式开源库】MultiButton的使用,简单易用的事件驱动型按键驱动模块
【嵌入式开源库】MultiButton的使用,简单易用的事件驱动型按键驱动模块
218 0
|
JSON 算法 物联网
第1期 | MultiButton,一个小巧简单易用的事件驱动型按键驱动模块
第1期 | MultiButton,一个小巧简单易用的事件驱动型按键驱动模块
330 0
|
移动开发 调度 C语言
移植一个实时OS很难?那就手把手教你如何快速移植一个RT-Thread Nano吧!
移植一个实时OS很难?那就手把手教你如何快速移植一个RT-Thread Nano吧!
173 0
|
监控 API C++
驱动开发:文件微过滤驱动入门
MiniFilter 微过滤驱动是相对于`SFilter`传统过滤驱动而言的,传统文件过滤驱动相对来说较为复杂,且接口不清晰并不符合快速开发的需求,为了解决复杂的开发问题,微过滤驱动就此诞生,微过滤驱动在编写时更简单,多数`IRP`操作都由过滤管理器`(FilterManager或Fltmgr)`所接管,因为有了兼容层,所以在开发中不需要考虑底层`IRP`如何派发,更无需要考虑兼容性问题,用户只需要编写对应的回调函数处理请求即可,这极大的提高了文件过滤驱动的开发效率。
|
芯片 SoC
OpenHarmony 标准系统HDF框架之I2C驱动开发
OpenHarmony 标准系统HDF框架之I2C驱动开发
375 0
OpenHarmony 标准系统HDF框架之I2C驱动开发
RK3399平台开发系列讲解(内核入门篇)1.51、platform_get_resource 函数实现细节
RK3399平台开发系列讲解(内核入门篇)1.51、platform_get_resource 函数实现细节
180 0

热门文章

最新文章

下一篇
开通oss服务