com.github.codingdebugallday.integration.user.PluginUser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of springboot-plugin-framework Show documentation
spring boot 插件式开发集成包
The newest version!
package com.github.codingdebugallday.integration.user;

import java.util.List;

import org.pf4j.PluginManager;

/**
 * 
 * 该接口用于在主程序操作Spring管理的插件bean.
 * 主要用途: 在主程序定义接口。插件中实现该接口做扩展, 主程序通过接口class可以获取到插件中的实现类。
 * 
 *
 * @author isaac 2020/6/17 15:27
 * @since 1.0
 */
public interface PluginUser {

    /**
     * 获取PluginManager
     *
     * @return PluginManager
     */
    PluginManager getPluginManager();

    /**
     * 通过bean名称得到bean。（Spring管理的bean）
     *
     * @param name bean的名称。spring体系中的bean名称。可以通过注解定义，也可以自定义生成。具体可百度
     * @param   bean的类型
     * @return T
     */
     T getBean(String name);

    /**
     * 通过aClass得到bean。（Spring管理的bean）
     *
     * @param aClass class
     * @param     bean的类型
     * @return T
     */
     T getBean(Class aClass);

    /**
     * 通过bean名称得到插件中的bean。（Spring管理的bean）
     *
     * @param name 插件中bean的名称。spring体系中的bean名称。可以通过注解定义，也可以自定义生成。具体可百度
     * @param   bean的类型
     * @return T
     */
     T getPluginBean(String name);

    /**
     * 在主程序中定义的接口。
     * 插件或者主程序实现该接口。可以该方法获取到实现该接口的所有实现类。（Spring管理的bean）
     * 使用场景:
     * 1. 在主程序定义接口
     * 2. 在主程序和插件包中都存在实现该接口, 并使用Spring的组件注解(@Component、@Service)
     * 3. 使用该方法可以获取到所以实现该接口的实现类(主程序和插件中)。
     *
     * @param aClass 接口的类
     * @param     bean的类型
     * @return List
     */
     List getBeans(Class aClass);

    /**
     * 得到主函数中定义的类。
     * 使用场景:
     * 1. 在主程序定义接口
     * 2. 在主程序和插件包中都存在实现该接口, 并使用Spring的组件注解(@Component、@Service)
     * 3. 使用该方法可以获取到主程序实现该接口的实现类。
     *
     * @param aClass 类/接口的类
     * @param     bean 的类型
     * @return List
     */
     List getMainBeans(Class aClass);


    /**
     * 在主程序中定义的接口。获取插件中实现该接口的实现类。（Spring管理的bean）
     * 使用场景:
     * 1. 在主程序定义接口
     * 2. 插件包中实现该接口, 并使用Spring的组件注解(@Component、@Service)
     * 3. 使用该方法可以获取到插件中实现该接口的实现类(不包括主程序)。
     *
     * @param aClass 接口的类
     * @param     bean的类型
     * @return 实现 aClass 接口的实现类的集合
     */
     List getPluginBeans(Class aClass);

    /**
     * 在主程序中定义的接口。获取指定插件中实现该接口的实现类。（Spring管理的bean）
     * 使用场景:
     * 1. 在主程序定义接口
     * 2. 插件包中实现该接口, 并使用Spring的组件注解(@Component、@Service)
     * 3. 使用该方法可以获取到指定插件中实现该接口的实现类。
     *
     * @param pluginId 插件id
     * @param aClass   接口的类
     * @param       bean的类型
     * @return 实现 aClass 接口的实现类的集合
     */
     List getPluginBeans(String pluginId, Class aClass);

    /**
     * 在主程序中定义的接口。获取指定插件中实现该接口的实现类。（Spring管理的bean）
     * 使用场景:
     * 1. 在主程序定义接口
     * 2. 插件包中实现该接口, 并使用Spring的组件注解(@Component、@Service)
     * 3. 使用该方法可以获取到指定插件中实现该接口的实现类。
     *
     * @param pluginId 插件id
     * @param aClass   接口的类
     * @param       bean的类型
     * @return 实现 aClass 接口的实现类的集合
     */
     T getPluginBean(String pluginId, Class aClass);


    /**
     * 生成一个新的Spring实例Bean.
     * 使用场景：主要用于非单例对象的生成。
     *
     * @param object 旧实例对象
     * @param     实例泛型
     * @return 新实例对象
     */
     T generateNewInstance(T object);


    /**
     * 使用场景:
     * 1. 在主程序定义接口(该接口需要继承 ExtensionPoint 接口)。
     * 2. 插件包中实现该接口
     * 3. 在主程序可以使用该方法获取到实现该接口的实现类。（实现类可以配合 @Extension 控制顺序）
     * 注意: 该场景用于非Spring管理的bean, 使用Spring注解无效
     *
     * @param tClass bean的类型
     * @param     bean的类型
     * @return List
     */
     List getPluginExtensions(Class tClass);

    /**
     * 使用场景:
     * 1. 在主程序定义接口(该接口需要继承 ExtensionPoint 接口)。
     * 2. 插件包中实现该接口
     * 3. 在主程序可以使用该方法获取到实现该接口的实现类。（实现类可以配合 @Extension 控制顺序）
     * 注意: 该场景用于非Spring管理的bean, 使用Spring注解无效
     *
     * @param tClass   bean的类型
     * @param pluginId 插件id
     * @param       bean的类型
     * @return List
     */
     List getPluginExtensions(Class tClass, String pluginId);

    /**
     * 使用场景:
     * 1. 在主程序定义接口(该接口需要继承 ExtensionPoint 接口)。
     * 2. 插件包中实现该接口
     * 3. 在主程序可以使用该方法获取到实现该接口的实现类。（实现类可以配合 @Extension 控制顺序）
     * 注意: 该场景用于非Spring管理的bean, 使用Spring注解无效
     *
     * @param tClass   bean的类型
     * @param pluginId 插件id
     * @param       bean的类型
     * @return List
     */
     T getPluginExtension(Class tClass, String pluginId);

}