java通過URLClassLoader類加載器加載外部jar代碼示例

更新時間：2024年01月31日 15:17:48 作者：luffy5459

ClassLoader翻譯過來就是類加載器,普通的java開發(fā)者其實(shí)用到的不多,但對于某些框架開發(fā)者來說卻非常常見,下面這篇文章主要給大家介紹了關(guān)于java通過URLClassLoader類加載器加載外部jar的相關(guān)資料,需要的朋友可以參考下

相信在實(shí)際工作中，大家可能會遇到這種需求，這個jar是外部的，并沒有添加到項目依賴中，只能通過類加載器加載并調(diào)用相關(guān)方法。

這種jar加載，其實(shí)也簡單，我們通過普通的URLClassLoader就可以加載。代碼如下所示：

public static URLClassLoader getClassLoader(String url) {
    URLClassLoader classLoader = new URLClassLoader(new URL[]{}, ClassLoader.getSystemClassLoader());
    try {
        Method method = URLClassLoader.class.getDeclaredMethod("addURL", new Class[]{URL.class});
        if (!method.isAccessible()) {
            method.setAccessible(true);
        }
        method.invoke(classLoader, new URL("file:" + url));
        return classLoader;
    } catch (NoSuchMethodException | MalformedURLException | InvocationTargetException | IllegalAccessException e) {
        throw new RuntimeException(e);
    }
}

這里，只是把jar加載到了虛擬機(jī)中，要調(diào)用，我們需要根據(jù)類名與類加載器來獲取類對象。

public static List<Class<?>> getClassListByInterface(String url, ClassLoader classLoader, Class<?> clazz) {
	List<Class<?>> classList = new ArrayList<>();
	if (!clazz.isInterface()) {
		return classList;
	}
	List<String> classNames = new ArrayList<>();
	try (JarFile jarFile = new JarFile(url)) {
		Enumeration<JarEntry> entries = jarFile.entries();
		while (entries.hasMoreElements()) {
			JarEntry jarEntry = entries.nextElement();
			String entryName = jarEntry.getName();
			if (entryName != null && entryName.endsWith(".class")) {
				entryName = entryName.replace("/", ".").substring(0, entryName.lastIndexOf("."));
				classNames.add(entryName);
			}
		}
	} catch (IOException e) {
		throw new RuntimeException(e);
	}

	if (classNames.size() > 0) {
		for (String className : classNames) {
			try {
				Class<?> theClass = classLoader.loadClass(className);
				if (clazz.isAssignableFrom(theClass) && !theClass.equals(clazz)) {
					classList.add(theClass);
				}
			} catch (ClassNotFoundException e) {
				throw new RuntimeException(e);
			}
		}
	}
	return classList;
}

還需要做一些準(zhǔn)備：

1，定義一個接口，外部去實(shí)現(xiàn)：

import java.util.Map;

public interface IService {
    String name();

    Object process(Map<String, Object> params);
}

2、三方實(shí)現(xiàn)：

import com.example.service.IService;
import com.example.util.FileUtil;

import java.util.HashMap;
import java.util.Map;

public class BusinessService implements IService {
    @Override
    public String name() {
        return "Test";
    }

    @Override
    public Object process(Map<String, Object> params) {
        Map<String, Object> result = new HashMap<>();
        result.put("name", name());
        result.put("path", FileUtil.getPath("tmp"));
        return result;
    }
}

我們在這個實(shí)現(xiàn)里面，故意調(diào)用了另一個三方的依賴FileUtil：

import java.io.File;

public class FileUtil {

    public static String getPath(String name) {
        return String.join(File.separator, "D:", name);
    }
}

打包插件配置：

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.10.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>

            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.2</version>
                <configuration>
                    <archive>
                        <manifest>
                            <!--告知maven-jar-plugin添加一個classpath到manifest.mf文件，以及在class-path元素中包含所有依賴項-->
                            <addClasspath>true</addClasspath>
                            <!--所有依賴應(yīng)該位于lib包 -->
                            <classpathPrefix>lib/</classpathPrefix>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.2.0</version>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${project.build.directory}/classes/lib</outputDirectory>
                            <!--是否不包含間接依賴包-->
                            <excludeTransitive>false</excludeTransitive>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

我們會把三方實(shí)現(xiàn)打jar包，jar包含了所需的依賴：

實(shí)際中使用，我們需要先獲取類加載器，然后獲取類對象，再實(shí)例化，最后調(diào)用對象的方法。

public class BusinessTest {
    public static void main(String[] args) {
        String url = "E:\\workspace\\java\\classloaderexample\\common-test\\target\\common-test-1.0-SNAPSHOT.jar";
        URLClassLoader classLoader = ClassLoaderUtil.getClassLoader(url);
        // URLClassLoader classLoader = ClassLoaderUtil.loadAllJar(url);
        List<Class<?>> classList = ClassLoaderUtil.getClassListByInterface(url, classLoader, IService.class);
        System.out.println(classList);
        for (Class clazz : classList) {
            try {
                IService service = (IService) clazz.newInstance();
                System.out.println(service.process(null));
            } catch (InstantiationException e) {
                throw new RuntimeException(e);
            } catch (IllegalAccessException e) {
                throw new RuntimeException(e);
            }
        }
    }
}

