com.github.codingdebugallday.integration.user

类 DefaultPluginUser

java.lang.Object

com.github.codingdebugallday.integration.user.DefaultPluginUser

所有已实现的接口:

PluginUser

public class DefaultPluginUser
extends Object
implements PluginUser

默认插件使用者

从以下版本开始:

1.0

作者:

isaac 2020/6/17 15:24

字段概要

字段

限定符和类型	字段和说明
protected org.springframework.context.support.GenericApplicationContext	applicationContext
protected org.slf4j.Logger	log
protected org.pf4j.PluginManager	pluginManager

构造器概要

构造器

构造器和说明
DefaultPluginUser(org.springframework.context.ApplicationContext applicationContext, org.pf4j.PluginManager pluginManager)

方法概要

限定符和类型	方法和说明
<T> T	generateNewInstance(T object) 生成一个新的Spring实例Bean.
<T> T	getBean(Class<T> aClass) 通过aClass得到bean。
<T> T	getBean(String name) 通过bean名称得到插件的bean。
<T> List<T>	getBeans(Class<T> aClass) 在主程序中定义的接口。
<T> List<T>	getMainBeans(Class<T> aClass) 得到主函数中定义的类。
<T> T	getPluginBean(String name) 通过bean名称得到插件中的bean。
<T> List<T>	getPluginBeans(Class<T> aClass) 在主程序中定义的接口。
<T> List<T>	getPluginBeans(String pluginId, Class<T> aClass) 在主程序中定义的接口。
<T> List<T>	getPluginExtensions(Class<T> tClass) 得到插件扩展接口实现的bean。
<T> List<T>	getPluginExtensions(Class<T> tClass, String pluginId) 得到插件扩展接口实现的bean。
org.pf4j.PluginManager	getPluginManager() 获取PluginManager
protected boolean	isPluginBean(String beanName) 是否是插件中的bean

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

log

protected final org.slf4j.Logger log

applicationContext

protected final org.springframework.context.support.GenericApplicationContext applicationContext

pluginManager

protected final org.pf4j.PluginManager pluginManager

构造器详细资料

DefaultPluginUser

public DefaultPluginUser(org.springframework.context.ApplicationContext applicationContext,
                         org.pf4j.PluginManager pluginManager)

方法详细资料

getPluginManager

public org.pf4j.PluginManager getPluginManager()

获取PluginManager

指定者:

getPluginManager 在接口中 PluginUser

返回:

PluginManager

getBean

public <T> T getBean(String name)

通过bean名称得到插件的bean。（Spring管理的bean）

指定者:

getBean 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

name - 插件bean的名称。spring体系中的bean名称。可以通过注解定义，也可以自定义生成。具体可百度

返回:

返回bean

getBean

public <T> T getBean(Class<T> aClass)

从接口复制的说明: PluginUser

通过aClass得到bean。（Spring管理的bean）

指定者:

getBean 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

aClass - class

返回:

T

getPluginBean

public <T> T getPluginBean(String name)

从接口复制的说明: PluginUser

通过bean名称得到插件中的bean。（Spring管理的bean）

指定者:

getPluginBean 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

name - 插件中bean的名称。spring体系中的bean名称。可以通过注解定义，也可以自定义生成。具体可百度

返回:

T

getBeans

public <T> List<T> getBeans(Class<T> aClass)

在主程序中定义的接口。插件或者主程序实现该接口。可以该方法获取到实现该接口的所有实现类。（Spring管理的bean）

指定者:

getBeans 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

aClass - 接口的类

返回:

List

getMainBeans

public <T> List<T> getMainBeans(Class<T> aClass)

从接口复制的说明: PluginUser

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

指定者:

getMainBeans 在接口中 PluginUser

类型参数:

T - bean 的类型

参数:

aClass - 类/接口的类

返回:

List

getPluginBeans

public <T> List<T> getPluginBeans(Class<T> aClass)

在主程序中定义的接口。获取插件中实现该接口的实现类。（Spring管理的bean）

指定者:

getPluginBeans 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

aClass - 接口的类

返回:

List

getPluginBeans

public <T> List<T> getPluginBeans(String pluginId,
                                  Class<T> aClass)

从接口复制的说明: PluginUser

在主程序中定义的接口。获取指定插件中实现该接口的实现类。（Spring管理的bean） 使用场景: 1. 在主程序定义接口 2. 插件包中实现该接口, 并使用Spring的组件注解(@Component、@Service) 3. 使用该方法可以获取到指定插件中实现该接口的实现类。

指定者:

getPluginBeans 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

pluginId - 插件id

aClass - 接口的类

返回:

实现 aClass 接口的实现类的集合

generateNewInstance

public <T> T generateNewInstance(T object)

从接口复制的说明: PluginUser

生成一个新的Spring实例Bean. 使用场景：主要用于非单例对象的生成。

指定者:

generateNewInstance 在接口中 PluginUser

类型参数:

T - 实例泛型

参数:

object - 旧实例对象

返回:

新实例对象

getPluginExtensions

public <T> List<T> getPluginExtensions(Class<T> tClass)

得到插件扩展接口实现的bean。（非Spring管理）

指定者:

getPluginExtensions 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

tClass - 接口的类

返回:

返回bean

getPluginExtensions

public <T> List<T> getPluginExtensions(Class<T> tClass,
                                       String pluginId)

得到插件扩展接口实现的bean。（非Spring管理）

指定者:

getPluginExtensions 在接口中 PluginUser

类型参数:

T - bean的类型

参数:

tClass - 接口的类

pluginId - 插件id

返回:

返回bean

isPluginBean

protected boolean isPluginBean(String beanName)

是否是插件中的bean

参数:

beanName - bean名称

返回:

boolean