「SpringBrick快速入门指南」：一款基于Spring Boot的高级插件化开发框架

文章目录

    • 关于 | About
      • 技术文档 | Document
      • 开源项目 | Project
    • 案例 | Demo
      • 项目结构 | Structure
      • 主程序配置集成 | Settings
        • 引入框架依赖 | Framework
        • 在配置文件加入配置 | Yaml
        • SpringBoot启动类改引导类 | Change
      • 插件配置集成 | Settings
        • 引入依赖 | XML
        • 定义插件引导类 | Class
        • 配置Maven打包插件 | Maven
      • 新增Controller接口API | API
      • 编译打包插件 | JAR
      • 启动测试 | Main
    • Demo案例Git地址 | Gitee

工作项目中用到了这款插件式开发框架，看了一下网上教程不多，所以打算为大家普及一下这个技术框架，写一些入门教程方便大家学习运用。

关于 | About

“Spring-brick”，是一个可以动态扩展系统的框架，最早在2019年开始开发，该框架可以在SpringBoot项目上开发插件功能，开发插件就像开发独立应用一样。

这里的插件我们可以理解成一个独立的SpringBoot应用，微服务等单体项目。

技术文档 | Document

文档如下：https://www.yuque.com/starblues/spring-brick-3.0.0image-20240315154413130

开源项目 | Project

开源项目：https://gitee.com/starblues/springboot-plugin-framework-parent.git

image-20240315154511290

这个框架除了官方介绍的优点之外，也有它的不足之处，后文我会提出来。

该框架可以在spring-boot项目上开发出插件功能，在插件中可以和spring-boot使用方式一模一样。使用了本框架您可以实现如下需求：

  • 在插件中，您可以当成一个微型的spring-boot项目来开发，简单易用。
  • 在插件中扩展出系统各种功能点，用于系统灵活扩展，再也不用使用分支来交付不同需求的项目了。
  • 在插件中可以集成各种框架及其各种spring-boot-xxx-starter。
  • 在插件中可以定义独立依赖包了，再也不用在主程序中定义依赖包了。
  • 可以完美解决插件包与插件包、插件包与主程序因为同一框架的不同版本冲突问题了。各个插件可以定义同一依赖的不同版本框架。
  • 无需重启主程序，可以自由实现插件包的动态安装部署，来动态扩展系统的功能。
  • 插件也可以不依赖主程序独立集成微服务模块。
  • 您可以丰富想象该框架给您带来哪些迫切的需求和扩展，以实现系统的低耦合、高内聚、可扩展的优点。

案例 | Demo

本次演示一个入门小案例，让我带大家快速进入这个框架，上手使用它。这个案例是我自己写的一个便于大家快速入门的案例，不容易出现错误，清晰明了的入门教程。

项目结构 | Structure

项目名称： springboot-plugin-framework-example-linghu

├─example-main
│  │  pom.xml
│  │  
│  ├─src
│  │  ├─main
│  │  │  ├─java
│  │  │  │  └─com
│  │  │  │      └─linghu
│  │  │  │              MainApp.java
│  │  │  │              
│  │  │  └─resources
│  │  │          application.yml
│     
└─example-plugins-basic│  pom.xml│  ├─src│  ├─main│  │  ├─java│  │  │  └─com│  │  │      └─linghu│  │  │          ├─controller│  │  │          │      ExampleController.java│  │  │          │      ExamplePlugin.java│  │  │          │      │  │  │          └─plugin│  │  └─resources│  │          application.yml

这个项目分为两个部分：

  • 主程序-example-main
  • 插件程序-example-plugins-basic

我们的目的是运行主程序，然后执行插件程序里的业务，这样我们就可以专注开发插件程序了，可以不断根据业务的不同接入不同的插件程序，而不用去动主程序的代码，这就是我们说的 高内聚、低耦合、可扩展。

分好类以后我们开始接下来的具体工作。

我们的工作分为两个部分：

  • 主程序配置集成 | Settings
  • 插件配置集成 | Settings

主程序配置集成 | Settings

我们说了主程序实际上就是上面 example-main部分。

引入框架依赖 | Framework

引入框架依赖：

<dependency><groupId>com.gitee.starblues</groupId><artifactId>spring-brick</artifactId><version>3.1.0</version></dependency>

具体主程序的pom文件配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"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"><modelVersion>4.0.0</modelVersion><parent><groupId>com.linghu</groupId><artifactId>springboot-plugin-framework-example-linghu</artifactId><version>1.0-SNAPSHOT</version></parent><artifactId>example-main</artifactId><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><dependency><groupId>com.gitee.starblues</groupId><artifactId>spring-brick</artifactId><version>3.1.0</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency></dependencies>
</project>
在配置文件加入配置 | Yaml

这里的yaml文件配置主要是让将插件程序接入到主程序中

plugin:runMode: devmainPackage: com.linghupluginPath:
#    这里集成了一个插件程序example-plugins-basic模块- ~\example-plugins-basic

需要注意的是上面的 mainPackage表示主程序类的路径。pluginPath则是我们插件的相对路径地址。

- ~\example-plugins-basic中的 ~\表示相对路径地址； example-plugins-basic则是我们的插件名称。

完整的yml配置则是：

server:port: 8080plugin:runMode: devmainPackage: com.linghupluginPath:
#    这里集成了一个插件程序example-plugins-basic模块- ~\example-plugins-basic
spring:mvc:pathmatch:matching-strategy: ant_path_matcher
SpringBoot启动类改引导类 | Change

这个改动发生在主程序的启动类上

package com.linghu;import com.gitee.starblues.loader.launcher.SpringBootstrap;
import com.gitee.starblues.loader.launcher.SpringMainBootstrap;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;/*** @author linghu* @date ${DATE} ${TIME}*/
@SpringBootApplication
public class MainApp implements SpringBootstrap {public static void main(String[] args) {// 该处使用 SpringMainBootstrap 引导启动SpringMainBootstrap.launch(MainApp.class, args);}@Overridepublic void run(String[] args) throws Exception {// 在该实现方法中, 和 SpringBoot 使用方式一致SpringApplication.run(MainApp.class, args);}}

这里为啥要这么改？后续我会出文章解释，剖析源码。

插件配置集成 | Settings

插件程序主要是指：example-plugins-basic部分

引入依赖 | XML
<!-- spring-boot-starter依赖 -->
<!--建议将spring-boot-starter依赖放到第一个位置, 以防止出现依赖冲突导致无法启动插件-->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><version>${和主程序一致的springboot版本}</version>
</dependency><!-- spring-brick-bootstrap依赖 -->
<dependency><groupId>com.gitee.starblues</groupId><artifactId>spring-brick-bootstrap</artifactId><version>${latest.version}</version>
</dependency><!-- 主程序依赖 -->
<!-- 将主程序以 provided 方式依赖到插件中 -->
<dependency><groupId>主程序的 groupId</groupId><artifactId>主程序的 artifactId</artifactId><version>主程序 version</version><scope>provided</scope>
</dependency>

上面是个引入模版，大家引入以后还要进行修改，下面是我修改的我的完整依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"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"><modelVersion>4.0.0</modelVersion><parent><groupId>com.linghu</groupId><artifactId>springboot-plugin-framework-example-linghu</artifactId><version>1.0-SNAPSHOT</version></parent><artifactId>example-plugins-basic</artifactId><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><!--        =====================插件配置集成========================--><!-- spring-boot-starter依赖 --><!--建议将spring-boot-starter依赖放到第一个位置, 以防止出现依赖冲突导致无法启动插件--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><version>2.7.9</version></dependency><!--解决方案: 确保插件不包含spring-boot-starter-web依赖，而是让主程序来加载这个依赖。这样，主程序就可以管理所有的Spring Boot web依赖，避免了重复。如果您使用的是Maven，您可以在插件的pom.xml文件中移除对spring-boot-starter-web的依赖，或者如果您在主程序的pom.xml中已经定义了这个依赖，您可以在插件的pom.xml中添加<exclusions>元素来排除这个依赖。--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></exclusion></exclusions></dependency><!-- spring-brick-bootstrap依赖 --><dependency><groupId>com.gitee.starblues</groupId><artifactId>spring-brick-bootstrap</artifactId><version>3.1.0</version></dependency><!-- 主程序依赖 --><!-- 将主程序以 provided 方式依赖到插件中 --><dependency><groupId>com.linghu</groupId><artifactId>example-main</artifactId><version>1.0-SNAPSHOT</version><scope>provided</scope></dependency></dependencies><!--    =================插件打包的配置===================--><build><plugins><plugin><groupId>com.gitee.starblues</groupId><artifactId>spring-brick-maven-packager</artifactId><version>3.1.0</version><configuration><!--当前打包模式为: 开发模式--><mode>dev</mode><!--插件信息定义--><pluginInfo><!--插件id--><id>example-plugins-basic</id><!--插件入口类, 定义说明见: 定义插件入口类--><bootstrapClass>com.linghu.controller.ExamplePlugin</bootstrapClass><!--插件版本号--><version>1.0.0-SNAPSHOT</version></pluginInfo></configuration><executions><execution><goals><goal>repackage</goal></goals></execution></executions></plugin></plugins></build>
</project>
定义插件引导类 | Class

这个引导类是加在插件里的主类里的，不要搞错了。

package com.linghu.controller;import com.gitee.starblues.bootstrap.SpringPluginBootstrap;
import org.springframework.boot.autoconfigure.SpringBootApplication;/*** @author linghu* @date 2024/3/15 9:55*/
@SpringBootApplication
public class ExamplePlugin extends SpringPluginBootstrap {public static void main(String[] args) {new ExamplePlugin().run(args);}}

定义插件main入口类, 继承SpringPluginBootstrap类, 然后在main函数中实例化当前引导类，并执行run方法即可。

配置Maven打包插件 | Maven

其实这一步工作我已经在上面提到了，也就是在引入依赖部分提供了。

<!--    =================插件打包的配置===================--><build><plugins><plugin><groupId>com.gitee.starblues</groupId><artifactId>spring-brick-maven-packager</artifactId><version>3.1.0</version><configuration><!--当前打包模式为: 开发模式--><mode>dev</mode><!--插件信息定义--><pluginInfo><!--插件id--><id>example-plugins-basic</id><!--插件入口类, 定义说明见: 定义插件入口类--><bootstrapClass>com.linghu.controller.ExamplePlugin</bootstrapClass><!--插件版本号--><version>1.0.0-SNAPSHOT</version></pluginInfo></configuration><executions><execution><goals><goal>repackage</goal></goals></execution></executions></plugin></plugins></build>

新增Controller接口API | API

其实这个接口我们就加在插件程序里就行了

package com.linghu.controller;import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;/*** @author linghu* @date 2024/3/15 9:58*/@RestController
@RequestMapping("/example")
public class ExampleController {@GetMappingpublic String hello(){return "hello";}
}

注意一下Controller位置，放错了很容易导致后续Controller加载不到主程序的：

image-20240315163409936

编译打包插件 | JAR

这里打包有两种方法：

