給定一個(gè)接口，要用戶自定義動(dòng)態(tài)實(shí)現(xiàn)并上傳熱部署

• 定義簡(jiǎn)單的接口
• 該接口的一個(gè)簡(jiǎn)單的實(shí)現(xiàn)
• 反射方式熱部署
• 注解方式熱部署
• 刪除jar時(shí)，需要同時(shí)刪除spring容器中注冊(cè)的bean
• 測(cè)試

近期開發(fā)系統(tǒng)過程中遇到的一個(gè)需求，系統(tǒng)給定一個(gè)接口，用戶可以自定義開發(fā)該接口的實(shí)現(xiàn)，并將實(shí)現(xiàn)打成jar包，上傳到系統(tǒng)中。系統(tǒng)完成熱部署，并切換該接口的實(shí)現(xiàn)。

定義簡(jiǎn)單的接口

這里以一個(gè)簡(jiǎn)單的計(jì)算器功能為例，接口定義比較簡(jiǎn)單，直接上代碼。

publicinterfaceCalculator{
intcalculate(inta,intb);
intadd(inta,intb);
}

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

• 項(xiàng)目地址：https://github.com/YunaiV/ruoyi-vue-pro
• 視頻教程：https://doc.iocoder.cn/video/

該接口的一個(gè)簡(jiǎn)單的實(shí)現(xiàn)

考慮到用戶實(shí)現(xiàn)接口的兩種方式，使用spring上下文管理的方式，或者不依賴spring管理的方式，這里稱它們?yōu)樽⒔夥绞胶头瓷浞绞健?code style="font-size:14px;padding:2px 4px;margin-right:2px;margin-left:2px;color:rgb(30,107,184);background-color:rgba(27,31,35,.05);font-family:'Operator Mono', Consolas, Monaco, Menlo, monospace;">calculate方法對(duì)應(yīng)注解方式，add方法對(duì)應(yīng)反射方式。計(jì)算器接口實(shí)現(xiàn)類的代碼如下：

@Service
publicclassCalculatorImplimplementsCalculator{
@Autowired
CalculatorCorecalculatorCore;
/**
*注解方式
*/
@Override
publicintcalculate(inta,intb){
intc=calculatorCore.add(a,b);
returnc;
}
/**
*反射方式
*/
@Override
publicintadd(inta,intb){
returnnewCalculatorCore().add(a,b);
}
}

這里注入CalculatorCore的目的是為了驗(yàn)證在注解模式下，系統(tǒng)可以完整的構(gòu)造出bean的依賴體系，并注冊(cè)到當(dāng)前spring容器中。CalculatorCore的代碼如下：

@Service
publicclassCalculatorCore{
publicintadd(inta,intb){
returna+b;
}
}

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

• 項(xiàng)目地址：https://github.com/YunaiV/yudao-cloud
• 視頻教程：https://doc.iocoder.cn/video/

反射方式熱部署

用戶把jar包上傳到系統(tǒng)的指定目錄下，這里定義上傳jar文件路徑為jarAddress，jar的Url路徑為jarPath。

privatestaticStringjarAddress="E:/zzq/IDEA_WS/CalculatorTest/lib/Calculator.jar";
privatestaticStringjarPath="file:/"+jarAddress;

并且可以要求用戶填寫jar包中接口實(shí)現(xiàn)類的完整類名。接下來(lái)系統(tǒng)要把上傳的jar包加載到當(dāng)前線程的類加載器中，然后通過完整類名，加載得到該實(shí)現(xiàn)的Class對(duì)象。然后反射調(diào)用即可，完整代碼：

/**
*熱加載Calculator接口的實(shí)現(xiàn)反射方式
*/
publicstaticvoidhotDeployWithReflect()throwsException{
URLClassLoaderurlClassLoader=newURLClassLoader(newURL[]{newURL(jarPath)},Thread.currentThread().getContextClassLoader());
Classclazz=urlClassLoader.loadClass("com.nci.cetc15.calculator.impl.CalculatorImpl");
Calculatorcalculator=(Calculator)clazz.newInstance();
intresult=calculator.add(1,2);
System.out.println(result);
}

注解方式熱部署

如果用戶上傳的jar包含了spring的上下文，那么就需要掃描jar包里的所有需要注入spring容器的bean，注冊(cè)到當(dāng)前系統(tǒng)的spring容器中。其實(shí)，這就是一個(gè)類的熱加載+動(dòng)態(tài)注冊(cè)的過程。

直接上代碼：

