本文共 5654 字,大约阅读时间需要 18 分钟。
之前在看spring注解的时候,有看到再配置文件里面定义component scan package就能自动扫描对应包下面的class,
然后根据注解生成相应的bean。自己对这个功能很好奇,就搜了下,找到了实现的关键代码,记录下。后续再对这段代码深入学习。
/**
* 从包package中获取所有的Class
*
* @param pack
* @return
*/
public static Set> getClasses(String pack) {
// 第一个class类的集合
Set> classes = new LinkedHashSet>();
// 是否循环迭代
boolean recursive = true;
// 获取包的名字 并进行替换
String packageName = pack;
String packageDirName = packageName.replace('.', '/');
// 定义一个枚举的集合 并进行循环来处理这个目录下的things
Enumeration dirs;
try {
dirs = Thread.currentThread().getContextClassLoader().getResources(
packageDirName);
// 循环迭代下去
while (dirs.hasMoreElements()) {
// 获取下一个元素
URL url = dirs.nextElement();
// 得到协议的名称
String protocol = url.getProtocol();
// 如果是以文件的形式保存在服务器上
if ("file".equals(protocol)) {
System.err.println("file类型的扫描");
// 获取包的物理路径
String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
// 以文件的方式扫描整个包下的文件 并添加到集合中
findAndAddClassesInPackageByFile(packageName, filePath,
recursive, classes);
} else if ("jar".equals(protocol)) {
// 如果是jar包文件
// 定义一个JarFile
System.err.println("jar类型的扫描");
JarFile jar;
try {
// 获取jar
jar = ((JarURLConnection) url.openConnection())
.getJarFile();
// 从此jar包 得到一个枚举类
Enumeration entries = jar.entries();
// 同样的进行循环迭代
while (entries.hasMoreElements()) {
// 获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件
JarEntry entry = entries.nextElement();
String name = entry.getName();
// 如果是以/开头的
if (name.charAt(0) == '/') {
// 获取后面的字符串
name = name.substring(1);
}
// 如果前半部分和定义的包名相同
if (name.startsWith(packageDirName)) {
int idx = name.lastIndexOf('/');
// 如果以"/"结尾 是一个包
if (idx != -1) {
// 获取包名 把"/"替换成"."
packageName = name.substring(0, idx)
.replace('/', '.');
}
// 如果可以迭代下去 并且是一个包
if ((idx != -1) || recursive) {
// 如果是一个.class文件 而且不是目录
if (name.endsWith(".class")
&& !entry.isDirectory()) {
// 去掉后面的".class" 获取真正的类名
String className = name.substring(
packageName.length() + 1, name
.length() - 6);
try {
// 添加到classes
classes.add(Class
.forName(packageName + '.'
+ className));
} catch (ClassNotFoundException e) {
// log
// .error("添加用户自定义视图类错误 找不到此类的.class文件");
e.printStackTrace();
}
}
}
}
}
} catch (IOException e) {
// log.error("在扫描用户定义视图时从jar包获取文件出错");
e.printStackTrace();
}
}
}
} catch (IOException e) {
e.printStackTrace();
}
return classes;
}
/**
* 以文件的形式来获取包下的所有Class
*
* @param packageName
* @param packagePath
* @param recursive
* @param classes
*/
public static void findAndAddClassesInPackageByFile(String packageName,
String packagePath, final boolean recursive, Set> classes) {
// 获取此包的目录 建立一个File
File dir = new File(packagePath);
// 如果不存在或者 也不是目录就直接返回
if (!dir.exists() || !dir.isDirectory()) {
// log.warn("用户定义包名 " + packageName + " 下没有任何文件");
return;
}
// 如果存在 就获取包下的所有文件 包括目录
File[] dirfiles = dir.listFiles(new FileFilter() {
// 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
public boolean accept(File file) {
return (recursive && file.isDirectory())
|| (file.getName().endsWith(".class"));
}
});
// 循环所有文件
for (File file : dirfiles) {
// 如果是目录 则继续扫描
if (file.isDirectory()) {
findAndAddClassesInPackageByFile(packageName + "."
+ file.getName(), file.getAbsolutePath(), recursive,
classes);
} else {
// 如果是java类文件 去掉后面的.class 只留下类名
String className = file.getName().substring(0,
file.getName().length() - 6);
try {
// 添加到集合中去
//classes.add(Class.forName(packageName + '.' + className));
//经过回复同学的提醒,这里用forName有一些不好,会触发static方法,没有使用classLoader的load干净
classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
} catch (ClassNotFoundException e) {
// log.error("添加用户自定义视图类错误 找不到此类的.class文件");
e.printStackTrace();
}
}
}
}
自己直接拿过来用了,可以扫描package对应的子package,不过是对当前classLoad下的所有jar进行扫描的。
14
顶
1
踩
分享到:
2010-04-15 18:31
浏览 37885
评论
16 楼
stranger520
2015-12-09
可能有问题吧,举个例子:
pacage1/User.class,pacage1/student/Student.class,那个递归,如果递归pacage1目录,就会发现里面有 两个 文件,一个是user.class.一个是student的目录,如果循环先判断 package1/student/,这是个目录,就进入递归了,进入下一级目录了,那么user.class就找不到了,不知我说的是否有理!
15 楼
来迟了
2015-05-25
我也想知道是在spring 的那个jar包中???
14 楼
luxiaohuo
2015-04-22
找了下spring源码 貌似没找着 感谢博主分享
13 楼
xlaohe1
2014-11-19
请问是spring哪个文件下的?
12 楼
yznxing
2014-02-13
dyy_gusi 写道
yznxing 写道
laser_lu 写道
貌似缺一个函数。。
额。。貌似是的。。
findAndAddClassesInPackageByFile
你们看的都很认真,但是当你们再仔细看一次后,你们就会发现findAndAddClassesInPackageByFile这个函数就是他本生。
哈哈。。。
11 楼
dyy_gusi
2013-12-16
yznxing 写道
laser_lu 写道
貌似缺一个函数。。
额。。貌似是的。。
findAndAddClassesInPackageByFile
你们看的都很认真,但是当你们再仔细看一次后,你们就会发现findAndAddClassesInPackageByFile这个函数就是他本生。
10 楼
RednaxelaFX
2012-09-04
502220545 写道
19. dirs = Thread.currentThread().getContextClassLoader().getResources(
20. packageDirName);
那个返回值是一个URL实例啊 能放到枚举中吗???
返回URL的是getResource,没s
9 楼
502220545
2012-09-04
19. dirs = Thread.currentThread().getContextClassLoader().getResources(
20. packageDirName);
那个返回值是一个URL实例啊 能放到枚举中吗???
8 楼
caodaoxi
2011-11-02
好文章 我拿走了啊 谢了 受益匪浅
7 楼
long502147
2011-10-27
一直在找这个 呵呵!
5 楼
icewubin
2010-10-26
Thread.currentThread().getContextClassLoader()最好缓存一下,这个调用太多的话,会减慢扫描速度的,如果扫描量很多的话,一定要缓存一下。
4 楼
yznxing
2010-10-26
icewubin 写道
findAndAddClassesInPackageByFile不应该用classes.add(Class.forName(packageName + '.' + className));,而应该用
classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
Class.forName会触发该类中的static代码的。
恩 呵呵,很细心哇你!~
这就是class.forname 和 用classload的loadClass的区别了。
恩 , 记录在这里~~~
3q~~~
3 楼
icewubin
2010-10-26
findAndAddClassesInPackageByFile不应该用classes.add(Class.forName(packageName + '.' + className));,而应该用
classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
Class.forName会触发该类中的static代码的。
2 楼
yznxing
2010-05-27
laser_lu 写道
貌似缺一个函数。。
额。。貌似是的。。
findAndAddClassesInPackageByFile
1 楼
laser_lu
2010-05-26
貌似缺一个函数。。
转载地址:https://blog.csdn.net/weixin_34262786/article/details/114099262 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!