動態上傳jar包熱部署的實戰詳解

2022-10-06 14:08:45

定義簡單的介面

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

public interface Calculator {
    int calculate(int a, int b);
    int add(int a, int b);
}

該介面的一個簡單的實現

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

@Service
public class CalculatorImpl implements Calculator {
    @Autowired
    CalculatorCore calculatorCore;
    /**
     * 註解方式
     */
    @Override
    public int calculate(int a, int b) {
        int c = calculatorCore.add(a, b);
        return c;
    }
    /**
     * 反射方式
     */
    @Override
    public int add(int a, int b) {
        return new CalculatorCore().add(a, b);
    }
}

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

@Service
public class CalculatorCore {
    public int add(int a, int b) {
        return a+b;
    }
}

反射方式熱部署

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

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

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

/**
 * 熱載入Calculator介面的實現 反射方式
 */
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，註冊到當前系統的spring容器中。其實，這就是一個類的熱載入+動態註冊的過程。

直接上程式碼：

/**
 * 加入jar包後 動態註冊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());
        }
    }
}

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

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

/**
 * 讀取jar包中所有類檔案
 */
public static Set<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 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;
}

/**
 * 類名首字母小寫 作為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時，需要同時刪除spring容器中註冊的bean

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

程式碼如下：

/**
 * 刪除jar包時 需要在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));
        }
    }
}

測試

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