cn.dceast.platform.task.util.ClassScanner Maven / Gradle / Ivy
The newest version!
package cn.dceast.platform.task.util;
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.List;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.regex.Pattern;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class ClassScanner {
/**
* logger
*/
private static final Logger logger = LoggerFactory.getLogger(ClassScanner.class);
/**
* 是否排除内部类 true->是 false->否
*/
private boolean excludeInner = true;
/**
* 过滤规则适用情况 true—>搜索符合规则的 false->排除符合规则的
*/
private boolean checkInOrEx = true;
/**
* 过滤规则列表 如果是null或者空，即全部符合不过滤
*/
private List classFilters = null;
public ClassScanner() {
}
/**
* 扫描包
* @param basePackage 基础包
* @param recursive 是否递归搜索子包
* @return Set
*/
public Set> getClassOfPackage(String basePackage,boolean recursive) {
Set> classes = new LinkedHashSet>();
String packageName = basePackage;
if (packageName.endsWith(".")) {
packageName = packageName.substring(0, packageName.lastIndexOf('.'));
}
String package2Path = packageName.replace('.', '/');
Enumeration dirs;
try {
dirs = Thread.currentThread().getContextClassLoader().getResources(
package2Path);
while (dirs.hasMoreElements()) {
URL url = dirs.nextElement();
String protocol = url.getProtocol();
if ("file".equals(protocol)) {
String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
doScanPackageClassesByFile(classes, packageName, filePath,
recursive);
} else if ("jar".equals(protocol)) {
doScanPackageClassesByJar(packageName, url, recursive,
classes);
}
}
} catch (IOException e) {
logger.error("IOException error:", e);
}
return classes;
}
/**
* 以jar的方式扫描包下的所有Class文件
* @param basePackage eg：michael.utils.
* @param url
* @param recursive
* @param classes
*/
private void doScanPackageClassesByJar(String basePackage, URL url,
final boolean recursive, Set> classes) {
String packageName = basePackage;
String package2Path = packageName.replace('.', '/');
logger.debug(packageName+"size:"+packageName.length());
JarFile jar;
try {
jar = ((JarURLConnection) url.openConnection()).getJarFile();
Enumeration entries = jar.entries();
while (entries.hasMoreElements()) {
JarEntry entry = entries.nextElement();
String name = entry.getName();
if (!name.startsWith(package2Path) || entry.isDirectory()) {
continue;
}
// 判断是否递归搜索子包
if (!recursive
&& name.lastIndexOf('/') != package2Path.length()) {
continue;
}
// 判断是否过滤 inner class
if (this.excludeInner && name.indexOf('$') != -1) {
logger.info("exclude inner class with name:" + name);
continue;
}
String classSimpleName = name
.substring(name.lastIndexOf('/') + 1);
// 判定是否符合过滤条件
if (this.filterClassName(classSimpleName)) {
String className = name.replace('/', '.');
className = className.substring(0, className.length() - 6);
try {
classes.add(Thread.currentThread()
.getContextClassLoader().loadClass(className));
} catch (ClassNotFoundException e) {
logger.error("Class.forName error:", e);
}
}
}
} catch (IOException e) {
logger.error("IOException error:", e);
}
}
/**
* 以文件的方式扫描包下的所有Class文件
*
* @param packageName
* @param packagePath
* @param recursive
* @param classes
*/
private void doScanPackageClassesByFile(Set> classes,
String packageName, String packagePath, boolean recursive) {
logger.debug( packageName +"size:"+packageName.length());
File dir = new File(packagePath);
if (!dir.exists() || !dir.isDirectory()) {
return;
}
final boolean fileRecursive = recursive;
File[] dirfiles = dir.listFiles(new FileFilter() {
// 自定义文件过滤规则
public boolean accept(File file) {
if (file.isDirectory()) {
return fileRecursive;
}
String filename = file.getName();
if (excludeInner && filename.indexOf('$') != -1) {
logger.info("exclude inner class with name:" + filename);
return false;
}
return filterClassName(filename);
}
});
for (File file : dirfiles) {
if (file.isDirectory()) {
//默认传空值进来时，需要判断是否在packageName后面加上.分隔，如果是空则会造成packageName递归时变成 .com.dc.xx
String nextPkg = (packageName.length()==0)?(file.getName()):(packageName + "." + file.getName());
logger.debug( nextPkg+"\n\n");
doScanPackageClassesByFile(classes,nextPkg, file.getAbsolutePath(), recursive);
} else {
String className = file.getName().substring(0,
file.getName().length() - 6);
try {
classes.add(Thread.currentThread().getContextClassLoader()
.loadClass(packageName + '.' + className));
} catch (ClassNotFoundException e) {
logger.error("IOException error:", e);
}
}
}
}
/**
* 根据过滤规则判断类名
* @param className
* @return
*/
private boolean filterClassName(String className) {
if (!className.endsWith(".class")) {
return false;
}
if (null == this.classFilters || this.classFilters.isEmpty()) {
return true;
}
String tmpName = className.substring(0, className.length() - 6);
boolean flag = false;
for (String str : classFilters) {
String tmpreg = "^" + str.replace("*", ".*") + "$";
Pattern p = Pattern.compile(tmpreg);
if (p.matcher(tmpName).find()) {
flag = true;
break;
}
}
return (checkInOrEx && flag) || (!checkInOrEx && !flag);
}
/**
* @return the excludeInner
*/
public boolean isExcludeInner() {
return excludeInner;
}
/**
* @return the checkInOrEx
*/
public boolean isCheckInOrEx() {
return checkInOrEx;
}
/**
* @return the classFilters
*/
public List getClassFilters() {
return classFilters;
}
/**
* @param pExcludeInner the excludeInner to set
*/
public void setExcludeInner(boolean pExcludeInner) {
excludeInner = pExcludeInner;
}
/**
* @param pCheckInOrEx the checkInOrEx to set
*/
public void setCheckInOrEx(boolean pCheckInOrEx) {
checkInOrEx = pCheckInOrEx;
}
/**
* @param pClassFilters the classFilters to set
*/
public void setClassFilters(List pClassFilters) {
classFilters = pClassFilters;
}
/**
* @param args
*/
// public static void main(String[] args) {
//
// // 创建一个扫描处理器，排除内部类 扫描符合条件的类
// ClassUtil handler = new ClassUtil();
//
// System.out.println("开始递归扫描jar文件的包：cn.dceast.platform.task 下符合自定义过滤规则的类...");
// Set> calssList = handler.getClassOfPackage(
// "cn.dceast.platform.task", true);
// for (Class cla : calssList) {
// System.out.println(cla.getName());
// }
//
// }
}