spring-boot集成spring-brick实现动态插件

已于 2023-08-18 22:06:58 修改
阅读量1.7w 收藏 9
点赞数 3
文章标签： spring-boot动态插件 spring-boot插件化 spring-brick支持 集成spring-brick 插件化应用
于 2023-06-07 15:54:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/justry_deng/article/details/131089588
版权

spring-boot集成spring-brick实现动态插件

项目结构 & 需求实现

提示：本文的集成说明，是针对完成此设计、此需求进行的

项目结构

demo
│ 
├─application # 主应用
│                  
└─plugin-api
    │  
    ├─plugin-qwer # plugin-qwer-api的实现示例1（注：也可以是单独的一个项目，继承不继承plugin-api均可）
    │                                              
    ├─plugin-qwer2 # plugin-qwer-api的实现示例2（注：也可以是单独的一个项目，继承不继承plugin-api均可）
    │                                          
    ├─plugin-qwer-api  # 插件qwer-api
    │                                          
    ├─plugin-xyz  # plugin-xyz-api的实现示例（注：也可以是单独的一个项目，继承不继承plugin-api均可）
    │                                          
    └─plugin-xyz-api # 插件xyz-api

需求实现

  • 主应用（application）、各个插件的实现（plugin-qwer、plugin-qwer2、plugin-xyz）均可单独启动
  • 主应用（application）启动后，可动态插拔各插件（plugin-qwer、plugin-qwer2、plugin-xyz）
  • 在plugin-api中，定义各种接口、及相关的pojo，这些接口由具体的插件实现去完成，主应用（application）面向plugin-api编程即可

spring-boot集成spring-brick

环境说明

  • spring-boot：2.6.13
  • spring-brick：3.1.1

1. 主程序集成spring-brick

第一步：引入相关依赖

更多详见here

<dependency>
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick</artifactId>
    <version>3.1.1</version>
</dependency>
第二步：修改程序入口方法

更多详见here

import com.gitee.starblues.loader.launcher.SpringBootstrap;
import com.gitee.starblues.loader.launcher.SpringMainBootstrap;
import com.ideaaedi.commonspring.annotation.EnableParameterRecorder;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * main-application start class
 */
@SpringBootApplication
public class MainApplication implements SpringBootstrap {
    public static void main(String[] args) {
        // 这里使用 SpringMainBootstrap 引导启动
        SpringMainBootstrap.launch(MainApplication.class, args);
    }
    
    @Override
    public void run(String[] args) throws Exception {
        // 这里的写法和SpringBoot 启动保持一致
        SpringApplication.run(MainApplication.class, args);
    }
}
第三步：编写配置

更多配置详见here

plugin:
  # 运行模式, 开发环境: dev; 生产环境: prod
  runMode: prod
  # 主程序包名, 包名建议设置到范围最大级别，能包含主程序所有类的包名范围
  mainPackage: com.example.springbrick.application
  # 插件的路径, 可配置多个, 开发环境下配置为插件模块上级目录; 生产环境下配置到插件jar包存放目录。
  # 可使用~符号表示相对目录，比如：~/plugins，开发环境相对于开发根目录，生产环境下相对于主程序jar所在目录
  pluginPath:
    - C:/Users/Administrator/Desktop/plugin
第四步：设置maven插件
<!-- 本人引入此插件后，去除了spring-boot自身的打包插件 -->
<plugin>
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick-maven-packager</artifactId>
    <version>3.1.1</version>
    <configuration>
        <mode>main</mode>
        <mainConfig>
            <!-- 指定main -->
            <mainClass>com.example.springbrick.application.MainApplication</mainClass>
            <packageType>jar</packageType>
        </mainConfig>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
</plugin>

2. 准备plugin-api

第一步：引入相关依赖
<dependency>
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick</artifactId>
    <version>3.1.1</version>
    <!-- 这里指定为provided即可，主程序中已经存在此artifact了  -->
    <scope>provided</scope>
</dependency>
第二步：引入相关依赖

注意：各plugin-api的包名，应该处于主程序包名（本人这里为plugin.mainPackage=com.example.springbrick.application）的子集。如果不这样设置的话，主程序和插件实现程序加载plugin-api中的类时，将被类加载器隔离

根据自己业务需要，定义业务接口及相关pojo即可，如：

在这里插入图片描述

3. 实现plugin-api

