java 插件式架构_springboot插件式开发框架

介绍

该框架主要是集成于springboot项目，用于开发插件式应用的集成框架。

核心功能

插件配置式插拔于springboot项目。

在springboot上可以进行插件式开发, 扩展性极强, 可以针对不同项目开发不同插件, 进行不同插件jar包的部署。

可通过配置文件指定要启用或者禁用插件。

支持上传插件和插件配置文件到服务器, 并且无需重启主程序, 动态部署插件、更新插件。

支持查看插件运行状态, 查看插件安装位置。

无需重启主程序, 动态的安装插件、卸载插件、启用插件、停止插件、备份插件、删除插件。

在插件应用模块上可以使用Spring注解定义组件, 进行依赖注入。

支持在插件中开发Rest接口。

支持在插件中单独定义持久层访问等需求。

可以遵循主程序提供的插件接口开发任意扩展功能。

插件可以自定义配置文件。目前只支持yml文件。

支持自定义扩展开发接口, 使用者可以在预留接口上扩展额外功能。

利用扩展机制, 定制了SpringBoot-Mybatis扩展包。使用该扩展包, 使用者可以在插件中自定义Mapper接口、Mapper xml 以及对应的实体bean。

源码地址

https://gitee.com/starblues/springboot-plugin-framework-parent

运行环境

jdk1.8+

apache maven 3.6

mavne 仓库地址

https://mvnrepository.com/artifact/com.gitee.starblues/springboot-plugin-framework

快速入门

新建项目。

Maven目录结构下所示

-example

- example-runner

- pom.xml

- example-main

- pom.xml

- example-plugin-parent

- pom.xml

- plugins

- example-plugin1

- pom.xml

- plugin.properties

- example-plugin2

- pom.xml

- plugin.properties

- pom.xml

结构说明:

pom.xml 代表maven的pom.xml

plugin.properties 为开发环境下, 插件的元信息配置文件, 配置内容详见下文。

example 为项目的总Maven目录。

example-runner 在运行环境下启动的模块。主要依赖example-main模块和插件中使用到的依赖包。

example-main 该模块为项目的主程序模块。

example-plugin-parent 该模块为插件的父级maven pom 模块, 主要定义插件中公共用到的依赖, 以及插件的打包配置。

plugins 该文件夹下主要存储插件模块。上述模块中主要包括example-plugin1、example-plugin2 两个插件。

example-plugin1、example-plugin2 分别为两个插件Maven包。

主程序集成步骤

主程序为上述目录结构中的 example-main 模块。

在主程序中新增maven依赖包

com.gitee.starblues

springboot-plugin-framework

${springboot-plugin-framework.version}

实现并定义配置

实现 com.plugin.development.integration.IntegrationConfiguration 接口。

import com.gitee.starblues.integration.DefaultIntegrationConfiguration;

import org.pf4j.RuntimeMode;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.boot.context.properties.ConfigurationProperties;

import org.springframework.stereotype.Component;

@Component

@ConfigurationProperties(prefix = "plugin")

