如何在运行时动态加载JAR文件?

小开

下面的解决方案有点笨拙，因为它使用反射来绕过封装，但它工作得完美无缺:

File file = ...
URL url = file.toURI().toURL();


URLClassLoader classLoader = (URLClassLoader)ClassLoader.getSystemClassLoader();
Method method = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
method.setAccessible(true);
method.invoke(classLoader, url);

小开

你应该看一下OSGi，例如在Eclipse平台中实现。它就是这么做的。您可以安装、卸载、启动和停止所谓的包，这些包实际上是JAR文件。但是它做的更多，例如，它提供了可以在运行时在JAR文件中动态发现的服务。

或参阅Java模块系统. xml的规范。

小开

最佳答案

困难的原因在于安全。类加载器是不可变的;您不应该在运行时随意地向它添加类。我很惊讶它能与系统类加载器一起工作。下面是如何创建你自己的子类加载器:

URLClassLoader child = new URLClassLoader(
new URL[] {myJar.toURI().toURL()},
this.getClass().getClassLoader()
);
Class classToLoad = Class.forName("com.MyClass", true, child);
Method method = classToLoad.getDeclaredMethod("myMethod");
Object instance = classToLoad.newInstance();
Object result = method.invoke(instance);

很痛苦，但事实就是这样。

小开

我找到的最好的是org.apache.xbean.classloader.JarFileClassLoader，它是XBean项目的一部分。

下面是我过去使用的一个简短方法，用于从特定目录中的所有lib文件创建一个类装入器

public void initialize(String libDir) throws Exception {
File dependencyDirectory = new File(libDir);
File[] files = dependencyDirectory.listFiles();
ArrayList<URL> urls = new ArrayList<URL>();
for (int i = 0; i < files.length; i++) {
if (files[i].getName().endsWith(".jar")) {
urls.add(files[i].toURL());
//urls.add(files[i].toURI().toURL());
}
}
classLoader = new JarFileClassLoader("Scheduler CL" + System.currentTimeMillis(),
urls.toArray(new URL[urls.size()]),
GFClassLoader.class.getClassLoader());
}

然后使用类加载器，只需执行:

classLoader.loadClass(name);

小开

JCL类装入器框架呢?我必须承认，我还没有用过，但它看起来很有前途。

使用的例子:

JarClassLoader jcl = new JarClassLoader();
jcl.add("myjar.jar"); // Load jar file
jcl.add(new URL("http://myserver.com/myjar.jar")); // Load jar from a URL
jcl.add(new FileInputStream("myotherjar.jar")); // Load jar file from stream
jcl.add("myclassfolder/"); // Load class folder
jcl.add("myjarlib/"); // Recursively load all jar files in the folder/sub-folder(s)


JclObjectFactory factory = JclObjectFactory.getInstance();
// Create object of loaded class
Object obj = factory.create(jcl, "mypackage.MyClass");

小开

下面是一个未弃用的版本。我修改了原始版本，删除了不推荐使用的功能。

/**************************************************************************************************
* Copyright (c) 2004, Federal University of So Carlos                                           *
*                                                                                                *
* All rights reserved.                                                                           *
*                                                                                                *
* Redistribution and use in source and binary forms, with or without modification, are permitted *
* provided that the following conditions are met:                                                *
*                                                                                                *
*     * Redistributions of source code must retain the above copyright notice, this list of      *
*       conditions and the following disclaimer.                                                 *
*     * Redistributions in binary form must reproduce the above copyright notice, this list of   *
*     * conditions and the following disclaimer in the documentation and/or other materials      *
*     * provided with the distribution.                                                          *
*     * Neither the name of the Federal University of So Carlos nor the names of its            *
*     * contributors may be used to endorse or promote products derived from this software       *
*     * without specific prior written permission.                                               *
*                                                                                                *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS                            *
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT                              *
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR                          *
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR                  *
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,                          *
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,                            *
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR                             *
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF                         *
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING                           *
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS                             *
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                                   *
**************************************************************************************************/
/*
* Created on Oct 6, 2004
*/
package tools;


import java.io.File;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URL;
import java.net.URLClassLoader;


