全棧的自我修養: 0004 Java 包掃描實現和應用(File篇)
I may not be able to change the past, but I can learn from it.
我也許不能改變過去發生的事情，但能向過去學習。
Table of Contents
如果你曾經使用過 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);
}
}
}
}
}