java实现一个扫描包的工具类实例代码
前言
在很多的实际场景中，我们需要得到某个包名下面所有的类，比如我们在使用SpringMVC的时候，知道SpringMVC可以扫描指定包下的所有类，在平时的开发中，我们也有这样的场景，所以今天写一个扫描包的工具类，分享出来供大家参考学习，下面话不多说了，来一起看看详细的介绍吧。
代码如下：
packagecom.gujin.utils;
importjava.io.File;
importjava.io.FileFilter;
importjava.io.IOException;
importjava.net.JarURLConnection;
importjava.net.URL;
importjava.net.URLDecoder;
importjava.util.ArrayList;
importjava.util.Enumeration;
importjava.util.List;
importjava.util.jar.JarEntry;
importjava.util.jar.JarFile;
publicclassHQScanPackage
{
/**是否循环迭代**/
booleanrecursive=true;
/**包名集合**/
privateListpackageNames=newArrayList();
/**过滤器**/
privateHQScanPackageFilterfilter=null;
/**监听器**/
privateHQScanPackageListenerlistener=null;
/**
*是否循环迭代
*
*@return
*/
publicbooleanisRecursive()
{
returnrecursive;
}
/**
*设置是否循环迭代
*
*@paramrecursive
*/
publicvoidsetRecursive(booleanrecursive)
{
this.recursive=recursive;
}
/**
*获得过滤器
*
*@return
*/
publicHQScanPackageFiltergetFilter()
{
returnfilter;
}
/**
*设置过滤器
*
*@paramfilter
*/
publicvoidsetFilter(HQScanPackageFilterfilter)
{
this.filter=filter;
}
/**
*获得监听器
*
*@return
*/
publicHQScanPackageListenergetListener()
{
returnlistener;
}
/**
*设置监听器
*
*@paramlistener
*/
publicvoidsetListener(HQScanPackageListenerlistener)
{
this.listener=listener;
}
/**
*添加扫描包
*
*@parampackageName
*/
publicvoidaddPackage(StringpackageName)
{
if(packageName==null||!packageName.matches("[\\w]+(\\.[\\w]+)*"))
{
thrownewIllegalArgumentException("非法包名.");
}
this.packageNames.add(packageName);
}
/**
*清空扫描包
*/
publicvoidclearPackage()
{
this.packageNames.clear();
}
/**
*扫描
*/
publicvoidscan()
{
for(StringpackageName:packageNames)
{
scan(packageName);
}
}
/**
*是否接受
*
*@paramclazz
*@return
*/
privatebooleanaccept(Classclazz)
{
if(this.filter!=null)
{
returnthis.filter.accept(clazz);
}
returntrue;
}
/**
*触发扫描到合法类
*
*@paramclazz
*@return
*/
privatevoidtrrigerOnScanClass(Classclazz)
{
if(this.listener!=null)
{
this.listener.onScanClass(clazz);
}
}
/**
*扫描到类
*
*@paramclazz
*@return
*/
privatevoidonScanClass(Classclazz)
{
if(accept(clazz))
{
trrigerOnScanClass(clazz);
}
}
/**
*从包package中获取所有的Class
*
*@parampackageName
*@return
*/
privatevoidscan(StringpackageName)
{
//获取包的名字并进行替换
StringpackageDirName=packageName.replace('.','/');
//定义一个枚举的集合并进行循环来处理这个目录下的things
Enumerationdirs=null;
try
{
dirs=Thread.currentThread().getContextClassLoader()
.getResources(packageDirName);
//循环迭代下去
while(dirs.hasMoreElements())
{
//获取下一个元素
URLurl=dirs.nextElement();
//得到协议的名称
Stringprotocol=url.getProtocol();
//如果是以文件的形式保存在服务器上
if("file".equals(protocol))
{
//获取包的物理路径
StringfilePath=URLDecoder.decode(url.getFile(),"UTF-8");
//以文件的方式扫描整个包下的文件并添加到集合中
findAndAddClassesInPackageByFile(packageName,filePath);
}
elseif("jar".equals(protocol))
{
//如果是jar包文件
//定义一个JarFile
JarFilejar=null;
try
{
//获取jar
jar=((JarURLConnection)url.openConnection()).getJarFile();
//从此jar包得到一个枚举类
Enumerationentries=jar.entries();
//同样的进行循环迭代
while(entries.hasMoreElements())
{
//获取jar里的一个实体可以是目录和一些jar包里的其他文件如META-INF等文件
JarEntryentry=entries.nextElement();
Stringname=entry.getName();
//如果是以/开头的
if(name.charAt(0)=='/')
{
//获取后面的字符串
name=name.substring(1);
}
//如果前半部分和定义的包名相同
if(name.startsWith(packageDirName))
{
intidx=name.lastIndexOf('/');
//如果以"/"结尾是一个包
if(idx!=-1)
{
//获取包名把"/"替换成"."
packageName=name.substring(0,idx).replace('/',
'.');
}
//如果可以迭代下去并且是一个包
if((idx!=-1)||recursive)
{
//如果是一个.class文件而且不是目录
if(name.endsWith(".class")&&!entry.isDirectory())
{
//去掉后面的".class"获取真正的类名
StringclassName=name.substring(
packageName.length()+1,
name.length()-6);
try
{
//添加到classes
//使用Class.forName会触发类静态方法
Classclazz=Thread.currentThread()
.getContextClassLoader().loadClass(
packageName+'.'+className);
onScanClass(clazz);
}
catch(ClassNotFoundExceptione)
{
System.err.println("加载类出错");
}
}
}
}
}
}
catch(IOExceptione)
{
System.err.println("在扫描用户定义视图时从jar包获取文件出错");
e.printStackTrace();
}
}
}
}
catch(IOExceptione)
{
System.err.println("扫描出错");
e.printStackTrace();
}
}
/**
*以文件的形式来获取包下的所有Class
*
*@parampackageName
*@parampackagePath
*/
privatevoidfindAndAddClassesInPackageByFile(StringpackageName,
StringpackagePath)
{
//获取此包的目录建立一个File
Filedir=newFile(packagePath);
//如果不存在或者也不是目录就直接返回
if(!dir.exists()||!dir.isDirectory())
{
System.err.println("用户定义包名"+packageName+"下没有任何文件");
return;
}
//如果存在就获取包下的所有文件包括目录
File[]dirfiles=dir.listFiles(newFileFilter()
{
//自定义过滤规则如果可以循环(包含子目录)或则是以.class结尾的文件(编译好的java类文件)
publicbooleanaccept(Filefile)
{
return(recursive&&file.isDirectory())
||(file.getName().endsWith(".class"));
}
});
//循环所有文件
for(Filefile:dirfiles)
{
//如果是目录则继续扫描
if(file.isDirectory())
{
findAndAddClassesInPackageByFile(packageName+"."+file.getName(),
file.getAbsolutePath());
}
else
{
//如果是java类文件去掉后面的.class只留下类名
StringclassName=file.getName().substring(0,
file.getName().length()-6);
try
{
Classclazz=Thread.currentThread().getContextClassLoader()
.loadClass(packageName+'.'+className);
onScanClass(clazz);
}
catch(ClassNotFoundExceptione)
{
System.err.println("添加用户自定义视图类错误找不到此类的.class文件");
e.printStackTrace();
}
}
}
}
/**
*扫描包过滤器
*
*@authorjianggujin
*
*/
publicstaticinterfaceHQScanPackageFilter
{
/**
*是否接受
*
*@paramclazz
*@return
*/
publicbooleanaccept(Classclazz);
}
/**
*扫描包监听
*
*@authorjianggujin
*
*/
publicstaticinterfaceHQScanPackageListener
{
/**
*扫描到合法类执行
*
*@paramclazz
*/
publicvoidonScanClass(Classclazz);
}
publicstaticvoidmain(String[]args)
{
HQScanPackagescanPackage=newHQScanPackage();
scanPackage.addPackage(HQScanPackage.class.getPackage().getName());
scanPackage.setFilter(newHQScanPackageFilter()
{
@Override
publicbooleanaccept(Classclazz)
{
returntrue;
}
});
scanPackage.setListener(newHQScanPackageListener()
{
@Override
publicvoidonScanClass(Classclazz)
{
System.out.println(clazz);
}
});
scanPackage.scan();
}
}
运行可以得到如下结果：
classcom.gujin.utils.HQScanPackage$1 classcom.gujin.utils.HQScanPackage$2 classcom.gujin.utils.HQScanPackage$3 interfacecom.gujin.utils.HQScanPackage$HQScanPackageFilter interfacecom.gujin.utils.HQScanPackage$HQScanPackageListener classcom.gujin.utils.HQScanPackage
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对毛票票的支持。