/**
* Useful class for dynamically changing the classpath, adding classes during runtime.
*/
public class ClasspathHacker {
/**
* Parameters of the method to add an URL to the System classes.
*/
private static final Class<?>[] parameters = new Class[]{URL.class};


/**
* Adds a file to the classpath.
* @param s a String pointing to the file
* @throws IOException
*/
public static void addFile(String s) throws IOException {
File f = new File(s);
addFile(f);
}


/**
* Adds a file to the classpath
* @param f the file to be added
* @throws IOException
*/
public static void addFile(File f) throws IOException {
addURL(f.toURI().toURL());
}


/**
* Adds the content pointed by the URL to the classpath.
* @param u the URL pointing to the content to be added
* @throws IOException
*/
public static void addURL(URL u) throws IOException {
URLClassLoader sysloader = (URLClassLoader)ClassLoader.getSystemClassLoader();
Class<?> sysclass = URLClassLoader.class;
try {
Method method = sysclass.getDeclaredMethod("addURL",parameters);
method.setAccessible(true);
method.invoke(sysloader,new Object[]{ u });
} catch (Throwable t) {
t.printStackTrace();
throw new IOException("Error, could not add URL to system classloader");
}
}


public static void main(String args[]) throws IOException, SecurityException, ClassNotFoundException, IllegalArgumentException, InstantiationException, IllegalAccessException, InvocationTargetException, NoSuchMethodException{
addFile("C:\\dynamicloading.jar");
Constructor<?> cs = ClassLoader.getSystemClassLoader().loadClass("test.DymamicLoadingTest").getConstructor(String.class);
DymamicLoadingTest instance = (DymamicLoadingTest)cs.newInstance();
instance.test();
}
}

小开

我个人认为java.util.ServiceLoader做得很好。你可以得到一个例子在这里。

小开

如果你在Android上工作，下面的代码可以工作:

String jarFile = "path/to/jarfile.jar";
DexClassLoader classLoader = new DexClassLoader(jarFile, "/data/data/" + context.getPackageName() + "/", null, getClass().getClassLoader());
Class<?> myClass = classLoader.loadClass("MyClass");

小开

jodonnell提出的解决方案很好，但应该稍加改进。我用这篇文章成功地开发了我的应用程序。

分配当前线程

首先我们要加上

Thread.currentThread().setContextClassLoader(classLoader);

否则你将无法加载资源(如spring/context.xml)存储到jar。

不包括

你的罐子放入父类装入器中，否则你将无法理解谁装入了什么。

另见使用URLClassLoader重新加载jar时出现问题

然而，OSGi框架仍然是最好的方法。

小开

对于Java 9，包含URLClassLoader的答案现在会给出如下错误:

java.lang.ClassCastException: java.base/jdk.internal.loader.ClassLoaders$AppClassLoader cannot be cast to java.base/java.net.URLClassLoader

这是因为所使用的类装入器发生了变化。相反，要添加到系统类装入器中，可以通过代理使用仪表 API。

创建代理类:

package ClassPathAgent;


import java.io.IOException;
import java.lang.instrument.Instrumentation;
import java.util.jar.JarFile;


public class ClassPathAgent {
public static void agentmain(String args, Instrumentation instrumentation) throws IOException {
instrumentation.appendToSystemClassLoaderSearch(new JarFile(args));
}
}

添加meta - inf / MANIFEST。MF并将其与代理类一起放在JAR文件中:

Manifest-Version: 1.0
Agent-Class: ClassPathAgent.ClassPathAgent

运行代理:

它使用byte-buddy-agent库将代理添加到运行的JVM:

import java.io.File;


import net.bytebuddy.agent.ByteBuddyAgent;


public class ClassPathUtil {
private static File AGENT_JAR = new File("/path/to/agent.jar");


public static void addJarToClassPath(File jarFile) {
ByteBuddyAgent.attach(AGENT_JAR, String.valueOf(ProcessHandle.current().pid()), jarFile.getPath());
}
}

小开

请看看这个项目，我开始:代理对象自由

这个lib将从文件系统或任何其他位置加载jar。它将为jar专用一个类装入器，以确保没有库冲突。用户将能够从加载的jar中创建任何对象，并在其上调用任何方法。这个库被设计用来从支持Java 7的代码库中加载在Java 8中编译的jar

创建一个对象:

    File libDir = new File("path/to/jar");