提示：各plugin-api的实现程序，继承不继承父类plugin-api都可以

第一步：引入相关依赖

更多详见here

  • 架构级依赖

    <!-- 引入要实现的plugin-api -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>plugin-xyz-api</artifactId>
    <version>1.0.0</version>
</dependency>

<!-- 引入spring-brick-bootstrap以完成插件的引导 -->
<dependency>
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick-bootstrap</artifactId>
    <version>3.1.1</version>
</dependency>

<!-- 和主程序引入同样的spring-brick，不过这里需要设置为provided -->
<dependency>
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick</artifactId>
    <version>3.1.1</version>
    <scope>provided</scope>
</dependency>

  • 业务级依赖

    <!-- spring-boot-starter依赖 -->
<!--建议将spring-boot-starter依赖放到第一个位置, 以防止出现依赖冲突导致无法启动插件-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.6.13</version>
</dependency>

<!-- spring-boot-starter-web依赖. 当插件需要独立启动时，需要引入此插件。但是当要打包成插件前，需要去除此依赖（因为主程序中已经存在此依赖了） -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.6.13</version>
    <scope>test</scope>
</dependency>
        
...... 其他依赖
第二步：修改程序入口方法

更多详见here

import com.gitee.starblues.bootstrap.SpringPluginBootstrap;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * plugin start class
 */
@SpringBootApplication
public class PluginXyzApplication extends SpringPluginBootstrap {
    public static void main(String[] args) {
        new PluginXyzApplication().run(args);
    }
}
第三步：设置maven插件

更多详见here

<!-- 本人引入此插件后，去除了spring-boot自身的打包插件 -->
<plugin>
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick-maven-packager</artifactId>
    <version>3.1.1</version>
    <configuration>
        <!--当前打包模式为: 开发模式-->
        <mode>prod</mode>
        <!--插件信息定义-->
        <pluginInfo>
            <!--插件id-->
            <id>plugin-xyz</id>
            <!--插件入口类, 定义说明见: 定义插件入口类-->
            <bootstrapClass>com.example.springbrick.plugin.xyz.PluginXyzApplication</bootstrapClass>
            <!--插件版本号-->
            <version>1.0.0</version>
        </pluginInfo>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
</plugin>

4. 测试验证

提示：本人这里进行简单验证说明，更多验证可以去文末下载源码，自己跑起来后完成验证

  • 第一步：打包所有插件实现，然后放到主程序配置文件中（plugin.pluginPath）指定的插件位置
    在这里插入图片描述

  • 第二步：启动主程序

      .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::               (v2.6.13)

