pf4j插件实践验证

Java系统实现插件机制，可自行通过classloader实现，亦可使用成熟的框架。pf4j是一款轻量级，扩展性强的插件，可实现插件的开发管理（插件开发、加载、卸载、更新），省略了一些基础代码的开发，成熟度高，可应用于项目快速开启插件功能的开发。

一、pf4j插件

官网：https://pf4j.org/doc/getting-started.html

二、实践验证

1.创建maven父子项目

• parent：根节点或父项目
  • plugin-common：共用部分
  • plugin-service：插件应用服务
  • plugins：插件模块，所有插件的父项目
    • plugin-demo：plugin-demo插件

2.common模块

添加依赖

目前最新版：3.11.0，前往maven仓库查询新版：https://central.sonatype.com/artifact/org.pf4j/pf4j

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

创建插件接口

import org.pf4j.ExtensionPoint;

public interface SecurityCheckService extends ExtensionPoint {

    String getBaiduHtml();
}

3.plugin-demo插件模块

添加共用依赖

注意，plugin-common引入，scope必须是provided，否则打包时打包进去后，pf4j扫描多个classpath导致无法找到插件。

<dependency>
    <groupId>com.xxx</groupId>
    <artifactId>plugin-common</artifactId>
    <!-- 注意：必须是provided，否则打包时打包进去后，pf4j扫描多个classpath导致无法找到插件 -->
    <scope>provided</scope>
</dependency>

配置maven打包插件

说明：

• 由于插件真实开发需要使用三方依赖，需要使用maven-assembly-plugin插件打包包含依赖，执行maven package命令后，生成两个jar包，以jar-with-dependencies命名结尾的，即包含依赖的Jar。
• pf4j需要往classes/META-INF/MANIFEST.MF配置一些必要属性，通过manifestEntries进行指定。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <addClasspath>true</addClasspath>
            </manifest>
            <manifestEntries>
                <Plugin-Id>demo-plugin</Plugin-Id>
                <Plugin-Version>0.0.1</Plugin-Version>
            </manifestEntries>
        </archive>
        <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
    </configuration>
    <executions>
        <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

插件逻辑开发

说明：

• Jsoup是三方工具，可maven仓库搜索引入。
• 实现plugin-common中定义的插件接口SecurityCheckService，同时开启@Extension注解，pf4j通过该注解识别插件。

import com.code.plugin.pf4j.SecurityCheckService;
import org.jsoup.Jsoup;
import org.pf4j.Extension;

import java.io.IOException;

@Extension
public class Pf4jDemo implements SecurityCheckService {

    @Override
    public String getBaiduHtml() {
        try {
            return Jsoup.connect("https://www.baidu.com").get().html();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

4.plugin-service模块

引入plugin-common依赖

<dependency>
    <groupId>com.xxx</groupId>
    <artifactId>common</artifactId>
</dependency>

初始化插件

如果是普通Java项目，可直接new调用，Spring项目在项目启动时初始化PluginManager。

import org.pf4j.JarPluginManager;
import org.pf4j.PluginManager;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import java.nio.file.Path;
import java.nio.file.Paths;

@Component
public class PluginInit {

    @Bean
    public PluginManager initPluginManager() {
        Path pluginPath = Paths.get("d:/tmp/plugins");
        PluginManager pluginManager = new JarPluginManager(pluginPath);
        //加载所有插件
        pluginManager.loadPlugins();

        //开启所有插件
//        pluginManager.startPlugins();

        //启动指定插件
        pluginManager.startPlugin("demo-plugin");

        //卸载插件
//        pluginManager.unloadPlugin("demo-plugin");
        return pluginManager;
    }
}

插件调用

// 在合适位置即可引入PluginManager进行调用
List<SecurityCheckService> extensions = pluginManager.getExtensions(SecurityCheckService.class, "demo-plugin");
//一般业务中，同一个插件ID，只保留一个
String r = extensions.get(0).getBaiduHtml();
System.out.println(r);

5.注意点

• 插件的调用，Java进程会占用jar文件，分布式环境中，不能在共享存储中直接调用，需下载到各服务本地，进行调用。
• 插件引入公共模块时，scope一定要指定，否则会出现找不到插件的错误。
• JarPluginManager加载Jar包，还有ZipPluginManager，根据具体业务场景进行适配即可。
• 插件支持生命周期的管理，详情可进入官网，查看案例。