手動部署jar包，太low！動態上傳熱部署真爽！

2024-07-17碼農

掃碼關註「後端架構師」，選擇「星標」公眾號

重磅幹貨，第一時間送達！

責編：架構君 | 來源：網路

上一篇好文：

正文

大家好，我是後端架構師。

近期開發系統過程中遇到的一個需求，系統給定一個介面，使用者可以自訂開發該介面的實作，並將實作打成jar包，上傳到系統中。系統完成熱部署，並切換該介面的實作。

定義簡單的介面

這裏以一個簡單的小算盤功能為例，介面定義比較簡單，直接上程式碼。

publicinterfaceCalculator {intcalculate(int a, int b);intadd(int a, int b);}

該介面的一個簡單的實作

考慮到使用者實作介面的兩種方式，使用spring上下文管理的方式，或者不依賴spring管理的方式，這裏稱它們為註解方式和反射方式。 calculate 方法對應註解方式，add方法對應反射方式。小算盤介面實作類的程式碼如下：

@Servicepublic classCalculatorImplimplementsCalculator {@Autowired CalculatorCore calculatorCore;/** * 註解方式 */@Overridepublicintcalculate(int a, int b) {int c = calculatorCore.add(a, b);return c; }/** * 反射方式 */@Overridepublicintadd(int a, int b) {returnnew CalculatorCore().add(a, b); }}

這裏註入 CalculatorCore 的目的是為了驗證在註解模式下，系統可以完整的構造出bean的依賴體系，並註冊到當前spring容器中。 CalculatorCore 的程式碼如下：

@Servicepublic classCalculatorCore {publicintadd(int a, int b) {return a+b; }}

反射方式熱部署

使用者把jar包上傳到系統的指定目錄下，這裏定義上傳jar檔路徑為jarAddress，jar的Url路徑為jarPath。

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

並且可以要求使用者填寫jar包中介面實作類的完整類名。接下來系統要把上傳的jar包載入到當前執行緒的類載入器中，然後透過完整類名，載入得到該實作的 class物件。然後反射呼叫即可，完整程式碼：

/** * 熱載入Calculator介面的實作反射方式 */publicstaticvoidhotDeployWithReflect() throws Exception { URL classLoader url classLoader = new URL classLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContext classLoader()); class clazz = url classLoader.load class("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，註冊到當前系統的spring容器中。其實，這就是一個類的熱載入+動態註冊的過程。

直接上程式碼：

/** * 加入jar包後動態註冊bean到spring容器，包括bean的依賴 */public staticvoid hotDeployWithSpring() throws Exception {Set<String> classNameSet = DeployUtils.readJarFile(jarAddress); URL classLoader url classLoader = new URL classLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContext classLoader());for (String className : classNameSet) { class clazz = url classLoader.load class( className);if (DeployUtils.isSpringBean class(clazz)) { BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz); defaultListableBeanFactory.registerBeanDefinition(DeployUtils.transformName( className), beanDefinitionBuilder.getBeanDefinition()); } }}

在這個過程中，將jar載入到當前執行緒類載入器的過程和之前反射方式是一樣的。然後掃描jar包下所有的類檔，獲取到完整類名，並使用當前執行緒類載入器載入出該類名對應的 class物件。判斷該 class物件是否帶有spring的註解，如果包含，則將該物件註冊到系統的spring容器中。

DeployUtils包含讀取jar包所有類檔的方法、判斷 class物件是否包含sping註解的方法、獲取註冊物件物件名的方法。程式碼如下：

/** * 讀取jar包中所有類檔 */public staticSet<String> readJarFile(String jarAddress) throws IOException {Set<String> classNameSet = new HashSet<>(); JarFile jarFile = new JarFile(jarAddress); Enumeration<JarEntry> entries = jarFile.entries();//遍歷整個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物件是否帶有spring的註解 */public static boolean isSpringBean class( class<?> cla) {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 */publicstaticString transformName(String className) {String tmpstr = className.substring( className.lastIndexOf(".") + 1);return tmpstr.substring(0, 1).toLowerCase() + tmpstr.substring(1);}

刪除jar時，需要同時刪除spring容器中註冊的bean

在jar包切換或刪除時，需要將之前註冊到spring容器的bean刪除。spring容器的bean的刪除操作和註冊操作是相逆的過程，這裏要註意使用同一個spring上下文。

程式碼如下：

/** * 刪除jar包時需要在spring容器刪除註入 */public staticvoiddelete() throws Exception {Set<String> classNameSet = DeployUtils.readJarFile(jarAddress); URL classLoader url classLoader = new URL classLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContext classLoader());for (String className : classNameSet) { class clazz = url classLoader.load class( className);if (DeployUtils.isSpringBean class(clazz)) { defaultListableBeanFactory.removeBeanDefinition(DeployUtils.transformName( className)); } }}

測試

測試類手動模擬使用者上傳jar的功能。測試函式寫了個死迴圈，一開始沒有找到jar會丟擲異常，捕獲該異常並睡眠10秒。這時候可以把jar手動放到指定的目錄下。

程式碼如下：

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); } }