2023-06-07 15:27:55.223  INFO 20520 --- [       Thread-0] c.g.s.l.launcher.SpringMainBootstrap     : Starting SpringMainBootstrap using Java 17.0.3.1 on WIN-E500OMQS07D with PID 20520 (D:\maven\repository\com\gitee\starblues\spring-brick-loader\3.1.1\spring-brick-loader-3.1.1.jar started by Administrator in D:\working\demo)
2023-06-07 15:27:55.224  INFO 20520 --- [       Thread-0] c.g.s.l.launcher.SpringMainBootstrap     : No active profile set, falling back to 1 default profile: "default"
2023-06-07 15:27:55.430  INFO 20520 --- [       Thread-0] c.i.c.aop.ParameterRecorderRegistrar     : registry spring-bean parameterRecorder with ConstructorArg includePrefixes -> [], excludePrefixes -> [], parameterHandleMode -> USE_JSON, pretty -> true, ignoreParamTypes -> []
2023-06-07 15:27:55.902  INFO 20520 --- [       Thread-0] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2023-06-07 15:27:55.909  INFO 20520 --- [       Thread-0] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-06-07 15:27:55.909  INFO 20520 --- [       Thread-0] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.68]
2023-06-07 15:27:55.990  INFO 20520 --- [       Thread-0] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-06-07 15:27:55.990  INFO 20520 --- [       Thread-0] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 737 ms
2023-06-07 15:27:56.246  INFO 20520 --- [       Thread-0] c.i.commonspring.aop.ParameterRecorder   : Set LocalVariableTableParameterNameDiscoverer as parameterNameDiscoverer.
2023-06-07 15:27:56.358  INFO 20520 --- [       Thread-0] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-06-07 15:27:56.364  INFO 20520 --- [       Thread-0] c.g.s.l.launcher.SpringMainBootstrap     : Started SpringMainBootstrap in 1.377 seconds (JVM running for 1.736)
2023-06-07 15:27:56.367  INFO 20520 --- [       Thread-0] c.g.s.i.operator.DefaultPluginOperator   : 插件加载环境: prod
2023-06-07 15:27:56.367  INFO 20520 --- [       Thread-0] c.g.s.i.operator.DefaultPluginOperator   : 插件加载模式: isolation
2023-06-07 15:27:56.367  INFO 20520 --- [       Thread-0] c.g.s.i.operator.DefaultPluginOperator   : 开始加载插件, 插件根路径为: 
C:/Users/Administrator/Desktop/plugin
2023-06-07 15:27:56.367  INFO 20520 --- [       Thread-0] c.g.s.s.web.PluginStaticResourceConfig   : 插件静态资源访问前缀配置为: /static-plugin/{pluginId}
2023-06-07 15:27:56.382  INFO 20520 --- [       Thread-0] c.g.starblues.core.DefaultPluginManager  : 插件[plugin-qwer@1.0.0]加载成功
2023-06-07 15:27:56.383  INFO 20520 --- [       Thread-0] c.g.starblues.core.DefaultPluginManager  : 插件[plugin-qwer2@1.0.0]加载成功
2023-06-07 15:27:56.384  INFO 20520 --- [       Thread-0] c.g.starblues.core.DefaultPluginManager  : 插件[plugin-xyz@1.0.0]加载成功
2023-06-07 15:27:57.446  INFO 20520 --- [       Thread-0] c.g.s.b.ConfigurePluginEnvironment       : Plugin[plugin-qwer@1.0.0]  No active profile set, falling back to default profiles : default
2023-06-07 15:27:57.785  INFO 20520 --- [       Thread-0] c.g.starblues.core.DefaultPluginManager  : 插件[plugin-qwer@1.0.0]启动成功
2023-06-07 15:27:58.690  INFO 20520 --- [       Thread-0] c.g.s.b.ConfigurePluginEnvironment       : Plugin[plugin-qwer2@1.0.0]  No active profile set, falling back to default profiles : default
2023-06-07 15:27:59.033  INFO 20520 --- [       Thread-0] c.g.starblues.core.DefaultPluginManager  : 插件[plugin-qwer2@1.0.0]启动成功
2023-06-07 15:27:59.938  INFO 20520 --- [       Thread-0] c.g.s.b.ConfigurePluginEnvironment       : Plugin[plugin-xyz@1.0.0]  No active profile set, falling back to default profiles : default
2023-06-07 15:28:00.233  INFO 20520 --- [       Thread-0] c.g.starblues.core.DefaultPluginManager  : 插件[plugin-xyz@1.0.0]启动成功
2023-06-07 15:28:00.234  INFO 20520 --- [       Thread-0] c.g.s.i.operator.DefaultPluginOperator   : 插件初始化完成

  • 访问测试类，观察控制台输出

    • 测试类长这样，访问localhost:8080/demo/hello-world接口即可

      提示：完整项目demo可去文末下载

      import com.example.springbrick.application.helper.DynamicClass;
import com.example.springbrick.application.plugin.api.qwer.QwerService;
import com.example.springbrick.application.plugin.api.xyz.XyzService;
import com.example.springbrick.application.plugin.api.xyz.entity.IdInfo;
import com.example.springbrick.application.plugin.api.xyz.entity.User;
import com.gitee.starblues.integration.user.PluginUser;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.time.LocalDateTime;
import java.util.Map;

/**
 * 动态插件支持
 */
@RestController
@RequestMapping("/demo")
public class DemoController {
    
    @Resource
    private PluginUser pluginUser;
    
