背景

用過spring框架之后，有個指定掃描包路徑，然后自動實例化一些bean，這個過程還是比較有意思的，抽象一下，即下面三個點

如何掃描包路徑下所有的class文件

如何掃描jar包中對應包路徑下所有的class文件

如何加載class文件

實現

目標

我們的目標是給定一個包路徑，然后加載這個包路徑下的所有class

考慮兩種場景

包路徑為依賴第三方jar包中的

包路徑為自己的業務代碼中的 --》 常見的一種是業務代碼會編譯成class文件，即掃描文件

實現

針對上面兩種場景，分開說明

1. 掃描文件

實現流程比較清晰：

根據包名，獲取絕對地址，直接進入包對應的目錄

掃描目錄下所有文件

加載所有的class文件；

如果是目錄，迭代遍歷目錄下的class文件

加載class文件

獲取包對應的絕對地址，這里先不說，下面直接給出進入目錄，加載所有class文件的代碼

/**

* 掃描包路徑下的所有class文件

*

* @param pkgName 包名

* @param pkgPath 包對應的絕對地址

* @param classes 保存包路徑下class的集合

*/

private static void findClassesByFile(String pkgName, String pkgPath, Set> classes) {

File dir = new File(pkgPath);

if (!dir.exists() || !dir.isDirectory()) {

return;

}

// 過濾獲取目錄，or class文件

File[] dirfiles = dir.listFiles(pathname -> pathname.isDirectory() || pathname.getName().endsWith("class"));

if (dirfiles == null || dirfiles.length == 0) {

return;

}

String className;

Class clz;

for (File f : dirfiles) {

if (f.isDirectory()) {

findClassesByFile(pkgName + "." + f.getName(),

pkgPath + "/" + f.getName(),

classes);

continue;

}

// 獲取類名，干掉 ".class" 后綴

className = f.getName();

className = className.substring(0, className.length() - 6);

// 加載類

clz = loadClass(pkgName + "." + className);

if (clz != null) {

classes.add(clz);

}

}

}

2. 掃描jar

流程和上面一樣，實現上稍稍有些區別，由之前的掃描文件變成遍歷JarFile

/**

* 掃描包路徑下的所有class文件

*

* @param pkgName 包名

* @param jar jar文件

* @param classes 保存包路徑下class的集合

*/

private static void findClassesByJar(String pkgName, JarFile jar, Set> classes) {

String pkgDir = pkgName.replace(".", "/");

Enumeration entry = jar.entries();

JarEntry jarEntry;

String name, className;

Class> claze;

while (entry.hasMoreElements()) {

jarEntry = entry.nextElement();

name = jarEntry.getName();

if (name.charAt(0) == '/') {

name = name.substring(1);

}

if (jarEntry.isDirectory() || !name.startsWith(pkgDir) || !name.endsWith(".class")) {

// 非指定包路徑， 非class文件

continue;

}

// 去掉后面的".class", 將路徑轉為package格式

className = name.substring(0, name.length() - 6);

claze = loadClass(className.replace("/", "."));

if (claze != null) {

classes.add(claze);

}

}

}

3. 掃描包

上面是具體的掃class文件的過程，那么如何根據包獲取對應的jarFile or 包對應的絕對地址呢？

主要利用的是 XXX.class.getClassLoader().getResources(package), 具體如下

/**

* 掃描包路徑下所有的class文件

*

* @param pkg

* @return

*/

public static Set> getClzFromPkg(String pkg) {

Set> classes = new LinkedHashSet<>();

String pkgDirName = pkg.replace('.', '/');

try {

Enumeration urls = PkgUtil.class.getClassLoader().getResources(pkgDirName);

while (urls.hasMoreElements()) {

URL url = urls.nextElement();

String protocol = url.getProtocol();

if ("file".equals(protocol)) {// 如果是以文件的形式保存在服務器上

String filePath = URLDecoder.decode(url.getFile(), "UTF-8");// 獲取包的物理路徑

findClassesByFile(pkg, filePath, classes);

} else if ("jar".equals(protocol)) {// 如果是jar包文件

JarFile jar = ((JarURLConnection) url.openConnection()).getJarFile();

findClassesByJar(pkg, jar, classes);

}

}

} catch (IOException e) {

e.printStackTrace();

}

return classes;

}

4. 類加載

這個還是比較簡單的，一搜一大把，直接貼出

private static Class> loadClass(String fullClzName) {

try {

return Thread.currentThread().getContextClassLoader().loadClass(fullClzName);

} catch (ClassNotFoundException e) {

log.error("load class error! clz: {}, e:{}", fullClzName, e);

}

return null;

}

測試

要愉快的測試這一功能，你可以選擇一個jar包，如 org.slf4j, 然后自己創建幾個測試類，包名也是已 org.slf4j開頭，然后調用上面的方法

Class> set = PkgUtil.getClzFromPkg("org.slf4j");

因為這個工具類我是放在 quick-mvc 工程的，所以就直接使用了我定義的包 com.hust.hui，因為沒啥通用性，就給出本機測試的演示圖好了

其他

公眾號獲取更多: