Springboot集成Springbrick實(shí)現(xiàn)動(dòng)態(tài)插件的步驟詳解
更新時(shí)間：2023年06月08日 12:03:38 作者：justry_deng
這篇文章主要介紹了Springboot集成Springbrick實(shí)現(xiàn)動(dòng)態(tài)插件的詳細(xì)過(guò)程，文中的流程通過(guò)代碼示例介紹的非常詳細(xì)，感興趣的同學(xué)可以參考一下
spring-boot集成spring-brick實(shí)現(xiàn)動(dòng)態(tài)插件
項(xiàng)目結(jié)構(gòu) & 需求實(shí)現(xiàn)
提示：本文的集成說(shuō)明，是針對(duì)完成此設(shè)計(jì)、此需求進(jìn)行的
項(xiàng)目結(jié)構(gòu)
demo
│
├─application # 主應(yīng)用
│
└─plugin-api
│
├─plugin-qwer # plugin-qwer-api的實(shí)現(xiàn)示例1（注：也可以是單獨(dú)的一個(gè)項(xiàng)目，繼承不繼承plugin-api均可）
│
├─plugin-qwer2 # plugin-qwer-api的實(shí)現(xiàn)示例2（注：也可以是單獨(dú)的一個(gè)項(xiàng)目，繼承不繼承plugin-api均可）
│
├─plugin-qwer-api # 插件qwer-api
│
├─plugin-xyz # plugin-xyz-api的實(shí)現(xiàn)示例（注：也可以是單獨(dú)的一個(gè)項(xiàng)目，繼承不繼承plugin-api均可）
│
└─plugin-xyz-api # 插件xyz-api
需求實(shí)現(xiàn)
主應(yīng)用（application）、各個(gè)插件的實(shí)現(xiàn)（plugin-qwer、plugin-qwer2、plugin-xyz）均可單獨(dú)啟動(dòng)
主應(yīng)用（application）啟動(dòng)后，可動(dòng)態(tài)插拔各插件（plugin-qwer、plugin-qwer2、plugin-xyz）
在plugin-api中，定義各種接口、及相關(guān)的pojo，這些接口由具體的插件實(shí)現(xiàn)去完成，主應(yīng)用（application）面向plugin-api編程即可
spring-boot集成spring-brick
環(huán)境說(shuō)明
- spring-boot：2.6.13
- spring-brick：3.1.1
1. 主程序集成spring-brick
第一步：引入相關(guān)依賴(lài)
<dependency>
<groupId>com.gitee.starblues</groupId>
<artifactId>spring-brick</artifactId>
<version>3.1.1</version>
</dependency>第二步：修改程序入口方法
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 引導(dǎo)啟動(dòng)
SpringMainBootstrap.launch(MainApplication.class, args);
}
@Override
public void run(String[] args) throws Exception {
// 這里的寫(xiě)法和SpringBoot 啟動(dòng)保持一致
SpringApplication.run(MainApplication.class, args);
}
}第三步：編寫(xiě)配置
plugin:
# 運(yùn)行模式, 開(kāi)發(fā)環(huán)境: dev; 生產(chǎn)環(huán)境: prod
runMode: prod
# 主程序包名, 包名建議設(shè)置到范圍最大級(jí)別，能包含主程序所有類(lèi)的包名范圍
mainPackage: com.example.springbrick.application
# 插件的路徑, 可配置多個(gè), 開(kāi)發(fā)環(huán)境下配置為插件模塊上級(jí)目錄; 生產(chǎn)環(huán)境下配置到插件jar包存放目錄。
# 可使用~符號(hào)表示相對(duì)目錄，比如：~/plugins，開(kāi)發(fā)環(huán)境相對(duì)于開(kāi)發(fā)根目錄，生產(chǎn)環(huán)境下相對(duì)于主程序jar所在目錄
pluginPath:
- C:/Users/Administrator/Desktop/plugin第四步：設(shè)置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. 準(zhǔn)備plugin-api
第一步：引入相關(guān)依賴(lài)
<dependency>
<groupId>com.gitee.starblues</groupId>
<artifactId>spring-brick</artifactId>
<version>3.1.1</version>
<!-- 這里指定為provided即可，主程序中已經(jīng)存在此artifact了 -->
<scope>provided</scope>
</dependency>第二步：引入相關(guān)依賴(lài)
注意：各plugin-api的包名，應(yīng)該處于主程序包名（本人這里為plugin.mainPackage=com.example.springbrick.application）的子集。如果不這樣設(shè)置的話(huà)，主程序和插件實(shí)現(xiàn)程序加載plugin-api中的類(lèi)時(shí)，將被類(lèi)加載器隔離
根據(jù)自己業(yè)務(wù)需要，定義業(yè)務(wù)接口及相關(guān)pojo即可，如：
3. 實(shí)現(xiàn)plugin-api
提示：各plugin-api的實(shí)現(xiàn)程序，繼承不繼承父類(lèi)plugin-api都可以
第一步：引入相關(guān)依賴(lài)
- 架構(gòu)級(jí)依賴(lài)
<!-- 引入要實(shí)現(xiàn)的plugin-api -->
<dependency>
<groupId>com.example</groupId>
<artifactId>plugin-xyz-api</artifactId>
<version>1.0.0</version>
</dependency>
<!-- 引入spring-brick-bootstrap以完成插件的引導(dǎo) -->
<dependency>
<groupId>com.gitee.starblues</groupId>
<artifactId>spring-brick-bootstrap</artifactId>
<version>3.1.1</version>
</dependency>
<!-- 和主程序引入同樣的spring-brick，不過(guò)這里需要設(shè)置為provided -->
<dependency>
<groupId>com.gitee.starblues</groupId>
<artifactId>spring-brick</artifactId>
<version>3.1.1</version>
<scope>provided</scope>
</dependency>- 業(yè)務(wù)級(jí)依賴(lài)
<!-- spring-boot-starter依賴(lài) -->
<!--建議將spring-boot-starter依賴(lài)放到第一個(gè)位置, 以防止出現(xiàn)依賴(lài)沖突導(dǎo)致無(wú)法啟動(dòng)插件-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<version>2.6.13</version>
</dependency>
<!-- spring-boot-starter-web依賴(lài). 當(dāng)插件需要獨(dú)立啟動(dòng)時(shí)，需要引入此插件。但是當(dāng)要打包成插件前，需要去除此依賴(lài)（因?yàn)橹鞒绦蛑幸呀?jīng)存在此依賴(lài)了） -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.6.13</version>
<scope>test</scope>
</dependency>第二步：修改程序入口方法
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);
}
}第三步：設(shè)置maven插件
<!-- 本人引入此插件后，去除了spring-boot自身的打包插件 -->
<plugin>
<groupId>com.gitee.starblues</groupId>
<artifactId>spring-brick-maven-packager</artifactId>
<version>3.1.1</version>
<configuration>
<!--當(dāng)前打包模式為: 開(kāi)發(fā)模式-->
<mode>prod</mode>
<!--插件信息定義-->
<pluginInfo>
<!--插件id-->
<id>plugin-xyz</id>
<!--插件入口類(lèi), 定義說(shuō)明見(jiàn): 定義插件入口類(lèi)-->
<bootstrapClass>com.example.springbrick.plugin.xyz.PluginXyzApplication</bootstrapClass>
<!--插件版本號(hào)-->
<version>1.0.0</version>
</pluginInfo>
</configuration>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>4. 測(cè)試驗(yàn)證
提示：本人這里進(jìn)行簡(jiǎn)單驗(yàn)證說(shuō)明，更多驗(yàn)證可以去文末下載源碼，自己跑起來(lái)后完成驗(yàn)證
- 第一步：打包所有插件實(shí)現(xiàn)，然后放到主程序配置文件中（
plugin.pluginPath）指定的插件位置
- 第二步：?jiǎn)?dòng)主程序
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: 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 : 插件加載環(huán)境: 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 : 開(kāi)始加載插件, 插件根路徑為:
C:/Users/Administrator/Desktop/plugin
2023-06-07 15:27:56.367 INFO 20520 --- [ Thread-0] c.g.s.s.web.PluginStaticResourceConfig : 插件靜態(tài)資源訪(fǎng)問(wèn)前綴配置為: /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]啟動(dòng)成功
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]啟動(dòng)成功
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]啟動(dòng)成功
2023-06-07 15:28:00.234 INFO 20520 --- [ Thread-0] c.g.s.i.operator.DefaultPluginOperator : 插件初始化完成訪(fǎng)問(wèn)測(cè)試類(lèi)，觀察控制臺(tái)輸出
測(cè)試類(lèi)長(zhǎng)這樣，訪(fǎng)問(wèn)
localhost:8080/demo/hello-world接口即可
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;
/**
* 動(dòng)態(tài)插件支持
*/
@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));
});
}
}- 控制臺(tái)輸出
以上就是Springboot集成Springbrick實(shí)現(xiàn)動(dòng)態(tài)插件的步驟詳解的詳細(xì)內(nèi)容，更多關(guān)于Springboot集成Springbrick 動(dòng)態(tài)插件的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Java正則表達(dá)式,提取雙引號(hào)中間的部分方法
今天小編就為大家分享一篇Java正則表達(dá)式,提取雙引號(hào)中間的部分方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-07-07
這篇文章主要介紹了SpringBoot中的@Value注解用法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
Java案例之隨機(jī)驗(yàn)證碼功能實(shí)現(xiàn)實(shí)例
本篇文章主要介紹了Java案例之隨機(jī)驗(yàn)證碼功能實(shí)現(xiàn)實(shí)例，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-06-06
SpringCloud maven-assembly-plugin 多級(jí)目錄打包的實(shí)現(xiàn)
本文主要介紹了SpringCloud maven-assembly-plugin 多級(jí)目錄打包的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-10-10
Java 確保某個(gè)Bean類(lèi)被最后執(zhí)行的幾種實(shí)現(xiàn)方式
這篇文章主要介紹了Java 確保某個(gè)BeanDefinitionRegistryPostProcessor Bean被最后執(zhí)行的幾種實(shí)現(xiàn)方式，幫助大家更好的理解和學(xué)習(xí)使用Java，感興趣的朋友可以了解下2021-03-03
Java實(shí)現(xiàn)Excel導(dǎo)入導(dǎo)出數(shù)據(jù)庫(kù)的方法示例
這篇文章主要介紹了Java實(shí)現(xiàn)Excel導(dǎo)入導(dǎo)出數(shù)據(jù)庫(kù)的方法,結(jié)合實(shí)例形式分析了java針對(duì)Excel的讀寫(xiě)及數(shù)據(jù)庫(kù)操作相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2017-08-08
在軟件開(kāi)發(fā)過(guò)程中，經(jīng)常需要生成Excel文件來(lái)導(dǎo)出數(shù)據(jù)或者生成報(bào)表，為了簡(jiǎn)化開(kāi)發(fā)流程和提高代碼的可維護(hù)性，我們可以使用Spring Boot封裝Excel生成器，本文將介紹如何使用Spring Boot封裝Excel生成器，并提供一些示例代碼來(lái)說(shuō)明其用法和功能2023-06-06
javaweb Servlet開(kāi)發(fā)總結(jié)（一）
Servlet是sun公司提供的一門(mén)用于開(kāi)發(fā)動(dòng)態(tài)web資源的技術(shù)。這篇文章主要介紹了javaweb Servlet開(kāi)發(fā)的第一篇，感興趣的小伙伴們可以參考一下2016-05-05
springmvc path請(qǐng)求映射到bean 方法的流程
這篇文章主要介紹了springmvc path請(qǐng)求映射到bean 方法的流程,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-07-07
Android仿微信實(shí)現(xiàn)左滑顯示刪除按鈕功能
這篇文章主要為大家詳細(xì)介紹了java仿微信實(shí)現(xiàn)左滑顯示刪除按鈕功能，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-10-10