详解Java 包扫描实现和应用(Jar篇)
如果你曾经使用过 Spring
, 那你已经配过 包扫描路径吧,那包扫描是怎么实现的呢?让我们自己写个包扫描
上篇文章中介绍了使用 File
遍历的方式去进行包扫描,这篇主要补充一下jar
包的扫描方式,在我们的项目中一般都会去依赖一些其他jar
包,
比如添加 guava 依赖
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>28.2-jre</version> </dependency>
我们再次运行上次的测试用例
@Test public void testGetPackageAllClasses() throws IOException, ClassNotFoundException { ClassScanner scanner = new ClassScanner("com.google.common.cache", true, null, null); Set<Class<?>> packageAllClasses = scanner.doScanAllClasses(); packageAllClasses.forEach(it -> { System.out.println(it.getName()); }); }
什么都没有输出
依赖的 Jar
基于Java
的反射机制,我们很容易根据 class
去创建一个实例对象,但如果我们根本不知道某个包下有多少对象时,我们应该怎么做呢?
在使用Spring
框架时,会根据包扫描路径来找到所有的 class
, 并将其实例化后存入容器中。
在我们的项目中也会遇到这样的场景,比如某个包为 org.example.plugins
, 这个里面放着所有的插件,为了不每次增减插件都要手动修改代码,我们可能会想到用扫描的方式去动态获知 org.example.plugins
到底有多少 class, 当然应用场景很有很多
思路
既然知道是采用了 jar
, 那我们使用遍历 jar 的方式去处理一下
JarFile jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 遍历jar包中的元素 Enumeration<JarEntry> entries = jar.entries(); while (entries.hasMoreElements()) { JarEntry entry = entries.nextElement(); String name = entry.getName(); }
这里获取的name 格式为 com/google/common/cache/Cache.class
是不是和上篇的文件路径很像呀, 这里可以通过对 name
进行操作获取包名
和 class
// 获取包名 String jarPackageName = name.substring(0, name.lastIndexOf('/')).replace("/", "."); // 获取 class 路径, 这样就能通过类加载进行加载了 String className = name.replace('/', '.'); className = className.substring(0, className.length() - 6);
完整代码
private void doScanPackageClassesByJar(String basePackage, URL url, Set<Class<?>> classes) throws IOException, ClassNotFoundException { // 包名 String packageName = basePackage; // 获取文件路径 String basePackageFilePath = packageName.replace('.', '/'); // 转为jar包 JarFile jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 遍历jar包中的元素 Enumeration<JarEntry> entries = jar.entries(); while (entries.hasMoreElements()) { JarEntry entry = entries.nextElement(); String name = entry.getName(); // 如果路径不一致,或者是目录,则继续 if (!name.startsWith(basePackageFilePath) || entry.isDirectory()) { continue; } // 判断是否递归搜索子包 if (!recursive && name.lastIndexOf('/') != basePackageFilePath.length()) { continue; } if (packagePredicate != null) { String jarPackageName = name.substring(0, name.lastIndexOf('/')).replace("/", "."); if (!packagePredicate.test(jarPackageName)) { continue; } } // 判定是否符合过滤条件 String className = name.replace('/', '.'); className = className.substring(0, className.length() - 6); // 用当前线程的类加载器加载类 Class<?> loadClass = Thread.currentThread().getContextClassLoader().loadClass(className); if (classPredicate == null || classPredicate.test(loadClass)) { classes.add(loadClass); } } }
在结合上篇中 File
扫描方式就是完成的代码了
整合后代码
package org.example; import java.io.File; import java.io.FileFilter; import java.io.IOException; import java.net.JarURLConnection; import java.net.URL; import java.net.URLDecoder; import java.util.Enumeration; import java.util.LinkedHashSet; import java.util.Set; import java.util.function.Predicate; import java.util.jar.JarEntry; import java.util.jar.JarFile; /** * class 扫描器 * * @author zhangyunan */ public class ClassScanner { private final String basePackage; private final boolean recursive; private final Predicate<String> packagePredicate; private final Predicate<Class> classPredicate; /** * Instantiates a new Class scanner. * * @param basePackage the base package * @param recursive 是否递归扫描 * @param packagePredicate the package predicate * @param classPredicate the class predicate */ public ClassScanner(String basePackage, boolean recursive, Predicate<String> packagePredicate, Predicate<Class> classPredicate) { this.basePackage = basePackage; this.recursive = recursive; this.packagePredicate = packagePredicate; this.classPredicate = classPredicate; } /** * Do scan all classes set. * * @return the set * @throws IOException the io exception * @throws ClassNotFoundException the class not found exception */ public Set<Class<?>> doScanAllClasses() throws IOException, ClassNotFoundException { Set<Class<?>> classes = new LinkedHashSet<Class<?>>(); String packageName = basePackage; // 如果最后一个字符是“.”,则去掉 if (packageName.endsWith(".")) { packageName = packageName.substring(0, packageName.lastIndexOf('.')); } // 将包名中的“.”换成系统文件夹的“/” String basePackageFilePath = packageName.replace('.', '/'); Enumeration<URL> resources = Thread.currentThread().getContextClassLoader().getResources(basePackageFilePath); while (resources.hasMoreElements()) { URL resource = resources.nextElement(); String protocol = resource.getProtocol(); if ("file".equals(protocol)) { String filePath = URLDecoder.decode(resource.getFile(), "UTF-8"); // 扫描文件夹中的包和类 doScanPackageClassesByFile(classes, packageName, filePath); } else if ("jar".equals(protocol)) { doScanPackageClassesByJar(packageName, resource, classes); } } return classes; } private void doScanPackageClassesByJar(String basePackage, URL url, Set<Class<?>> classes) throws IOException, ClassNotFoundException { // 包名 String packageName = basePackage; // 获取文件路径 String basePackageFilePath = packageName.replace('.', '/'); // 转为jar包 JarFile jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 遍历jar包中的元素 Enumeration<JarEntry> entries = jar.entries(); while (entries.hasMoreElements()) { JarEntry entry = entries.nextElement(); String name = entry.getName(); // 如果路径不一致,或者是目录,则继续 if (!name.startsWith(basePackageFilePath) || entry.isDirectory()) { continue; } // 判断是否递归搜索子包 if (!recursive && name.lastIndexOf('/') != basePackageFilePath.length()) { continue; } if (packagePredicate != null) { String jarPackageName = name.substring(0, name.lastIndexOf('/')).replace("/", "."); if (!packagePredicate.test(jarPackageName)) { continue; } } // 判定是否符合过滤条件 String className = name.replace('/', '.'); className = className.substring(0, className.length() - 6); // 用当前线程的类加载器加载类 Class<?> loadClass = Thread.currentThread().getContextClassLoader().loadClass(className); if (classPredicate == null || classPredicate.test(loadClass)) { classes.add(loadClass); } } } /** * 在文件夹中扫描包和类 */ private void doScanPackageClassesByFile(Set<Class<?>> classes, String packageName, String packagePath) throws ClassNotFoundException { // 转为文件 File dir = new File(packagePath); if (!dir.exists() || !dir.isDirectory()) { return; } // 列出文件,进行过滤 // 自定义文件过滤规则 File[] dirFiles = dir.listFiles((FileFilter) file -> { String filename = file.getName(); if (file.isDirectory()) { if (!recursive) { return false; } if (packagePredicate != null) { return packagePredicate.test(packageName + "." + filename); } return true; } return filename.endsWith(".class"); }); if (null == dirFiles) { return; } for (File file : dirFiles) { if (file.isDirectory()) { // 如果是目录,则递归 doScanPackageClassesByFile(classes, packageName + "." + file.getName(), file.getAbsolutePath()); } else { // 用当前类加载器加载 去除 fileName 的 .class 6 位 String className = file.getName().substring(0, file.getName().length() - 6); Class<?> loadClass = Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className); if (classPredicate == null || classPredicate.test(loadClass)) { classes.add(loadClass); } } } } }
到此这篇关于详解Java 包扫描实现和应用(Jar篇)的文章就介绍到这了,更多相关Java 包扫描实现和应用内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
- 这篇文章主要介绍了如何利用java语言实现经典《复杂迷宫》游戏,文中采用了swing技术进行了界面化处理,感兴趣的小伙伴可以动手试一试...2022-02-01
java 运行报错has been compiled by a more recent version of the Java Runtime
java 运行报错has been compiled by a more recent version of the Java Runtime (class file version 54.0)...2021-04-01- 这篇文章主要介绍了在java中获取List集合中最大的日期时间操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-15
- 这篇文章主要介绍了教你怎么用Java获取国家法定节假日,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下...2021-04-23
- 这篇文章主要介绍了Java如何发起http请求的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-03-31
- 说起C#和Java这两门语言(语法,数据类型 等),个人以为,大概有90%以上的相似,甚至可以认为几乎一样。但是在工作中,我也发现了一些细微的差别...2020-06-25
- 这篇文章主要介绍了解决Java处理HTTP请求超时的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-29
- 这篇文章主要介绍了java 判断两个时间段是否重叠的案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-15
java 画pdf用itext调整表格宽度、自定义各个列宽的方法
这篇文章主要介绍了java 画pdf用itext调整表格宽度、自定义各个列宽的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-01-31- 这篇文章主要介绍了超简洁java实现双色球若干注随机号码生成(实例代码),本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-04-02
- 这篇文章主要介绍了Java生成随机姓名、性别和年龄的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-10-01
- 这篇文章主要介绍了java正则表达式判断前端参数修改表中另一个字段的值,需要的朋友可以参考下...2021-05-07
Java使用ScriptEngine动态执行代码(附Java几种动态执行代码比较)
这篇文章主要介绍了Java使用ScriptEngine动态执行代码,并且分享Java几种动态执行代码比较,需要的朋友可以参考下...2021-04-15- 这篇文章主要介绍了Java开发实现人机猜拳游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-08-03
- 这篇文章主要介绍了Java List集合返回值去掉中括号('[ ]')的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-29
Java 8 Stream 的终极技巧——Collectors 功能与操作方法详解
这篇文章主要介绍了Java 8 Stream Collectors 功能与操作方法,结合实例形式详细分析了Java 8 Stream Collectors 功能、操作方法及相关注意事项,需要的朋友可以参考下...2020-05-20Java中lombok的@Builder注解的解析与简单使用详解
这篇文章主要介绍了Java中lombok的@Builder注解的解析与简单使用,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-01-06- 下面小编就为大家带来一篇java中String类型变量的赋值问题介绍。小编觉得挺不错的。现在分享给大家,给大家一个参考。...2016-03-28
- 这篇文章主要介绍了Java线程池中的各个参数如何合理设置操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-19
- 这篇文章主要介绍了详解Java后端优雅验证参数合法性,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-02-18