    @GetMapping("hello-world")
    public void helloWorld() {
        User user = new User();
        user.setName("张三");
        user.setBirthday(LocalDateTime.now());
        IdInfo idInfo = new IdInfo();
        idInfo.setIdNumber("12345");
        idInfo.setExt("non");
        user.setIdInfo(idInfo);
        
        /* ------------------------------ 示例1 ------------------------------ */
        QwerService qwerService = pluginUser.getBeanByInterface("plugin-qwer", QwerService.class).get(0);
        System.err.println(qwerService.helloWorld());
        System.err.println(qwerService.helloWorld123("sdfsd"));
    
        XyzService xyzService = pluginUser.getBeanByInterface("plugin-xyz", XyzService.class).get(0);
        xyzService.helloWorld();
        System.err.println(xyzService.userInfo(user));
    
    
        System.err.println();
        System.err.println();
        
        /* ------------------------------ 示例2 ------------------------------ */
        Map<String, Object> pluginBean = pluginUser.getBean(QwerService.BEAN_NAME, false).getPluginBean();
        pluginBean.forEach((pluginId, springBean) -> {
            System.err.println(pluginId + "      " + DynamicClass.exec(springBean, QwerService::helloWorld));
            System.err.println(pluginId + "      " + DynamicClass.exec(springBean, QwerService.EMPTY_INSTANCE::helloWorld123, "123"));
        });

        pluginBean = pluginUser.getBean(XyzService.BEAN_NAME, false).getPluginBean();
        pluginBean.forEach((pluginId, springBean) -> {
            DynamicClass.exec(springBean, XyzService::helloWorld);
            System.err.println(pluginId + "      " + DynamicClass.exec(springBean, XyzService.EMPTY_INSTANCE::userInfo, user));
        });
    }
}

    • 控制台输出

      在这里插入图片描述

相关资料

justry_deng
关注
  • 3
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 8
    评论
