PF4J使用

2023-10-20 21:59| 来源: 网络整理| 查看: 265

PF4J是一个Java轻量级的插件框架，可以实现动态加载，执行，卸载外部插件(支持jar以及zip)，具体可以看官网：https://pf4j.org/。

本文例子基于Github地址：https://github.com/pf4j/pf4j

org.pf4j pf4j 3.0.1 插件项目会涉及到3个工程：工程结构 plugin-api：定义可扩展接口 plugins：插件项目，可以包含多个插件，需要实现plugin-api中定义的接口 plugin-app：主程序，需要依赖plugin-api，加载并执行plugins 定义可扩展接口(plugin-api)

简单定义一个接口，需继承ExtensionPoint：

package plugin.api;import org.pf4j.ExtensionPoint;public interface Greeting extends ExtensionPoint { String getGreeting();} 实现插件(plugins) 插件需要实现plugin-api定义的接口，并且使用@Extension标记： package plugins;import org.pf4j.Extension;import plugin.api.Greeting;@Extensionpublic class WelcomeGreeting implements Greeting { public String getGreeting() { return "Welcome"; }}

插件打包(plugins) 插件打包时，需要往MANIFEST.MF写入插件信息，此处使用maven插件(打包命令为package)： org.apache.maven.plugins maven-jar-plugin 2.3.1 welcome-plugin 0.0.1

根据Github上介绍，MANIFEST.MF中Plugin-Id以及Plugin-Version是必须信息：

In above manifest I described a plugin with id welcome-plugin (mandatory attribute), with class org.pf4j.demo.welcome.WelcomePlugin (optional attribute), with version 0.0.1 (mandatory attribute) and with dependencies to plugins x, y, z (optional attribute).

此处定义插件ID为welcome-plugin，版本为0.0.1

加载执行插件(plugin-app) package plugin.app;import java.nio.file.Paths;import java.util.List;import org.pf4j.JarPluginManager;import org.pf4j.PluginManager;import plugin.api.Greeting;public class Main { public static void main(String[] args) { // jar插件管理器 PluginManager pluginManager = new JarPluginManager(); // 加载指定路径插件 pluginManager.loadPlugin(Paths.get("plugins-0.0.1-SNAPSHOT.jar")); // 启动指定插件(也可以加载所有插件) pluginManager.startPlugin("welcome-plugin"); // 执行插件 List greetings = pluginManager.getExtensions(Greeting.class); for (Greeting greeting : greetings) { System.out.println(">>> " + greeting.getGreeting()); } // 停止并卸载指定插件 pluginManager.stopPlugin("welcome-plugin"); pluginManager.unloadPlugin("welcome-plugin"); }}

运行输出：

>>> Welcome 其他插件周期

如果对插件生命周期(如加载，执行，停止等)有兴趣的话，可以实现插件类继承Plugin：

package plugins;import org.pf4j.Plugin;import org.pf4j.PluginWrapper;public class WelcomePlugin extends Plugin { public WelcomePlugin(PluginWrapper wrapper) { super(wrapper); } @Override public void start() { System.out.println("WelcomePlugin.start()"); } @Override public void stop() { System.out.println("WelcomePlugin.stop()"); } @Override public void delete() { System.out.println("WelcomePlugin.delete()"); }}

同时往MANIFEST.MF写入插件信息：

org.apache.maven.plugins maven-jar-plugin 2.3.1 welcome-plugin 0.0.1 plugins.WelcomePlugin

打包后运行输出：

WelcomePlugin.start()>>> WelcomeWelcomePlugin.stop() 如果对运行流程感兴趣，或者调试，可以将日志级别设为debug日志

log4j.properties示例：

log4j.rootLogger = debug,stdout,loglog4j.appender.stdout = org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout = org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern = %d [%-5p] %l %r ms: %m%nlog4j.appender.log = org.apache.log4j.DailyRollingFileAppenderlog4j.appender.log.DatePattern = _yyyy-MM-ddlog4j.appender.log.File = logs/debug.loglog4j.appender.log.Encoding = UTF-8log4j.appender.log.layout = org.apache.log4j.PatternLayoutlog4j.appender.log.layout.ConversionPattern = %d [%-5p] (%c.%t): %m%n

【本文地址】

公司简介

联系我们