Spring Boot熱加載jar實現(xiàn)動態(tài)插件的思路
一、背景
動態(tài)插件化編程是一件很酷的事情，能實現(xiàn)業(yè)務(wù)功能的 解耦 便于維護(hù)，另外也可以提升 可擴(kuò)展性 隨時可以在不停服務(wù)器的情況下擴(kuò)展功能，也具有非常好的 開放性 除了自己的研發(fā)人員可以開發(fā)功能之外，也能接納第三方開發(fā)商按照規(guī)范開發(fā)的插件。
常見的動態(tài)插件的實現(xiàn)方式有 SPI、OSGI 等方案，由于脫離了 Spring IOC 的管理在插件中無法注入主程序的 Bean 對象，例如主程序中已經(jīng)集成了 Redis 但是在插件中無法使用。
本文主要介紹在 Spring Boot 工程中熱加載 jar 包并注冊成為 Bean 對象的一種實現(xiàn)思路，在動態(tài)擴(kuò)展功能的同時支持在插件中注入主程序的 Bean 實現(xiàn)功能更強(qiáng)大的插件。
二、熱加載 jar 包
通過指定的鏈接或者路徑動態(tài)加載 jar 包，可以使用 URLClassLoader 的 addURL 方法來實現(xiàn)，樣例代碼如下：
ClassLoaderUtil 類
public class ClassLoaderUtil {
public static ClassLoader getClassLoader(String url) {
try {
Method method = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
if (!method.isAccessible()) {
method.setAccessible(true);
}
URLClassLoader classLoader = new URLClassLoader(new URL[]{}, ClassLoader.getSystemClassLoader());
method.invoke(classLoader, new URL(url));
return classLoader;
} catch (Exception e) {
log.error("getClassLoader-error", e);
return null;
}
}
}
其中在創(chuàng)建 URLClassLoader 時，指定當(dāng)前系統(tǒng)的 ClassLoader 為父類加載器 ClassLoader.getSystemClassLoader() 這步比較關(guān)鍵，用于打通主程序與插件之間的 ClassLoader ，解決把插件注冊進(jìn) IOC 時的各種 ClassNotFoundException 問題。
三、動態(tài)注冊 Bean
將插件 jar 中加載的實現(xiàn)類注冊到 Spring 的 IOC 中，同時也會將 IOC 中已有的 Bean 注入進(jìn)插件中；分別在程序啟動時和運行時兩種場景下的實現(xiàn)方式。
3.1. 啟動時注冊 Bean
使用 ImportBeanDefinitionRegistrar 實現(xiàn)在 Spring Boot 啟動時動態(tài)注冊插件的 Bean，樣例代碼如下：
PluginImportBeanDefinitionRegistrar 類
public class PluginImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
private final String targetUrl = "file:/D:/SpringBootPluginTest/plugins/plugin-impl-0.0.1-SNAPSHOT.jar";
private final String pluginClass = "com.plugin.impl.PluginImpl";
@SneakyThrows
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
ClassLoader classLoader = ClassLoaderUtil.getClassLoader(targetUrl);
Class<?> clazz = classLoader.loadClass(pluginClass);
BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
BeanDefinition beanDefinition = builder.getBeanDefinition();
registry.registerBeanDefinition(clazz.getName(), beanDefinition);
}
}
3.2. 運行時注冊 Bean
程序運行時動態(tài)注冊插件的 Bean 通過使用 ApplicationContext 對象來實現(xiàn)，樣例代碼如下：
@GetMapping("/reload")
public Object reload() throws ClassNotFoundException {
ClassLoader classLoader = ClassLoaderUtil.getClassLoader(targetUrl);
Class<?> clazz = classLoader.loadClass(pluginClass);
springUtil.registerBean(clazz.getName(), clazz);
PluginInterface plugin = (PluginInterface)springUtil.getBean(clazz.getName());
return plugin.sayHello("test reload");
}
SpringUtil 類
@Component
public class SpringUtil implements ApplicationContextAware {
private DefaultListableBeanFactory defaultListableBeanFactory;
private ApplicationContext applicationContext;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
ConfigurableApplicationContext configurableApplicationContext = (ConfigurableApplicationContext) applicationContext;
this.defaultListableBeanFactory = (DefaultListableBeanFactory) configurableApplicationContext.getBeanFactory();
}
public void registerBean(String beanName, Class<?> clazz) {
BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
defaultListableBeanFactory.registerBeanDefinition(beanName, beanDefinitionBuilder.getRawBeanDefinition());
}
public Object getBean(String name) {
return applicationContext.getBean(name);
}
}
四、總結(jié)
本文介紹的插件化實現(xiàn)思路通過 共用 ClassLoader 和 動態(tài)注冊 Bean 的方式，打通了插件與主程序之間的類加載器和 Spring 容器，使得可以非常方便的實現(xiàn)插件與插件之間和插件與主程序之間的 類交互，例如在插件中注入主程序的 Redis、DataSource、調(diào)用遠(yuǎn)程 Dubbo 接口等等。
但是由于沒有對插件之間的 ClassLoader 進(jìn)行 隔離 也可能會存在如類沖突、版本沖突等問題；并且由于 ClassLoader 中的 Class 對象無法銷毀，所以除非修改類名或者類路徑，不然插件中已加載到 ClassLoader 的類是沒辦法動態(tài)修改的。
所以本方案比較適合插件數(shù)據(jù)量不會太多、具有較好的開發(fā)規(guī)范、插件經(jīng)過測試后才能上線或發(fā)布的場景。
五、完整 demo
https://github.com/zlt2000/springs-boot-plugin-test
到此這篇關(guān)于Spring Boot熱加載jar實現(xiàn)動態(tài)插件的思路的文章就介紹到這了,更多相關(guān)Spring Boot熱加載jar內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了Java高性能緩存框架之Caffeine詳解,Caffeine是一個基于Java8的高性能緩存框架,號稱趨于完美,Caffeine受啟發(fā)于Guava?Cache的API,使用API和Guava是一致的,需要的朋友可以參考下2023-12-12
深入解析System.load 與 System.loadLibrary
以下是對System.load與System.loadLibrary進(jìn)行了詳細(xì)的分析介紹。需要的朋友可以過來參考下2013-08-08
這篇文章主要介紹了Java的并發(fā)編程之CyclicBarrier解析,CyclicBarrier支持一個可選的Runnable命令,在一組線程中的最后一個線程到達(dá)之后(但在釋放所有線程之前),該命令只在每個屏障點運行一次,需要的朋友可以參考下2023-11-11
SpringBoot使用jasypt加解密密碼的實現(xiàn)方法(二)
這篇文章主要介紹了SpringBoot使用jasypt加解密密碼的實現(xiàn)方法(二),本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-10-10
Mybatis控制臺打印SQL語句的兩種方式實現(xiàn)
這篇文章主要介紹了Mybatis控制臺打印SQL語句的兩種方式實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03
這篇文章主要為大家詳細(xì)介紹了如何使用Java實現(xiàn)讀取手機(jī)文件名稱,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-03-03
java:程序包org.bouncycastle.jce.provider不存在問題及解決
這篇文章主要介紹了java:程序包org.bouncycastle.jce.provider不存在問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-05-05
策略模式屬于Java 23種設(shè)計模式中行為模式之一，該模式定義了一系列算法，并將每個算法封裝起來，使它們可以相互替換，且算法的變化不會影響使用算法的客戶。本文將通過示例詳細(xì)講解這一模式，需要的可以參考一下2022-05-05
這篇文章主要為大家詳細(xì)介紹了java簡單實現(xiàn)桌球滾動效果，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-10-10
首先，要學(xué)習(xí)Spring中的Bean的注入方式，就要先了解什么是依賴注入。依賴注入是指：讓調(diào)用類對某一接口的實現(xiàn)類的實現(xiàn)類的依賴關(guān)系由第三方注入，以此來消除調(diào)用類對某一接口實現(xiàn)類的依賴。Spring容器中支持的依賴注入方式主要有屬性注入、構(gòu)造函數(shù)注入、工廠方法注入2022-10-10