SpringBoot集成pf4j实现插件开发功能的代码示例

 更新时间:2024年07月11日 08:42:39   作者:HBLOG  
pf4j是一个插件框架,用于实现插件的动态加载,支持的插件格式(zip、jar),本文给大家介绍了SpringBoot集成pf4j实现插件开发功能的示例,文中通过代码示例给大家讲解的非常详细,需要的朋友可以参考下

1.什么是pf4j?

一个插件框架,用于实现插件的动态加载,支持的插件格式(zip、jar)。

核心组件

  • **Plugin:**是所有插件类型的基类。每个插件都被加载到一个单独的类加载器中以避免冲突。
  • **PluginManager:**用于插件管理的所有方面(加载、启动、停止)。您可以使用内置实现作为JarPluginManager, ZipPluginManager, DefaultPluginManager(它是一个JarPluginManager+ ZipPluginManager),或者您可以从AbstractPluginManager(仅实现工厂方法)开始实现自定义插件管理器。
  • **PluginLoader:**加载插件所需的所有信息(类)。
  • **ExtensionPoint:**是应用程序中可以调用自定义代码的点。这是一个java接口标记。任何 java 接口或抽象类都可以标记为扩展点(实现ExtensionPoint接口)。
  • **Extension:**是扩展点的实现。它是一个类上的 Java 注释

场景

有一个spring-boot实现的web应用,在某一个业务功能上提供扩展点,用户可以基于SDK实现功能扩展,要求可以管理插件,并且能够在业务功能扩展点处动态加载功能。

2.代码工程

实验目的

实现插件动态加载,调用 卸载

Demo整体架构

  • pf4j-api:定义可扩展接口。
  • pf4j-plugins-01:插件项目,可以包含多个插件,需要实现 plugin-api 中定义的接口。所有的插件jar包,放到统一的文件夹中,方便管理,后续只需要加载文件目录路径即可启动插件。
  • pf4j-app:主程序,需要依赖 pf4j-api ,加载并执行 pf4j-plugins-01 。

pf4j-api

导入依赖

<dependency>
    <groupId>org.pf4j</groupId>
    <artifactId>pf4j</artifactId>
    <version>3.0.1</version>
</dependency>

自定义扩展接口,集成 ExtensionPoint ,标记为扩展点

package com.et.pf4j;

import org.pf4j.ExtensionPoint;

public interface Greeting extends ExtensionPoint {

    String getGreeting();

}

打包给其他项目引用

pf4j-plugins-01

如果你想要能够控制插件的生命周期,你可以自定义类集成 plugin 重新里面的方法

/*
 * Copyright (C) 2012-present the original author or authors.
 *
 * 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.
 */
package org.pf4j.demo.welcome;

import com.et.pf4j.Greeting;
import org.apache.commons.lang.StringUtils;

import org.pf4j.Extension;
import org.pf4j.Plugin;
import org.pf4j.PluginWrapper;
import org.pf4j.RuntimeMode;

/**
 * @author Decebal Suiu
 */
public class WelcomePlugin extends Plugin {

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

    @Override
    public void start() {
        System.out.println("WelcomePlugin.start()");
        // for testing the development mode
        if (RuntimeMode.DEVELOPMENT.equals(wrapper.getRuntimeMode())) {
            System.out.println(StringUtils.upperCase("WelcomePlugin"));
        }
    }

    @Override
    public void stop() {
        System.out.println("WelcomePlugin.stop()");
    }

    @Extension
    public static class WelcomeGreeting implements Greeting {

        @Override
        public String getGreeting() {
            return "Welcome ,my name is pf4j-plugin-01";
        }

    }

}

打成jar或者zip包,方便主程序加载

pf4j-app

加载插件包

package com.et.pf4j;

import org.pf4j.JarPluginManager;
import org.pf4j.PluginManager;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import java.nio.file.Paths;
import java.util.List;

@SpringBootApplication
public class DemoApplication {

/* public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }*/
   public static void main(String[] args) {


      // create the plugin manager
      PluginManager pluginManager = new JarPluginManager(); // or "new ZipPluginManager() / new DefaultPluginManager()"

      // start and load all plugins of application
      //pluginManager.loadPlugins();

      pluginManager.loadPlugin(Paths.get("D:\\IdeaProjects\\ETFramework\\pf4j\\pf4j-plugin-01\\target\\pf4j-plugin-01-1.0-SNAPSHOT.jar"));
      pluginManager.startPlugins();
      /*
        // retrieves manually the extensions for the Greeting.class extension point
        List<Greeting> greetings = pluginManager.getExtensions(Greeting.class);
        System.out.println("greetings.size() = " + greetings.size());
        */
      // retrieve all extensions for "Greeting" extension point
      List<Greeting> greetings = pluginManager.getExtensions(Greeting.class);
      for (Greeting greeting : greetings) {
         System.out.println(">>> " + greeting.getGreeting());
      }

      // stop and unload all plugins
      pluginManager.stopPlugins();
      //pluginManager.unloadPlugins();


   }
}

