1. 概述
大多数Java库都以JAR文件的形式提供。在本教程中，我们将介绍如何从命令行和Java程序中获取给定JAR文件中类的名称。
然后，我们将演示一个在运行时从给定JAR文件加载类的Java程序示例。
2. 示例JAR文件
在本教程中，我们将以stripe-0.0.1-SNAPSHOT.jar文件为例，介绍如何获取JAR文件中的类名：
3. 使用jar命令
JDK附带了一个jar命令，我们可以将此命令与t和f选项一起使用来列出JAR文件的内容：
$ jar tf stripe-0.0.1-SNAPSHOT.jar
META-INF/
META-INF/MANIFEST.MF
...
templates/result.html
templates/checkout.html
application.properties
com/baeldung/stripe/StripeApplication.class
com/baeldung/stripe/ChargeRequest.class
com/baeldung/stripe/StripeService.class
com/baeldung/stripe/ChargeRequest$Currency.class
...
由于我们只对存档中的*.class文件感兴趣，我们可以使用grep命令过滤输出：
$ jar tf stripe-0.0.1-SNAPSHOT.jar | grep '\.class$'
com/baeldung/stripe/StripeApplication.class
com/baeldung/stripe/ChargeRequest.class
com/baeldung/stripe/StripeService.class
com/baeldung/stripe/ChargeRequest$Currency.class
com/baeldung/stripe/ChargeController.class
com/baeldung/stripe/CheckoutController.class
这为我们提供了JAR文件中的class文件列表。
4. 在Java中获取JAR文件的类名
使用jar命令打印JAR文件中的类名非常简单。但是，有时我们希望在我们的Java程序中从JAR文件中加载一些类。在这种情况下，命令行输出是不够的。
为了实现我们的目标，我们需要从Java程序扫描JAR文件并获取类名。
让我们看看如何使用JarFile和JarEntry类从示例JAR文件中提取类名：
public static Set<String> getClassNamesFromJarFile(File givenFile) throws IOException {
Set<String> classNames = new HashSet<>();
try (JarFile jarFile = new JarFile(givenFile)) {
Enumeration<JarEntry> e = jarFile.entries();
while (e.hasMoreElements()) {
JarEntry jarEntry = e.nextElement();
if (jarEntry.getName().endsWith(".class")) {
String className = jarEntry.getName()
.replace("/", ".")
.replace(".class", "");
classNames.add(className);
}
}
return classNames;
}
}
现在，让我们仔细看看上面方法中的代码，了解它是如何工作的：
- try(JarFile jarFile = new JarFile(givenFile))：在这里，我们使用try-with-resources语句从给定的File对象中获取jarFile
- if(jarEntry.getName().endsWith(“.class”)){…}：我们获取每个类jarEntry，并将class文件的路径更改为限定的类名，例如将“package1/package2/SomeType.class”更改为“package1.package2.SomeType”
让我们通过单元测试方法验证该方法是否可以从我们的示例JAR文件中提取类名：
private static final String JAR_PATH = "example-jar/stripe-0.0.1-SNAPSHOT.jar";
private static final Set<String> EXPECTED_CLASS_NAMES = Sets.newHashSet(
"com.baeldung.stripe.StripeApplication",
"com.baeldung.stripe.ChargeRequest",
"com.baeldung.stripe.StripeService",
"com.baeldung.stripe.ChargeRequest$Currency",
"com.baeldung.stripe.ChargeController",
"com.baeldung.stripe.CheckoutController");
@Test
public void givenJarFilePath_whenLoadClassNames_thenGetClassNames() throws IOException, URISyntaxException {
File jarFile = new File(Objects.requireNonNull(getClass().getClassLoader().getResource(JAR_PATH)).toURI());
Set<String> classNames = GetClassNamesFromJar.getClassNamesFromJarFile(jarFile);
Assert.assertEquals(EXPECTED_CLASS_NAMES, classNames);
}
5. 在Java中从JAR文件中获取类
我们已经了解了如何从JAR文件中获取类名。有时，我们希望在运行时动态地从JAR文件中加载一些类。
在这种情况下，我们可以首先使用我们的getClassNamesFromJarFile方法从给定的JAR文件中获取类名。
接下来，我们可以创建一个ClassLoader来按名称加载所需的类：
public static Set<Class> getClassesFromJarFile(File jarFile) throws IOException, ClassNotFoundException {
Set<String> classNames = getClassNamesFromJarFile(jarFile);
Set<Class> classes = new HashSet<>(classNames.size());
try (URLClassLoader cl = URLClassLoader.newInstance(new URL[] { new URL("jar:file:" + jarFile + "!/") })) {
for (String name : classNames) {
Class clazz = cl.loadClass(name); // Load the class by its name
classes.add(clazz);
}
}
return classes;
}
在上面的方法中，我们创建了一个URLClassLoader对象来加载类，实现非常简单。
但是，可能值得稍微解释一下JAR URL的语法。一个有效的JAR URL包含三个部分：“jar: + [JAR文件的位置] + !/”。
结尾的“!/”表示JAR URL指的是整个JAR文件。让我们看几个JAR URL示例：
jar:http://www.example.com/some_jar_file.jar!/
jar:file:/local/path/to/some_jar_file.jar!/
jar:file:/C:/windows/path/to/some_jar_file.jar!/
在我们的getClassesFromJarFile方法中，JAR文件位于本地文件系统中，因此，URL的前缀是“file:”。
现在，让我们编写一个测试方法来验证我们的方法是否可以获得所有预期的Class对象：
@Test
public void givenJarFilePath_whenLoadClass_thenGetClassObjects() throws IOException, ClassNotFoundException, URISyntaxException {
File jarFile = new File(Objects.requireNonNull(getClass().getClassLoader().getResource(JAR_PATH)).toURI());
Set<Class> classes = GetClassNamesFromJar.getClassesFromJarFile(jarFile);
Set<String> names = classes.stream().map(Class::getName).collect(Collectors.toSet());
Assert.assertEquals(EXPECTED_CLASS_NAMES, names);
}
一旦我们有了所需的Class对象，我们就可以使用Java反射来创建类的实例并调用方法。
6. 总结
在本文中，我们学习了两种不同的方法来从给定的JAR文件中获取类名。
jar命令可以打印类名，如果我们需要检查JAR文件是否包含给定的类，它会非常方便。但是，如果我们需要从正在运行的Java程序中获取类名，JarFile和JarEntry可以帮助我们实现这一点。
最后，我们还看到了一个在运行时从JAR文件加载类的Java程序示例。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