public class PluginConfiguration extends DefaultIntegrationConfiguration {

/**

* 运行模式

* 开发环境: development、dev

* 生产/部署环境: deployment、prod

@Value("${runMode:dev}")

private String runMode;

/**

* 插件的路径

@Value("${pluginPath:plugins}")

private String pluginPath;

/**

* 插件文件的路径

@Value("${pluginConfigFilePath:pluginConfigs}")

private String pluginConfigFilePath;

@Override

public RuntimeMode environment() {

return RuntimeMode.byName(runMode);

}

@Override

public String pluginPath() {

return pluginPath;

}

@Override

public String pluginConfigFilePath() {

return pluginConfigFilePath;

}

/**

* 重写上传插件包的临时存储路径。只适用于生产环境

* @return String

@Override

public String uploadTempPath() {

return "temp";

}

/**

* 重写插件备份路径。只适用于生产环境

* @return String

@Override

public String backupPath() {

return "backupPlugin";

}

/**

* 重写插件RestController请求的路径前缀

* @return String

@Override

public String pluginRestControllerPathPrefix() {

return "/api/plugins";

}

/**

* 重写是否启用插件id作为RestController请求的路径前缀。

* 启动则插件id会作为二级路径前缀。即: /api/plugins/pluginId/**

* @return String

@Override

public boolean enablePluginIdRestControllerPathPrefix() {

return true;

}

public String getRunMode() {

return runMode;

}

public void setRunMode(String runMode) {

this.runMode = runMode;

}

public String getPluginPath() {

return pluginPath;

}

public void setPluginPath(String pluginPath) {

this.pluginPath = pluginPath;

}

public String getPluginConfigFilePath() {

return pluginConfigFilePath;

}

public void setPluginConfigFilePath(String pluginConfigFilePath) {

this.pluginConfigFilePath = pluginConfigFilePath;

}

@Override

public String toString() {

return "PluginArgConfiguration{" +

"runMode='" + runMode + '\'' +

", pluginPath='" + pluginPath + '\'' +

", pluginConfigFilePath='" + pluginConfigFilePath + '\'' +

'}';

}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

配置说明:

runMode：运行项目时的模式。分为开发环境(dev)、生产环境(prod)

pluginPath: 插件的路径。开发环境建议直接配置为插件模块的父级目录。例如: plugins。如果启动主程序时, 插件为加载, 请检查该配置是否正确。

pluginConfigFilePath: 在生产环境下, 插件的配置文件路径。在生产环境下，请将所有插件使用到的配置文件统一放到该路径下管理。如果启动主程序时, 报插件的配置文件加载错误, 有可能是该该配置不合适导致的。

uploadTempPath: 上传插件包时使用。上传插件包存储的临时路径。默认 temp(相对于主程序jar路径)

backupPath: 备份插件包时使用。备份插件包的路径。默认: backupPlugin(相对于主程序jar路径)

pluginRestControllerPathPrefix: 插件RestController请求的路径前缀

enablePluginIdRestControllerPathPrefix: 是否启用插件id作为RestController请求的路径前缀。启动则插件id会作为二级路径前缀。即: /api/plugins/pluginId/**

配置bean

import com.gitee.starblues.integration.*;

import com.gitee.starblues.integration.initialize.AutoPluginInitializer;

import com.gitee.starblues.integration.initialize.PluginInitializer;

import org.pf4j.PluginException;

import org.pf4j.PluginManager;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

@Configuration

public class PluginBeanConfig {

/**

* 通过默认的集成工厂返回 PluginManager

* @param integrationConfiguration 集成的配置文件

* @return

* @throws PluginException

@Bean

public PluginManager pluginManager(IntegrationConfiguration integrationConfiguration) throws PluginException {

IntegrationFactory integrationFactory = new DefaultIntegrationFactory();

return integrationFactory.getPluginManager(integrationConfiguration);

}

/**

* 定义默认的插件应用。使用可以注入它操作插件。

* @return

@Bean

public PluginApplication pluginApplication(){

return new DefaultPluginApplication();

}

/**

* 初始化插件。此处定义可以在系统启动时自动加载插件。

* 如果想手动加载插件, 则可以使用 com.plugin.development.integration.initialize.ManualPluginInitializer 来初始化插件。

* @param pluginApplication

* @return

@Bean

public PluginInitializer pluginInitializer(PluginApplication pluginApplication){

AutoPluginInitializer autoPluginInitializer = new AutoPluginInitializer(pluginApplication);

return autoPluginInitializer;

}

插件包集成步骤

插件包pom.xml配置说明

以 provided 方式引入springboot-plugin-framework包

com.gitee.starblues

springboot-plugin-framework

${springboot-plugin-framework.version}

provided

定义打包配置.主要用途是将 Plugin-Id、Plugin-Version、Plugin-Provider、Plugin-Class、Plugin-Dependencies的配置值定义到META-INF\MANIFEST.MF文件中

springboot-plugin-example-plugin1

com.plugin.example.plugin1.DefinePlugin

${project.version}

StarBlues

1.8

UTF-8

3.7.0

3.1.1

org.apache.maven.plugins

maven-compiler-plugin

${maven-compiler-plugin.version}

${java.version}

${project.build.sourceEncoding}

org.apache.maven.plugins

maven-assembly-plugin

${maven-assembly-plugin.version}

jar-with-dependencies

true

${plugin.id}

${plugin.version}

${plugin.provider}

${plugin.class}

make-assembly

package

single

在插件包的一级目录下新建plugin.properties文件(用于开发环境)

新增如下内容(属性值同步骤1中pom.xml定义的manifestEntries属性一致):

plugin.id=springboot-plugin-example-plugin1

plugin.class=com.plugin.example.plugin1.DefinePlugin

plugin.version=2.0-SNAPSHOT

plugin.provider=StarBlues

配置说明:

plugin.id: 插件id

plugin.class: 插件实现类。见步骤3说明

plugin.version: 插件版本

plugin.provider: 插件作者

继承 com.gitee.starblues.realize.BasePlugin 包

import com.gitee.starblues.realize.BasePlugin;

import org.pf4j.PluginException;

import org.pf4j.PluginWrapper;

public class DefinePlugin extends BasePlugin {

public DefinePlugin(PluginWrapper wrapper) {

super(wrapper);

}

@Override

protected void startEvent() throws PluginException {

}

@Override

protected void deleteEvent() throws PluginException {

}

@Override

protected void stopEvent() {

}

并且将该类的包路径(com.plugin.example.plugin1.DefinePlugin)配置在步骤1和2的plugin.class属性中。

新增HelloPlugin1 controller

此步骤主要验证环境是否加载插件成功。

@RestController

@RequestMapping(path = "plugin1")

public class HelloPlugin1 {

@GetMapping()

public String getConfig(){

return "hello plugin1"

}

运行配置

配置模块 example-runner 的pom.xml

将主程序的依赖新增到pom.xml 下

将插件中的依赖以 provided 方式引入到 pom.xml 下

如下所示:

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

org.springframework.boot

spring-boot-starter-parent

2.0.3.RELEASE

com.gitee.starblues

plugin-example-runner

2.0-RELEASE

pom

2.8.2

com.gitee.starblues

plugin-example-start

${project.version}

com.google.code.gson

gson

${gson.version}

provided

设置idea的启动

Working directory : D:\xx\xx\springboot-plugin-framework-parent\plugin-example

Use classpath of module: plugin-exampe-runner

勾选: Include dependencies with “Provided” scope

启动2步骤的配置。

观察日志出现如下说明加载插件成功。

Plugin 'springboot-plugin-example-plugin1@2.0-RELEASE' resolved

Start plugin 'springboot-plugin-example-plugin1@2.0-RELEASE'

Init Plugins Success

访问插件中的Controller 验证。

浏览器输入：http://ip:port/api/plugins/springboot-plugin-example-plugin1/plugin1

响应并显示: hello plugin1

说明集成成功！

使用说明

插件中定义配置文件

在插件包的 resources 目录下定义配置文件 plugin1.yml

name: plugin1

plugin: examplePlugin1

setString:

- set1

- set2

listInteger:

- 1

- 2

- 3

subConfig:

subName: subConfigName

在代码中定义对应的bean

import com.gitee.starblues.annotation.ConfigDefinition;

import java.util.List;

import java.util.Set;

@ConfigDefinition("plugin1.yml")

public class PluginConfig1 {

private String name;

private String plugin;

private Set setString;

private List listInteger;

private String defaultValue = "defaultValue";

private SubConfig subConfig;

// 自行提供get set 方法

}

public class SubConfig {

private String subName;

public String getSubName() {

return subName;

}

// 自行提供get set 方法

}

该bean必须加上 @ConfigDefinition(“plugin1.yml”) 注解。其中值为插件文件的名称。

其他地方使用时, 可以通过注入方式使用。

例如：

@Component("plugin2HelloService")

public class HelloService {

private final PluginConfig1 pluginConfig1;

private final Service2 service2;

@Autowired

public HelloService(PluginConfig1 pluginConfig1, Service2 service2) {

this.pluginConfig1 = pluginConfig1;

this.service2 = service2;

}

public PluginConfig1 getPluginConfig1(){

return pluginConfig1;

}

public String sayService2(){

return service2.getName();

}

注意事项

在开发环境：配置文件必须放在resources目录下。并且@ConfigDefinition(“plugin1.yml”)中定义的文件名和resources下配置的文件名一致。

在生产环境: 该文件存放在pluginConfigFilePath配置的目录下。

集成扩展

SpringBoot Mybatis 扩展

文档见: springboot-plugin-framework-extension-mybatis

案例部署

普通例子运行见：package/example

windows环境下运行: package.bat

linux、mac 环境下运行: package.sh

mybatis 案例部署

普通例子运行见：package/example-persistence

windows环境下运行: package.bat

linux、mac 环境下运行: package.sh

sql在 plugin-example-persistence/sql 文件夹下。

生产环境目录

-main.jar

-main.yml

-plugins

-plugin1.jar

-plugin2.jar

-pluginFile

-plugin1.yml

-plugin2.yml

案例说明

plugin-example：插件基础功能案例。

plugin-example-persistence: 针对Mybatis集成的案例。

生产环境配置禁用启用功能

启用、禁用功能

1.在插件目录下新建 enabled.txt 文件

2.enabled.txt的内容为:

########################################

# - 启用的插件

########################################

example-plugin1

将需要启用的插件id配置到文件中。

所有注释行(以＃字符开头的行)都将被忽略。

禁用功能

1.在插件目录下新建 disabled.txt 文件

2.disabled.txt的内容为:

########################################

# - 禁用的插件

########################################

example-plugin1

将需要启用的插件id配置到文件中。

所有注释行(以＃字符开头的行)都将被忽略。

注意事项

插件中代码编写完后, 请保证在class文件下的类都是最新编译的, 再运行主程序, 否则会导致运行的插件代码不是最新的。

如果启动时插件没有加载。请检查配置文件中的 pluginPath

如果pluginPath 配置为相当路径，请检查是否是相对于当前工作环境的目录。

如果pluginPath配置为绝对路径，请检查路径是否正确。

小技巧

idea 启动主程序时, 自动编译插件包的配置

选择

File->Project Structure->Project Settings->Artifacts->点击+号->JAR->From modules whith dependencies->选择对应的插件包->确认OK

启动配置:

在Before launch 下-> 点击小+号 -> Build ->Artifacts -> 选择上一步新增的>Artifacts

版本更新

1.1 版本

新增插件注册、卸载监听器。

新增可通过 PluginUser 获取插件中实现主程序中定义的接口的实现类。

新增插件注册、卸载时监听器。

2.0 版本(重大版本更新)

重构代码。

新增扩展机制。

简化依赖注入注解, 保持与SpringBoot依赖注入方式一致。

新增插件工厂监听器、新增插件初始化监听器(适用于第一次启动)。

新增插件包Mybatis的集成, 可在插件包中独立定义Mapper接口、Mapper xml、实体bean。

---------------------

原文链接：https://blog.csdn.net/weixin_39940901/article/details/114086411