3.测试

运行DemoApplication.java 里面的mian函数,可以看到插件加载,调用以及卸载情况

4.引用

https://pf4j.org/

https://github.com/pf4j/pf4j-spring

到此这篇关于SpringBoot集成pf4j实现插件开发功能的代码示例的文章就介绍到这了,更多相关SpringBoot pf4j插件开发内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java必须学会的类的继承与多态

    Java必须学会的类的继承与多态

    这篇文章主要介绍了Java类的继承与多态的相关资料,帮助大家更好的理解和学习Java,感兴趣的朋友可以了解下
    2020-08-08
  • 一文详解SpringBoot中CommandLineRunner接口

    一文详解SpringBoot中CommandLineRunner接口

    Spring Boot的CommandLineRunner接口是一个函数式接口,用于在Spring Boot应用程序启动后执行一些初始化操作,它提供了一个run方法,该方法在应用程序启动后被调用,本文给大家详细介绍了SpringBoot中CommandLineRunner接口,需要的朋友可以参考下
    2023-10-10
  • 详解Java多线程与并发

    详解Java多线程与并发

    多线程是一个进程在执行过程中产生多个更小的程序单元,这些更小的单元称为线程,这些线程可以同时存在,同时运行,一个进程可能包含多个同时执行的线程。多线程是实现并发机制的一种有效手段。进程和线程一样,都是实现并发的一个基本单位。
    2021-06-06
  • Springboot异步事件配置和使用示例详解

    Springboot异步事件配置和使用示例详解

    Spring框架提供了一套事件处理机制,允许应用在各个组件之间传递状态信息,自定义事件通常继承自ApplicationEvent类,Springboot通过自动配置简化了异步处理的配置,实现开箱即用,Spring事件模型核心是观察者模式,适用于解耦和提高响应速度
    2024-10-10
  • 使用java实现猜拳小游戏

    使用java实现猜拳小游戏

    这篇文章主要为大家详细介绍了使用java实现猜拳小游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • Mac OS X 下 IntelliJ IDEA、jEdit 等 Java 程序中文标点输入无效的完美解决方法

    Mac OS X 下 IntelliJ IDEA、jEdit 等 Java 程序中文标点输入无效的完美解决方法

    Mac OS X 下基于 Java 的程序会出现中文标点输入无效的问题,在中文输入法状态,可以输入中文字,但输入中文标点最后上去的是英文标点.这篇文章主要介绍了Mac OS X 下 IntelliJ IDEA、jEdit 等 Java 程序中文标点输入无效的完美解决方法,需要的朋友可以参考下
    2016-10-10
  • java9学习系列之安装与jshell使用

    java9学习系列之安装与jshell使用

    2017年9月21日,千呼万唤始出来,Java9终于发布了。作为自己天天接触的“对象”,还是应该多花点心思去了解她。后续再进一步了解详细特性。下面这篇文章主要给大家介绍了关于java9学习系列之安装与jshell使用的相关资料,需要的朋友可以参考下。
    2017-09-09
  • Spring中@Transactional(rollbackFor=Exception.class)属性用法介绍

    Spring中@Transactional(rollbackFor=Exception.class)属性用法介绍

    这篇文章介绍了Spring中@Transactional(rollbackFor=Exception.class)属性的用法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-12-12
  • 如何使用Java将word解析出来(包含格式和图片)

    如何使用Java将word解析出来(包含格式和图片)

    今天遇到一个读取word模板内容的需求,下面这篇文章主要给大家介绍了关于如何使用Java将word解析出来,包含格式和图片,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-12-12
  • Java面试题冲刺第二十二天-- Nginx

    Java面试题冲刺第二十二天-- Nginx

    这篇文章主要为大家分享了最有价值的三道关于Nginx的面试题,涵盖内容全面,包括数据结构和算法相关的题目、经典面试编程题等,感兴趣的小伙伴们可以参考一下
    2021-08-08

最新评论