共计 5652 个字符，预计需要花费 15 分钟才能阅读完成。
<h1> 全栈的自我涵养: 0004 Java 包扫描实现和利用(File 篇) </h1>
I may not be able to change the past, but I can learn from it.
我兴许不能扭转过来产生的事件，但能向过来学习。
@[TOC]
如果你已经应用过 Spring, 那你曾经配过 包扫描门路吧，那包扫描是怎么实现的呢？让咱们本人写个包扫描
用处
基于Java 的反射机制，咱们很容易依据 class 去创立一个实例对象，但如果咱们基本不晓得某个包下有多少对象时，咱们应该怎么做呢？
在应用 Spring 框架时，会依据包扫描门路来找到所有的 class, 并将其实例化后存入容器中。
在咱们的我的项目中也会遇到这样的场景，比方某个包为 org.example.plugins, 这个外面放着所有的插件，为了不每次增减插件都要手动批改代码，咱们可能会想到用扫描的形式去动静获知 org.example.plugins 到底有多少 class, 当然利用场景很有很多
思路
在一开始的咱们为了上传文件和下载文件这种需要，申请会在程序运行的时候去获取以后我的项目运行的父门路是什么，比方上面的代码 `
应用 Class 类的 getResource(“”).getPath()获取以后.class 文件所在的门路, 或者应用 File` 来实现
// 实例化一个 File 对象。参数不同时，获取的最终后果也不同, 这里能够将 path 替换为要扫描的包路劲 例如 org/example
String path = "";
File directory = new File(path);
// 获取规范门路。该办法须要搁置在 try/catch 块中，或申明抛出异样
directory.getCanonicalPath();
// 获取绝对路径
directory.getAbsolutePath();其中传入指定门路
Enumeration<URL> resources = Thread.currentThread().getContextClassLoader().getResources("org/example");
while (resources.hasMoreElements()) {URL url = resources.nextElement();
System.out.println(url.toString());
}输入为
file:/Users/zhangyunan/project/spring-demo/java8-demo/target/test-classes/org/example
file:/Users/zhangyunan/project/spring-demo/java8-demo/target/classes/org/example
一些小性能
通过下面的代码，咱们能够大略晓得应用 File 遍历形式能够简略实现一部分包扫描，那咱们定义个扫描器应该有的性能和特定吧
- 能够依据指定的包进行扫描
- 能够排除一些类或者包名
- 能够过滤一些包或者类
对于过滤能够应用 Java8 的 Predicate 来实现，
简要设计
/**
* class 扫描器
*
* @author zhangyunan
*/
public class ClassScanner {
/**
* 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) { }
/**
* Do scan all classes set.
*
* @return the set
*/
public Set<Class<?>> doScanAllClasses() {return null;}
}具体实现
1. 将包门路转换为文件门路
当咱们要扫描一个 org.example 包时，首先将其转换为文件格式 org/example, 来应用File 遍历形式
String basePackage = "org.example";
// 如果最初一个字符是“.”，则去掉
if (basePackage.endsWith(".")) {basePackage = basePackage.substring(0, basePackage.lastIndexOf('.'));
}
// 将包名中的“.”换成零碎文件夹的“/”String basePackageFilePath = basePackage.replace('.', '/');2. 获取实在的门路
Enumeration<URL> resources = Thread.currentThread().getContextClassLoader().getResources(basePackageFilePath);
while (resources.hasMoreElements()) {URL resource = resources.nextElement();
}这里须要关注下 resource 的类型, 如果是 File 和 Jar 则进行解析，这篇文章次要进行 File 操作
3. 辨认文件，并进行递归遍历
String protocol = resource.getProtocol();
if ("file".equals(protocol)) {String filePath = URLDecoder.decode(resource.getFile(), "UTF-8");
// 扫描文件夹中的包和类
doScanPackageClassesByFile(classes, packageName, filePath, recursive);
}
测试
我的项目构造
@Test
public void testGetPackageAllClasses() throws IOException, ClassNotFoundException {
Predicate<String> packagePredicate = s -> true;
ClassScanner scanner = new ClassScanner("org.example", true, packagePredicate, null);
Set<Class<?>> packageAllClasses = scanner.doScanAllClasses();
packageAllClasses.forEach(it -> {System.out.println(it.getName());
});
}后果
org.example.ClassScannerTest
org.example.mapper.UserMapper
org.example.App
org.example.ClassScanner残缺代码
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
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;
/**
* 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, recursive);
}
}
return classes;
}
/**
* 在文件夹中扫描包和类
*/
private void doScanPackageClassesByFile(Set<Class<?>> classes, String packageName, String packagePath,
boolean recursive) throws ClassNotFoundException {
// 转为文件
File dir = new File(packagePath);
if (!dir.exists() || !dir.isDirectory()) {return;}
final boolean fileRecursive = recursive;
// 列出文件，进行过滤
// 自定义文件过滤规定
File[] dirFiles = dir.listFiles((FileFilter) file -> {String filename = file.getName();
if (file.isDirectory()) {if (!fileRecursive) {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(), recursive);
} 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);
}
}
}
}
}正文完