pf4j下载 - pf4j源码下载

pf4j

JAVA源码

3.13.0

下载

Java 插件框架 (PF4J)

插件是第三方扩展应用程序功能的一种方式。插件实现由应用程序或其他插件声明的扩展点。此外，插件可以定义扩展点。

注意：从版本 0.9 开始，您可以直接在应用程序 jar 中定义扩展（您没有义务将扩展放入插件中 - 您可以将此扩展视为默认/系统扩展）。有关真实示例，请参阅 WhazzupGreeting。

特点/优点

使用 PF4J，您可以轻松地将单体 Java 应用程序转换为模块化应用程序。
PF4J 是一个开源（Apache 许可证）轻量级（大约100 KB ）java 插件框架，具有最小的依赖性（仅 slf4j-api）并且非常可扩展（请参阅PluginDescriptorFinder和ExtensionFinder ）。

实际上，PF4J 是一个微框架，旨在保持核心简单但可扩展。我们还有一个社区驱动的扩展生态系统。目前可以使用这些扩展：

pf4j-shell（PF4J 的交互式 shell）
pf4j-update（PF4J的更新机制）
pf4j-spring（PF4J - Spring 框架集成）
pf4j-wicket（PF4J - Wicket 集成）
pf4j-web（Web 应用程序中的 PF4J）

没有 XML，只有 Java。

您可以将任何接口或抽象类标记为扩展点（使用标记接口ExtensionPoint），并使用@Extension注释指定该类是扩展。

成分

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

PLUGIN =扩展点和扩展+ 生命周期方法（启动、停止、删除）的容器

插件与其他系统中的模块类似。如果您不需要生命周期方法（用于启动、停止、删除的挂钩方法），则不必强制提供插件类（插件描述符中的PluginClass属性是可选的）。您只需要提供插件的一些描述（id、版本、作者……）即可进行良好的跟踪（您的应用程序想知道谁提供了扩展或扩展点）。

如何使用

在您的应用程序中添加 pf4j 非常简单。

使用ExtensionPoint接口标记在应用程序/插件中定义扩展点：

 public interface Greeting extends ExtensionPoint {

    String getGreeting ();

}

使用@Extension注释创建扩展：

 @ Extension
public class WelcomeGreeting implements Greeting {

    public String getGreeting () {
        return "Welcome" ;
    }

}

如果您对插件的生命周期事件（启动、停止等）感兴趣，请创建（可选）一个Plugin类：

 public class WelcomePlugin extends Plugin {

    @ 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()" );
    }
    
}

在上面的代码中，我们创建了一个插件（欢迎），它附带一个Greeting扩展点扩展。

您可以将插件作为 jar 文件分发（简单的解决方案）。在这种情况下，将插件的元数据添加到 jar 的MANIFEST.MF文件中：

 Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: decebal
Build-Jdk: 1.6.0_17
Plugin-Class: org.pf4j.demo.welcome.WelcomePlugin
Plugin-Dependencies: x, y, z
Plugin-Id: welcome-plugin
Plugin-Provider: Decebal Suiu
Plugin-Version: 0.0.1

在上面的清单中，我们描述了一个 id 为welcome-plugin （强制属性）的插件。我们还定义了一个类org.pf4j.demo.welcome.WelcomePlugin （可选属性），其版本为0.0.1 （强制属性）并依赖于插件x, y, z （可选属性）。

现在您可以在代码中使用插件和扩展：

 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 . startPlugins ();

    // 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 ();
    
    ...
}