java实现一个扫描包的工具类实例代码

下面是“Java实现一个扫描包的工具类实例代码”的完整攻略：

前言

Java 提供了很多方便的方式来扫描类路径下的类，比如：Class.forName()、ClassLoader.getResources() 等等，然而如果需要扫描指定包路径下的所有类，这些方式就不太方便了，本文实现一个扫描包的工具类。

思路

扫描包的思路总结为以下三个步骤：

1. 定位指定包路径下的 URL.
2. 根据 URL 获取文件.
3. 根据文件创建 Class 对象.

下面，我们将详细解释这三个步骤。

定位指定包路径下的 URL

本例中，我们将使用 Java 的类加载器、包名来完成这一步。

public static List<String> getClassName(String packageName) throws IOException {
    List<String> classNames = new ArrayList<String>();
    String packagePath = packageName.replace(".", "/");
    Enumeration<URL> urls = getClassLoader().getResources(packagePath);
    while (urls.hasMoreElements()) {
        URL url = urls.nextElement();
        if (url == null) {
            continue;
        }
        String protocol = url.getProtocol();
        if ("file".equals(protocol)) {
            String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
            findClassNameByFile(packageName, filePath, classNames);
        }
    }
    return classNames;
}

首先将包名中的“.”替换成“/”，获取包路径。然后通过调用 ClassLoader.getResources() 获取此路径下的 URL 集合，并遍历这个集合。

如果当前 URL 协议是 file，说明我们可以获取此 URL 中的文件，进一步扫描此文件。

根据 URL 获取文件

URL 获取文件的部分代码如下：

public static List<String> getClassName(String packageName) throws IOException {
    // ...
    while (urls.hasMoreElements()) {
        // ...
        String protocol = url.getProtocol();
        // ...
        if ("file".equals(protocol)) {
            // ...
            findClassNameByFile(packageName, filePath, classNames);
        }
    }
    return classNames;
}

private static void findClassNameByFile(String packageName, String packagePath, List<String> classNames) {
    File dir = new File(packagePath);
    if (!dir.exists() || !dir.isDirectory()) {
        return;
    }
    File[] dirFiles = dir.listFiles(new FileFilter() {
        public boolean accept(File file) {
            boolean acceptFlag = file.isDirectory() || (file.getName().endsWith(".class"));
            return acceptFlag;
        }
    });
    for (File file : dirFiles) {
        if (file.isDirectory()) {
            findClassNameByFile(packageName + "." + file.getName(), file.getAbsolutePath(), classNames);
        } else {
            String className = packageName + "." + file.getName().substring(0, file.getName().length() - 6);
            classNames.add(className);
        }
    }
}

这里是根据 URL 中的文件创建 File 对象，然后采用递归来遍历文件夹，最终获取到所有类的路径（这里简单处理了一下，只保留类名）。

根据文件创建 Class 对象

public static List<Class<?>> getClassList(String packageName) throws IOException, ClassNotFoundException {
    List<String> classNameList = getClassName(packageName);
    List<Class<?>> classList = new ArrayList<Class<?>>();
    for (String className : classNameList) {
        Class<?> cls = Class.forName(className);
        classList.add(cls);
    }
    return classList;
}

最后，我们可以根据文件的全限定名创建对应的 Class 对象。

示例说明

这里给出两个示例说明。

示例1

假设你有一个 Student 类，包括属性 id 和 name，以及一个 Main 类。

Student 类定义：

package com.example.test;

public class Student {
    private int id;
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

Main 类定义：

package com.example.test;

import java.io.IOException;
import java.util.List;

public class Main {
    public static void main(String[] args) throws IOException, ClassNotFoundException {
        List<Class<?>> classList = PackageUtil.getClassList("com.example.test");
        for (Class<?> cls : classList) {
            System.out.println(cls.getName());
        }
    }
}

这里的 PackageUtil 即为我们编写的工具类。

输出结果：

com.example.test.Main
com.example.test.Student

示例2

假设你有一个 StringUtils 类，包括大量的字符串处理函数，这些函数定义在一些不同的包中，你想找到这些包并统计代码行数，那么可以使用本工具类来扫描包路径。

package com.example.test;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;

public class Main {
    public static void main(String[] args) throws IOException, ClassNotFoundException {
        List<Class<?>> classList = PackageUtil.getClassList("com.example.utils");
        long lineCount = 0;
        for (Class<?> cls : classList) {
            String filePath = cls.getResource(cls.getSimpleName() + ".java").getPath();
            Path path = Paths.get(new File(filePath).toURI()).normalize();
            long fileLineCount = Files.lines(path).count();
            System.out.println(cls.getName() + " - " + fileLineCount);
            lineCount += fileLineCount;
        }
        System.out.println("total line count: " + lineCount);
    }
}

输出结果：

com.example.utils.StringUtils - 918
com.example.utils.TimeUtils - 147
total line count: 1065

以上就是实现一个扫描包的工具类实例代码的完整攻略了，希望对你有所帮助！