ProxyCallerInterface caller = ObjectBuilder.builder()
.setClassName("net.proxy.lib.test.LibClass")
.setArtifact(DirArtifact.builder()
.withClazz(ObjectBuilderTest.class)
.withVersionInfo(newVersionInfo(libDir))
.build())
.build();
String version = caller.call("getLibVersion").asString();

ObjectBuilder支持工厂方法、调用静态函数和回调接口实现。我将在自述页面上发布更多的例子

小开

另一个来自Allain的黑客解决方案版本，也适用于JDK 11:

File file = ...
URL url = file.toURI().toURL();
URLClassLoader sysLoader = new URLClassLoader(new URL[0]);


Method sysMethod = URLClassLoader.class.getDeclaredMethod("addURL", new Class[]{URL.class});
sysMethod.setAccessible(true);
sysMethod.invoke(sysLoader, new Object[]{url});

在JDK 11上，它给出了一些弃用警告，但对于那些在JDK 11上使用Allain解决方案的人来说，它只是一个临时解决方案。

小开

另一个使用Instrumentation的工作解决方案对我来说是有效的。它的优点是修改类加载器搜索，避免了依赖类可见性的问题:

创建代理类

对于这个例子，它必须在命令行调用的同一个jar上:

package agent;


import java.io.IOException;
import java.lang.instrument.Instrumentation;
import java.util.jar.JarFile;


public class Agent {
public static Instrumentation instrumentation;


public static void premain(String args, Instrumentation instrumentation) {
Agent.instrumentation = instrumentation;
}


public static void agentmain(String args, Instrumentation instrumentation) {
Agent.instrumentation = instrumentation;
}


public static void appendJarFile(JarFile file) throws IOException {
if (instrumentation != null) {
instrumentation.appendToSystemClassLoaderSearch(file);
}
}
}

修改MANIFEST。曼氏金融

添加对代理的引用:

Launcher-Agent-Class: agent.Agent
Agent-Class: agent.Agent
Premain-Class: agent.Agent

我实际上使用Netbeans，所以这篇文章有助于如何更改manifest.mf

运行

Launcher-Agent-Class只在JDK 9+上支持，并且负责加载代理，而无需在命令行上显式定义它:

 java -jar <your jar>

JDK 6+的工作方式是定义-javaagent参数:

java -javaagent:<your jar> -jar <your jar>

在运行时添加新的Jar

然后，您可以根据需要使用以下命令添加jar:

Agent.appendJarFile(new JarFile(<your file>));

我在文档中没有发现任何问题。

小开

