不會吧，有人用了兩年Spring, 竟然不知道包掃描是怎麼實現的

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 遍歷方式能夠簡單實現一部分包掃描，那咱們定義個掃描器應該有的功能和特定吧

1. 能夠根據指定的包進行掃描
2. 能夠排除一些類或者包名
3. 能夠過濾一些包或者類

關於過濾可使用 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('.', '/');</pre>
複製代碼

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.mapper.UserMapper
org.example.App
org.example.ClassScanner</pre>
複製代碼

完整代碼

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);
        }
      }
    }
  }
}
複製代碼