動(dòng)態(tài)上傳jar包熱部署實(shí)戰(zhàn)
閱讀本文大概需要 4 分鐘。
來(lái)自：https://blog.csdn.net/zhangzhiqiang_0912
近期開(kāi)發(fā)系統(tǒng)過(guò)程中遇到的一個(gè)需求，系統(tǒng)給定一個(gè)接口，用戶可以自定義開(kāi)發(fā)該接口的實(shí)現(xiàn)，并將實(shí)現(xiàn)打成jar包，上傳到系統(tǒng)中。系統(tǒng)完成熱部署，并切換該接口的實(shí)現(xiàn)。
# 定義簡(jiǎn)單的接口
這里以一個(gè)簡(jiǎn)單的計(jì)算器功能為例，接口定義比較簡(jiǎn)單，直接上代碼。
public interface Calculator {int calculate(int a, int b);int add(int a, int b);}
# 該接口的一個(gè)簡(jiǎn)單的實(shí)現(xiàn)
考慮到用戶實(shí)現(xiàn)接口的兩種方式，使用spring上下文管理的方式，或者不依賴spring管理的方式，這里稱它們?yōu)樽⒔夥绞胶头瓷浞绞?。calculate方法對(duì)應(yīng)注解方式，add方法對(duì)應(yīng)反射方式。計(jì)算器接口實(shí)現(xiàn)類的代碼如下：
public class CalculatorImpl implements Calculator {CalculatorCore calculatorCore;/*** 注解方式*/public int calculate(int a, int b) {int c = calculatorCore.add(a, b);return c;}/*** 反射方式*/public int add(int a, int b) {return new CalculatorCore().add(a, b);}}
這里注入CalculatorCore的目的是為了驗(yàn)證在注解模式下，系統(tǒng)可以完整的構(gòu)造出bean的依賴體系，并注冊(cè)到當(dāng)前spring容器中。CalculatorCore的代碼如下：
public class CalculatorCore {public int add(int a, int b) {return a+b;}}
# 反射方式熱部署
用戶把jar包上傳到系統(tǒng)的指定目錄下，這里定義上傳jar文件路徑為jarAddress，jar的Url路徑為jarPath。
private static String jarAddress = "E:/zzq/IDEA_WS/CalculatorTest/lib/Calculator.jar";private static String jarPath = "file:/" + jarAddress;
并且可以要求用戶填寫(xiě)jar包中接口實(shí)現(xiàn)類的完整類名。接下來(lái)系統(tǒng)要把上傳的jar包加載到當(dāng)前線程的類加載器中，然后通過(guò)完整類名，加載得到該實(shí)現(xiàn)的Class對(duì)象。然后反射調(diào)用即可，完整代碼：
/*** 熱加載Calculator接口的實(shí)現(xiàn) 反射方式*/public static void hotDeployWithReflect() throws Exception {URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());Class clazz = urlClassLoader.loadClass("com.nci.cetc15.calculator.impl.CalculatorImpl");Calculator calculator = (Calculator) clazz.newInstance();int result = 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è)的過(guò)程。
直接上代碼：
/*** 加入jar包后 動(dòng)態(tài)注冊(cè)bean到spring容器，包括bean的依賴*/public static void hotDeployWithSpring() throws Exception {Set<String> classNameSet = DeployUtils.readJarFile(jarAddress);URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());for (String className : classNameSet) {Class clazz = urlClassLoader.loadClass(className);if (DeployUtils.isSpringBeanClass(clazz)) {BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);defaultListableBeanFactory.registerBeanDefinition(DeployUtils.transformName(className), beanDefinitionBuilder.getBeanDefinition());}}}
在這個(gè)過(guò)程中，將jar加載到當(dāng)前線程類加載器的過(guò)程和之前反射方式是一樣的。然后掃描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包中所有類文件*/public static Set<String> readJarFile(String jarAddress) throws IOException {Set<String> classNameSet = new HashSet<>();JarFile jarFile = new JarFile(jarAddress);Enumerationentries = jarFile.entries();//遍歷整個(gè)jar文件 while (entries.hasMoreElements()) {JarEntry jarEntry = entries.nextElement();String name = jarEntry.getName();if (name.endsWith(".class")) {String className = name.replace(".class", "").replaceAll("/", ".");classNameSet.add(className);}}return classNameSet;}
/*** 方法描述 判斷class對(duì)象是否帶有spring的注解*/public static boolean isSpringBeanClass(Class cla) {if (cla == null) {return false;}//是否是接口if (cla.isInterface()) {return false;}//是否是抽象類if (Modifier.isAbstract(cla.getModifiers())) {return false;}if (cla.getAnnotation(Component.class) != null) {return true;}if (cla.getAnnotation(Repository.class) != null) {return true;}if (cla.getAnnotation(Service.class) != null) {return true;}return false;}
/*** 類名首字母小寫(xiě) 作為spring容器beanMap的key*/public static String transformName(String className) {String tmpstr = className.substring(className.lastIndexOf(".") + 1);return tmpstr.substring(0, 1).toLowerCase() + tmpstr.substring(1);}
# 刪除jar時(shí)，需要同時(shí)刪除spring容器中注冊(cè)的bean
在jar包切換或刪除時(shí)，需要將之前注冊(cè)到spring容器的bean刪除。spring容器的bean的刪除操作和注冊(cè)操作是相逆的過(guò)程，這里要注意使用同一個(gè)spring上下文。
代碼如下：
/*** 刪除jar包時(shí) 需要在spring容器刪除注入*/public static void delete() throws Exception {Set<String> classNameSet = DeployUtils.readJarFile(jarAddress);URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());for (String className : classNameSet) {Class clazz = urlClassLoader.loadClass(className);if (DeployUtils.isSpringBeanClass(clazz)) {defaultListableBeanFactory.removeBeanDefinition(DeployUtils.transformName(className));}}}
# 測(cè)試
測(cè)試類手動(dòng)模擬用戶上傳jar的功能。測(cè)試函數(shù)寫(xiě)了個(gè)死循環(huán)，一開(kāi)始沒(méi)有找到j(luò)ar會(huì)拋出異常，捕獲該異常并睡眠10秒。這時(shí)候可以把jar手動(dòng)放到指定的目錄下。
代碼如下：
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();while (true) {try {hotDeployWithReflect();// hotDeployWithSpring();// delete();} catch (Exception e) {e.printStackTrace();Thread.sleep(1000 * 10);}}
推薦閱讀：
知乎熱議：月薪 2~3W 的碼農(nóng)，怎樣度過(guò)一天？
吊打 ThreadLocal，談?wù)凢astThreadLocal為啥能這么快？
內(nèi)容包含Java基礎(chǔ)、JavaWeb、MySQL性能優(yōu)化、JVM、鎖、百萬(wàn)并發(fā)、消息隊(duì)列、高性能緩存、反射、Spring全家桶原理、微服務(wù)、Zookeeper......等技術(shù)棧！
?戳閱讀原文領(lǐng)取！? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??朕已閱?