这可能是一个延迟响应，我可以这样做(fastutil-8.2.2.jar的一个简单示例)使用jhplot。来自DataMelt (http://jwork.org/dmelt)的Web类

import jhplot.Web;
Web.load("http://central.maven.org/maven2/it/unimi/dsi/fastutil/8.2.2/fastutil-8.2.2.jar"); // now you can start using this library

根据文档，这个文件将在“lib/user”中下载，然后动态加载，因此您可以立即在同一个程序中使用这个jar文件中的类。

小开

下面是Allain的方法的一个快速变通方法，使其与新版本的Java兼容:

ClassLoader classLoader = ClassLoader.getSystemClassLoader();
try {
Method method = classLoader.getClass().getDeclaredMethod("addURL", URL.class);
method.setAccessible(true);
method.invoke(classLoader, new File(jarPath).toURI().toURL());
} catch (NoSuchMethodException e) {
Method method = classLoader.getClass()
.getDeclaredMethod("appendToClassPathForInstrumentation", String.class);
method.setAccessible(true);
method.invoke(classLoader, jarPath);
}

请注意，它依赖于特定JVM内部实现的知识，因此它不是理想的，也不是通用的解决方案。但是，如果您知道您将使用标准的OpenJDK或Oracle JVM，这是一种快速而简单的解决方法。在将来发布新的JVM版本时，它也可能会崩溃，所以您需要记住这一点。

小开

虽然这里列出的大多数解决方案要么是hack (JDK 9之前)难以配置(代理)，要么就是不再工作(JDK 9之后)，我发现真的很惊讶，没有人提到清晰记录的方法。

您可以创建一个自定义系统类装入器，然后您可以自由地做任何您想做的事情。不需要反射，所有类共享相同的类加载器。

当启动JVM时添加这个标志:

java -Djava.system.class.loader=com.example.MyCustomClassLoader

类加载器必须有一个接受类加载器的构造函数，必须将类加载器设置为父类加载器。构造函数将在JVM启动时调用，真正的系统类加载器将被传递，主类将由自定义加载器加载。

要添加罐子，只需调用ClassLoader.getSystemClassLoader()并将其转换到你的类中。

查看这个实现中精心制作的类加载器。请注意，您可以将add()方法更改为public。

小开

我需要在运行时为java 8和java 9+加载一个jar文件(上面的注释对这两个版本都不起作用)。下面是实现它的方法(如果相关的话，使用Spring Boot 1.5.2)。

public static synchronized void loadLibrary(java.io.File jar) {
try {
java.net.URL url = jar.toURI().toURL();
java.lang.reflect.Method method = java.net.URLClassLoader.class.getDeclaredMethod("addURL", new Class[]{java.net.URL.class});
method.setAccessible(true); /*promote the method to public access*/
method.invoke(Thread.currentThread().getContextClassLoader(), new Object[]{url});
} catch (Exception ex) {
throw new RuntimeException("Cannot load library from jar file '" + jar.getAbsolutePath() + "'. Reason: " + ex.getMessage());
}
}

小开

以防将来有人搜索这个，这种方法对我来说适用于OpenJDK 13.0.2。

我有许多需要在运行时动态实例化的类，每个类都可能具有不同的类路径。

在这段代码中，我已经有了一个名为pack的对象，它保存了一些关于我试图加载的类的元数据。getObjectFile()方法返回类的类文件的位置。getObjectRootPath()方法返回bin/目录的路径，其中包含我试图实例化的类的类文件。getLibPath()方法返回一个目录的路径，该目录包含构成该类所在模块类路径的jar文件。

File object = new File(pack.getObjectFile()).getAbsoluteFile();
Object packObject;
try {
URLClassLoader classloader;


List<URL> classpath = new ArrayList<>();
classpath.add(new File(pack.getObjectRootPath()).toURI().toURL());
for (File jar : FileUtils.listFiles(new File(pack.getLibPath()), new String[] {"jar"}, true)) {
classpath.add(jar.toURI().toURL());
}
classloader = new URLClassLoader(classpath.toArray(new URL[] {}));


Class<?> clazz = classloader.loadClass(object.getName());
packObject = clazz.getDeclaredConstructor().newInstance();


} catch (Exception e) {
e.printStackTrace();
throw e;
}
return packObject;

我以前使用Maven依赖项:org.xeustechnologies:jcl-core:2.8来做这件事，但在JDK 1.8之后，它有时会冻结，并且永远不会返回在Reference::waitForReferencePendingList()中卡住“等待引用”。

我还保留了类加载器的映射，以便在我试图实例化的类与我已经实例化的类在同一个模块中时可以重用它们，我建议这样做。

小开

对于jar文件的动态上传，您可以使用我对URLClassLoader的修改。这种修改对于在应用程序操作期间更改jar文件没有问题，就像标准的URLClassloader一样。所有加载的jar文件都加载到RAM中，因此独立于原始文件。

内存中的jar和JDBC类装入器 . bb0

小开

我知道我来晚了，但我一直在使用pf4j，这是一个插件框架，它工作得很好。

PF4J是一个微框架，其目标是保持核心简单但可扩展。

一个插件使用的例子:

在你的应用/插件中使用ExtensionPoint接口标记定义一个扩展点:

public interface Greeting extends ExtensionPoint {


String getGreeting();


}

使用@Extension注释创建一个扩展:

@Extension
public class WelcomeGreeting implements Greeting {


public String getGreeting() {
return "Welcome";
}


}

然后你可以加载和卸载插件，如你所愿:

public static void main(String[] args) {


// create the plugin manager
PluginManager pluginManager = new JarPluginManager(); // or "new ZipPluginManager() / new DefaultPluginManager()"


// start and load all plugins of application
pluginManager.loadPlugins();
pluginManager.startPlugins();


// retrieve all extensions for "Greeting" extension point
List<Greeting> greetings = pluginManager.getExtensions(Greeting.class);
for (Greeting greeting : greetings) {
System.out.println(">>> " + greeting.getGreeting());
}


// stop and unload all plugins
pluginManager.stopPlugins();
pluginManager.unloadPlugins();


}

欲了解更多详细信息，请参考文档