Java包掃描及其工具制作

包掃描

1. 背景

在一些應用場合，我們需要進行包掃描擷取某個包下的所有類或者接口，甚至是第三方jar包；典型的應用有依賴注入時需要掃描@Component注解等。

1.包掃描後應該怎樣處理，應由使用工具者考慮，是以我們制作的包掃描工具應該是一個抽象類，這裡在工具設計時，我提供了一個處理包掃描到的類的抽象方法，要求使用工具者在使用工具時實作。

2.設計思路

在傳入packageName并且已擷取URL的前提下

@先進行掃描的包是file類型還是jar包類型的判斷（調用 java.net.URL類中的public String getProtocol()方法來進行判斷）。

@如果是file類型，則調用dealDirectory(String rootPackage, File curFile) 來處理（如果是目錄，則調用dealDirectory(String rootPackage, File curFile) 遞歸處理，如果是.class檔案，則調用dealClassFile(String rootPackage, File file) 進行處理。

@如果是jar類型，則調用dealJarPackage(URL url) 進行處理。

具體實作代碼如下

package com.mec.cs_framework.util;
import java.io.File;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Enumeration;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

public abstract class PackageScanner {
	
	public abstract void dealClass(Class<?> klass);//怎樣具體處理掃描到的類應由使用者實作
												   //通過擷取klass,可以利用反射機制取得相關類的成員、方法、注解等
	
	private void dealClassFile(String rootPackage, File file) {//處理.class檔案
		String fileName = file.getName();
		if (fileName.endsWith(".class")) {
			fileName = fileName.replace(".class", "");
			try {
				Class<?> klass = Class.forName(rootPackage + "." + fileName);
				dealClass(klass);
			} catch (ClassNotFoundException e) {
				e.printStackTrace();
			}
		}
	}
	
	private void dealDirectory(String rootPackage, File curFile) {//處理目錄
		File[] fileList = curFile.listFiles();
		for (File file : fileList) {
			if (file.isDirectory()) {//是目錄，往下一級目錄繼續掃描
				dealDirectory(rootPackage + "." + file.getName(), file);
			} else if (file.isFile()) {//是檔案，則掃描目前檔案
				dealClassFile(rootPackage, file);
			}
		}
	}
	
	private void dealJarPackage(URL url) {//處理jar包
		try {
			JarURLConnection connection = (JarURLConnection) url.openConnection();
			JarFile jarFile = connection.getJarFile();
			Enumeration<JarEntry> jarEntries = jarFile.entries();//枚舉
			while (jarEntries.hasMoreElements()) {
				JarEntry jar = jarEntries.nextElement();
				if(jar.isDirectory() || !jar.getName().endsWith(".class")) {
					continue;
				}
				String jarName = jar.getName();
				jarName = jarName.replace(".class", "");
				jarName = jarName.replace("/", ".");
				
				try {
					Class<?> klass = Class.forName(jarName);
					dealClass(klass);
				} catch (ClassNotFoundException e) {
					e.printStackTrace();
				}
			}
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	
	public void packageScanner(String packageName) {
		String rootPackage = packageName;
		packageName = packageName.replace(".", "/");
		//獲得目前上下文的類加載器，得到的目前ClassPath的絕對URL路徑。
		URL url = Thread.currentThread().getContextClassLoader().getResource(packageName);
		try {
			if (url.getProtocol().equals("file")) {//驗證URL的協定,傳入檔案類型是file的處理
				URI uri = url.toURI();
				File root = new File(uri);
				dealDirectory(rootPackage, root);
			} 
			if(url.getProtocol().equals("jar")){//這裡處理的是傳入的檔案類型是jar類型
				dealJarPackage(url);
			}
		} catch (URISyntaxException e) {
			e.printStackTrace();
		}
	}
	
}


           

測試代碼及結果截圖

package com.mec.cs_framework.util;

public class Test {

	public Test() {
	}

	public static void main(String[] args) {
		new PackageScanner() {
			
			@Override
			public void dealClass(Class<?> klass) {
				System.out.println(klass);
				
			}
		}.packageScanner("com.mec.cs_framework.util");
		
		System.out.println("----------------分隔線------------");
		
		new PackageScanner() {
			
			@Override
			public void dealClass(Class<?> klass) {
				System.out.println(klass);
			}
		}.packageScanner("com.google.gson");;
	}

}

           

總結

根據傳入包名，擷取相應的URL，再調用 java.net.URL類中的public String getProtocol()方法來進行判斷傳入的包名類型，再根據此按照各自類型調用相應方法進行處理。

參考文檔：Java URL處理