/**
*加入jar包后動(dòng)態(tài)注冊(cè)bean到spring容器，包括bean的依賴
*/
publicstaticvoidhotDeployWithSpring()throwsException{
SetclassNameSet=DeployUtils.readJarFile(jarAddress);
URLClassLoaderurlClassLoader=newURLClassLoader(newURL[]{newURL(jarPath)},Thread.currentThread().getContextClassLoader());
for(StringclassName:classNameSet){
Classclazz=urlClassLoader.loadClass(className);
if(DeployUtils.isSpringBeanClass(clazz)){
BeanDefinitionBuilderbeanDefinitionBuilder=BeanDefinitionBuilder.genericBeanDefinition(clazz);
defaultListableBeanFactory.registerBeanDefinition(DeployUtils.transformName(className),beanDefinitionBuilder.getBeanDefinition());
}
}
}

在這個(gè)過程中，將jar加載到當(dāng)前線程類加載器的過程和之前反射方式是一樣的。然后掃描jar包下所有的類文件，獲取到完整類名，并使用當(dāng)前線程類加載器加載出該類名對(duì)應(yīng)的class對(duì)象。判斷該class對(duì)象是否帶有spring的注解，如果包含，則將該對(duì)象注冊(cè)到系統(tǒng)的spring容器中。

DeployUtils包含讀取jar包所有類文件的方法、判斷class對(duì)象是否包含sping注解的方法、獲取注冊(cè)對(duì)象對(duì)象名的方法。代碼如下：

/**
*讀取jar包中所有類文件
*/
publicstaticSetreadJarFile(StringjarAddress)throwsIOException{
SetclassNameSet=newHashSet<>();
JarFilejarFile=newJarFile(jarAddress);
Enumerationentries=jarFile.entries();//遍歷整個(gè)jar文件
while(entries.hasMoreElements()){
JarEntryjarEntry=entries.nextElement();
Stringname=jarEntry.getName();
if(name.endsWith(".class")){
StringclassName=name.replace(".class","").replaceAll("/",".");
classNameSet.add(className);
}
}
returnclassNameSet;
}
/**
*方法描述判斷class對(duì)象是否帶有spring的注解
*/
publicstaticbooleanisSpringBeanClass(Classcla){
if(cla==null){
returnfalse;
}
//是否是接口
if(cla.isInterface()){
returnfalse;
}
//是否是抽象類
if(Modifier.isAbstract(cla.getModifiers())){
returnfalse;
}
if(cla.getAnnotation(Component.class)!=null){
returntrue;
}
if(cla.getAnnotation(Repository.class)!=null){
returntrue;
}
if(cla.getAnnotation(Service.class)!=null){
returntrue;
}
returnfalse;
}
/**
*類名首字母小寫作為spring容器beanMap的key
*/
publicstaticStringtransformName(StringclassName){
Stringtmpstr=className.substring(className.lastIndexOf(".")+1);
returntmpstr.substring(0,1).toLowerCase()+tmpstr.substring(1);
}

刪除jar時(shí)，需要同時(shí)刪除spring容器中注冊(cè)的bean

在jar包切換或刪除時(shí)，需要將之前注冊(cè)到spring容器的bean刪除。spring容器的bean的刪除操作和注冊(cè)操作是相逆的過程，這里要注意使用同一個(gè)spring上下文。

代碼如下：

/**
*刪除jar包時(shí)需要在spring容器刪除注入
*/
publicstaticvoiddelete()throwsException{
SetclassNameSet=DeployUtils.readJarFile(jarAddress);
URLClassLoaderurlClassLoader=newURLClassLoader(newURL[]{newURL(jarPath)},Thread.currentThread().getContextClassLoader());
for(StringclassName:classNameSet){
Classclazz=urlClassLoader.loadClass(className);
if(DeployUtils.isSpringBeanClass(clazz)){
defaultListableBeanFactory.removeBeanDefinition(DeployUtils.transformName(className));
}
}
}

測(cè)試

測(cè)試類手動(dòng)模擬用戶上傳jar的功能。測(cè)試函數(shù)寫了個(gè)死循環(huán)，一開始沒有找到j(luò)ar會(huì)拋出異常，捕獲該異常并睡眠10秒。這時(shí)候可以把jar手動(dòng)放到指定的目錄下。

代碼如下：

ApplicationContextapplicationContext=newClassPathXmlApplicationContext("applicationContext.xml");
DefaultListableBeanFactorydefaultListableBeanFactory=(DefaultListableBeanFactory)applicationContext.getAutowireCapableBeanFactory();
while(true){
try{
hotDeployWithReflect();
//hotDeployWithSpring();
//delete();
}catch(Exceptione){
e.printStackTrace();
Thread.sleep(1000*10);
}
}

審核編輯 ：李倩