插件：基于Spring Boot引用Spring-Brick插件框架进行插件开发
GIS摆渡人
04-06 2011
文章目录一.背景二.介绍三.特性四.快速入门1.运行环境2.主程序配置集成2.1引入框架依赖2.2在配置文件加入配置2.3改造 Spring-Boot 启动类2.4打包主程序3.插件配置集成3.1引入依赖3.2定义插件引导类3.3配置Maven打包插件3.4新增 Controller 接口3.5编译插件4.启动测试五.项目推荐目录1.生产环境建议目录2.开发环境建议目录其他1.参考: 一.背景 在当下后端市场，还是以spring-boot为核心框架进行系统开发，本框架可以在spring-boot系统上进行插
Spring-Boot插件式开发框架，为动态扩展系统而生的插件开发框架
06-01
为动态扩展系统而生的插件开发框架。它在SpringBoot基础上可以快速开发出插件，并对插件提供不同打包方式，在不重启主程序的情况下，可以动态部署、更新插件，达到动态插拔的效果
「SpringBrick快速入门指南」：一款基于Spring Boot的高级插件化开发框架
令狐_JackieHao的博客
03-15 1518
SpringBrick是后端领域比较小众的框架技术，工作中遇到了，所以分享一下自己的研究、分享一下自己的教程demo
Spring IOC架构介绍与源码分析(含插件开发)
06-12
本课程通过UML结合源码进行全局的剖析了Spring_IOC容器的核心原理，以及插件的开发方法，以及插件实例(介绍SpingBoot和Spring定时器扩展原理)。通过本课程的学习您将对Spring_IOC整体架构有清晰的了解，知道5大核心组件接口，以及5大扩展接口。
Brick Next Developer Tools-crx插件
04-02
语言:English (United States) Adds Brick Next debugging tools to the Chrome Developer Tools.Brick Next Developer Tools is a Chrome DevTools extension for Brick Next.Brick Next is a web-frontend framework building on top of web components, developed by UWinTech China (优维科技), also known as EasyOps.This extension allows developers to inspect the framework rendering tree which consists of custom elements, including their customized properties and events. And it also allows developers to monitor specifi
spring-brick 插件开发问题整理
qq_34410726的博客
08-26 2311
spring-brick
spring-brick插件开发记录
qq_34410726的博客
08-28 2245
spring-brick插件开发记录
Springboot集成Springbrick实现动态插件的步骤详解
weixin_42023748的博客
02-26 973
在plugin-api中，定义各种接口、及相关的pojo，这些接口由具体的插件实现去完成，主应用（application）面向plugin-api编程即可。主应用（application）、各个插件的实现（plugin-qwer、plugin-qwer2、plugin-xyz）均可单独启动。主应用（application）启动后，可动态插拔各插件（plugin-qwer、plugin-qwer2、plugin-xyz）各plugin-api的实现程序，继承不继承父类plugin-api都可以。
【JAVA高级学习】SpringMVC【2】
weixin_39009248的博客
04-27 193
附加-js复习：实现动态绑定 1.数据库查询菜单项，浏览器展示效果如下： 1.1 鼠标置于"系统设置"/“销售管理”上是出现“小手”鼠标，点击时，子菜单隐藏 2.jsp中实现为： <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <!DOCTYPE html> <html> <head> <meta charse
Spring Boot如何实现自定义Spring Boot插件？
it_xushixiong的博客
05-31 1637
Spring Boot 插件是一种扩展机制，它提供了一种简单的方式来扩展 Spring Boot 的功能。插件可以添加一些自定义的配置和功能，例如自定义的命令行参数、自定义的 HTTP 端点等。插件描述文件（Plugin Descriptor）：用于描述插件的基本信息，包括插件的名称、版本、依赖关系等；插件执行器（Plugin Executor）：用于执行插件的逻辑；插件配置（Plugin Configuration）：用于配置插件的参数。
Brick-Breakout-game:带JavaScript的Brick Breakout游戏
04-29
破砖游戏 现在播放 玩此游戏-https: 发展 使用基本javascript和CSS开发的Brick Breakout游戏。 规则 游戏为用户提供3条生命，其动机是打破所有障碍。 可以在使用键盘箭头键控制的球拍的帮助下将球拍打。 愿你赢得这场比赛！ 开发玩！！
Brick 2048-crx插件
04-05
语言:English,lietuvių brick 2048特点：•分数排名系统•简单而易于游戏•声音效果 brick 2048功能： •分数排名系统 •简单而易于游戏 •声音效果
Brick Hill Trade-crx插件
04-04
语言:English 交易更好。 Chrome浏览器对Brick-Hill交易网站Brick-Hill.Trade的扩展。 该扩展程序向brick-hill.com添加了与交易相关的功能，但不是Brick-Hill制作的。 特点：-从Brick-Hill.Trade上Brick-Hill上查看用户/信息。 -单击以查看Brick-Hill.Trade上的用户/物品。 -查看交易时在市场上发布A / D线程。 -计算入境交易的价值。 -立即下降交易。 只需单击一个按钮即可完成所有操作。 此扩展程序不启用项目通知程序。 您可以通过加入Discord服务器（https://discord.gg/nv3UWWC）来启用项目通知程序。
brick-browser:Brick 浏览器实现
07-13
砖块浏览器 浏览器实现 安装 $ npm install brick-browser
dino-brick：恐龙游戏，终端版
02-04
dino-brick：恐龙游戏，终端版
基于 Java 实现的宠物医院在线挂号系统
05-02
基于 Java 实现的宠物医院在线挂号系统 基于 Java 实现的宠物医院在线挂号系统
天津欢乐谷官方网站html5响应式触屏版手机wap旅游网站模板.zip
最新发布
05-02
触屏版自适应手机wap软件网站模板 触屏版自适应手机wap软件网站模板
基于matlab实现的混沌扰动算法来解决pso算法早熟问题，并用二者结合来训练灰色预测模型参数.rar
05-02
基于matlab实现的混沌扰动算法来解决pso算法早熟问题，并用二者结合来训练灰色预测模型参数.rar
spring-brick
12-07
Spring-brick是一种创意的设计结构，它结合了春天和砖块这两个元素。春天代表了新生和希望，而砖块代表着稳固和坚实。Spring-brick的概念是将这两种元素融合在一起创造出一种独特的建筑材料。 这种建筑材料具有很多优点。首先，Spring-brick的设计结构使其在承重方面非常可靠。砖块的坚固性保证了材料的耐用性和稳定性，使得建筑物能够经受住各种天气和环境的考验。其次，春天的元素使Spring-brick具有一种轻盈和活力的感觉。这种设计能够为建筑物带来一种生机和活力，使其融入周围的环境中。 Spring-brick在建筑设计中有着广泛的应用。与传统的砖块相比，Spring-brick的设计结构更加具有创意和独特性，可以为建筑物带来独特的外观和个性化的风格。同时，Spring-brick还具有很高的适用性和可塑性。它可以用于建造各种类型的建筑，包括住宅、商业建筑和公共设施等。 此外，Spring-brick还具有环保和可持续发展的特点。砖块作为一种天然材料，可以循环利用并减少对环境的负面影响。春天的元素也使Spring-brick更加与自然环境融合，并通过绿色建筑的概念，促进可持续发展。 总的来说，Spring-brick是一种创意而实用的建筑材料，其独特的设计结构结合了春天和砖块的元素，使建筑物具有稳固性和轻盈感。它的应用广泛，并符合环保和可持续发展的原则。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 8
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值