運(yùn)行報錯：

這里報錯信息，提示是NoClassDefFoundError:com/example/util/FileUtil。

但是我們進(jìn)行打包的時候，明明把FileUtil的jar打到了common-test-1.0-SNAPSHOT.jar中了，為什么找不到呢？

這里其實(shí)就是今天要說的重點(diǎn)，我們通過URLClassLoader加載jar，確實(shí)能加載到相關(guān)的類對象，而且實(shí)例化也不會有問題，但是我們在調(diào)用實(shí)例方法的時候，因?yàn)檫@里面使用了其他三方的jar，但是這個三方j(luò)ar是包含在common-test本身jar內(nèi)部的，它不能再像文件系統(tǒng)那樣讀取自己內(nèi)部的資源。

解決辦法就是把common-test里面lib下的jar資源讀出來，寫入本地。

public static URLClassLoader loadAllJar(String url) {
        URLClassLoader classLoader = new URLClassLoader(new URL[]{}, ClassLoader.getSystemClassLoader());
        Method method;
        try {
            method = URLClassLoader.class.getDeclaredMethod("addURL", new Class[]{URL.class});
            if (!method.isAccessible()) {
                method.setAccessible(true);
            }
            method.invoke(classLoader, new URL("file:" + url));
        } catch (NoSuchMethodException | MalformedURLException | InvocationTargetException | IllegalAccessException e) {
            throw new RuntimeException(e);
        }
        // write to local lib
        try {
            String jarResourceStr = "jar:file:" + url + "!/";
            URL libUrl = new URL(jarResourceStr);
            URLConnection urlConnection = libUrl.openConnection();
            if (urlConnection instanceof JarURLConnection) {
                JarURLConnection jarURLConnection = (JarURLConnection) urlConnection;
                JarFile jarFile = jarURLConnection.getJarFile();
                Enumeration<JarEntry> entries = jarFile.entries();
                String parentPath = Paths.get(url).getParent().toString();
                File libDir = Paths.get(parentPath, "lib").toFile();
                libDir.deleteOnExit();
                boolean isSuccess = libDir.mkdirs();
                if (!isSuccess) {
                    System.out.println("create lib dir fail");
                }
                while (entries.hasMoreElements()) {
                    JarEntry jarEntry = entries.nextElement();
                    String entryName = jarEntry.getName();
                    if (entryName.endsWith(".jar")) {
                        try (InputStream inputStream = classLoader.getResourceAsStream(entryName)) {
                            File target = new File(parentPath, entryName);
                            FileUtils.copyInputStreamToFile(inputStream, target);
                            method.invoke(classLoader, new URL("file:" + target.getPath()));
                        } catch (IOException e) {
                            throw new RuntimeException(e);
                        } catch (InvocationTargetException e) {
                            throw new RuntimeException(e);
                        } catch (IllegalAccessException e) {
                            throw new RuntimeException(e);
                        }
                    }
                }
            }

        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return classLoader;
    }

這里重新定義了一個類加載器方法，加載jar，獲取類加載器之后，把jar包中l(wèi)ib下的jar也寫入本地，同樣的，也需要把這些jar加載起來。

最后運(yùn)行調(diào)用示例，正確打印：

這里成功調(diào)用之后，我們可以看看本地的jar結(jié)構(gòu)：

在common-test-1.0-SNAPSHOT.jar同級目錄下，還有一個lib文件夾，這里面就是common-test-1.0-SNAPSHOT.jar依賴的兩個jar。

其實(shí)本地文件系統(tǒng)有了lib這個目錄之后，我們再回過去用getClassLoader()那種方式調(diào)用，也是沒有問題的。

這是為什么呢？我們可以看看 common-test jar包中的manifest.mf信息：

Manifest-Version: 1.0
Class-Path: lib/common-api-1.0-SNAPSHOT.jar lib/third-party-1.0-SNAPSH
 OT.jar
Build-Jdk-Spec: 1.8
Created-By: Maven JAR Plugin 3.2.2

這里指定的Class-Path是lib/comon-api-1.0-SNAPSHOT.jar lib/third-party-1.0-SNAPSHOT.jar，我們通過類加載器加載了common-test jar，但是它內(nèi)部的lib路徑是common-test-1.0-SNAPSHOT.jar!/lib/xxx.jar，通過普通的文件路徑lib/xxx.jar是無法加載的。

上面的代碼，如果使用loadAllJar()方法，雖然不會有問題，但是，如果我們獲取類加載器，得到類對象信息，在實(shí)例化之前，我們不小心調(diào)用了classloader.close()把類加載器關(guān)閉了，同樣會執(zhí)行報錯，如下所示：