  • 插件使用maven命令：mvn clean package进行编译
  • 通过Maven插件、先点击clean、在点击package

我用的第二种方法打包，如图：

image-20240315163849557

打包完成以后，观察target文件下会出现jar包：

image-20240315163925679

启动测试 | Main

这个测试是直接启动主程序的

  • 启动主程序main, 日志中出现如下关键内容，说明集成插件成功

image-20240315164322248

image-20240315164443221

如上我们还知道了如下信息，那就是我们请求测试的接口地址为：

http://127.0.0.1:8080/plugins/example-plugins-basic/

打开浏览器，访问： http://127.0.0.1:8080/plugins/example-plugins-basic/example出现下图说明访问接口测试成功。

image-20240315164521738

Demo案例Git地址 | Gitee

这个教程属于入门级别的，没有对源码，原理展开讲解，后续有时间会接着更的，这里主要是教大家快速上手，遇到不懂的，欢迎评论区提出。

完整项目demo：

《SpringBrick-springboot-plugin-framework-example-linghu》

项目下载以后记得要用Maven插件打一下jar包，可以直接运行：

mvn clean package进行编译~

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/544442.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【计算机网络】https的工作原理以及和http的区别

【计算机网络】https的工作原理以及和http的区别

目录 前言 1. HTTP协议存在的问题 2. 什么是HTTPS协议&#xff1f; 3. HTTP和HTTPS有哪些区别&#xff1f; 4. HTTPS的工作原理 加密方式 前言 在日常的Web项目练习中&#xff0c;我们会发现老师会让我们在打开服务器之后使用 http://localhost/...进行项目效果测试和预览…
阅读更多...
Tuxera NTFS 2023安装使用教程 Tuxera NTFS破解版 Tuxera NTFS for Mac优惠

Tuxera NTFS 2023安装使用教程 Tuxera NTFS破解版 Tuxera NTFS for Mac优惠

对于必须在Windows电脑和Mac电脑之间来回切换的Mac朋友来说&#xff0c;跨平台不兼容一直是一个巨大的障碍&#xff0c;尤其是当我们需要使用NTFS格式的硬盘在Windows和macOS之间共享文件时。因为Mac默认不支持写入NTFS磁盘。 为了解决这一问题&#xff0c;很多朋友会选择很便捷…
阅读更多...
QML 布局管理器之ColumnLayout

QML 布局管理器之ColumnLayout

一.ColumnLayout讲解 QML中的ColumnLayout是一种布局元素&#xff0c;用于在垂直列中排列其子元素。它的主要使用下列附加属性: Layout.minimumWidth Layout.minimumHeight Layout.preferredWidth Layout.preferredHeight Layout.maximumWidth Layout.maximumHeight Layout.fil…
阅读更多...
MIT线性代数-方程组的几何解释

MIT线性代数-方程组的几何解释

文章目录 1. 二维空间1.1 行方向1.2 列方向 2. 三维空间2.1 行方向2.2 列方向 假设有一个方程组 A X B AXB AXB表示如下 2 x − y 0 (1) 2x-y0\tag{1} 2x−y0(1) − x 2 y 3 (2) -x2y3\tag{2} −x2y3(2) 矩阵表示如下&#xff1a; [ 2 − 1 − 1 2 ] [ x y ] [ 0 3 ] (3)…
阅读更多...
Mr-Robot1靶场练习靶场推荐小白入门练习靶场渗透靶场bp爆破wordpress

Mr-Robot1靶场练习靶场推荐小白入门练习靶场渗透靶场bp爆破wordpress

下载链接&#xff1a; Mr-Robot: 1 ~ VulnHub 安装&#xff1a; 打开vxbox&#xff0c;菜单栏----管理----导入虚拟电脑 选择下载完的ova文件&#xff0c;并修改想要保存的位置&#xff08;也可以保持默认位置&#xff09; 导入完成后可以根据自己的情况去配置网络链接方式 完成…
阅读更多...
HttpServer整合模块设计与实现(http模块五)

HttpServer整合模块设计与实现(http模块五)

目录 类功能 类定义 类实现 编译测试 源码路标 类功能 类定义 // HttpServer模块功能设计 class HttpServer { private:using Handler std::function<void(const HttpRequest &, HttpResponse &)>;std::unordered_map<std::string, Handler> _get_r…
阅读更多...
微信小程序开发学习笔记——3.11完成form评论案例的实现逻辑

微信小程序开发学习笔记——3.11完成form评论案例的实现逻辑

>>跟着b站up主“咸虾米_”学习微信小程序开发中&#xff0c;把学习记录存到这方便后续查找。 课程连接&#xff1a;https://www.bilibili.com/video/BV19G4y1K74d?p25&vd_source9b149469177ab5fdc47515e14cf3cf74 一、javascript参考手册——splice https://www.…
阅读更多...
2024年新算法：基于鹦鹉优化器PO的城市三维无人机路径规划（复杂地形三维航迹路径规划）

2024年新算法：基于鹦鹉优化器PO的城市三维无人机路径规划（复杂地形三维航迹路径规划）

摘要&#xff1a;本文提出了一种利用鹦鹉优化器&#xff08;Parrot optimizer&#xff0c;PO&#xff09;来解决城市环境下无人机三维路径规划问题的方法。这种方法将复杂的无人机航迹规划任务转化为一个优化问题&#xff0c;然后运用鹦鹉优化器PO来解决这个优化问题。鹦鹉优化…
阅读更多...
HCIP—BGP邻居关系建立实验

HCIP—BGP邻居关系建立实验

BGP的邻居称为&#xff1a;IBGP对等体 EBGP对等体 1.EBGP对等体关系&#xff1a; 位于 不同自治系统 的BGP路由器之间的BGP对等体关系 EBGP对等体一般使用 直连建立 对等体关系&#xff0c;EBGP邻居之间的报文 TTL中值设置为1 两台路由器之间建立EBGP对等体关系&#xff0…
阅读更多...
Golang实现Redis分布式锁（Lua脚本+可重入+自动续期）

Golang实现Redis分布式锁（Lua脚本+可重入+自动续期）

Golang实现Redis分布式锁&#xff08;Lua脚本可重入自动续期&#xff09; 1 概念 应用场景 Golang自带的Lock锁单机版OK&#xff08;存储在程序的内存中&#xff09;&#xff0c;分布式不行 分布式锁&#xff1a; 简单版&#xff1a;redis setnx》加锁设置过期时间需要保证原…
阅读更多...
鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：Stack）

鸿蒙Harmony应用开发—ArkTS声明式开发（容器组件：Stack）

堆叠容器&#xff0c;子组件按照顺序依次入栈&#xff0c;后一个子组件覆盖前一个子组件。 说明&#xff1a; 该组件从API Version 7开始支持。后续版本如有新增内容&#xff0c;则采用上角标单独标记该内容的起始版本。 子组件 可以包含子组件。 接口 Stack(value?: { ali…
阅读更多...
知名Web3投资基金a16z合伙人Jane Lippencott确认出席Hack.Summit() 2024区块链开发者大会

知名Web3投资基金a16z合伙人Jane Lippencott确认出席Hack.Summit() 2024区块链开发者大会

在区块链技术的风起云涌和Web3生态的蓬勃发展中&#xff0c;知名a16z Crypto的合伙人Jane Lippencott已确认出席即将于2024年4月9日至10日在香港数码港举行的Hack.Summit() 2024区块链开发者大会。作为亚洲首次举办的Hack.Summit()&#xff0c;此次大会将为全球区块链开发者及业…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023