小編給大家分享一下java如何實現(xiàn)一個掃描包的工具類,相信大部分人都還不怎么了解,因此分享這篇文章給大家參考一下,希望大家閱讀完這篇文章后大有收獲,下面讓我們一起去了解一下吧!
詔安ssl適用于網(wǎng)站、小程序/APP、API接口等需要進(jìn)行數(shù)據(jù)傳輸應(yīng)用場景,ssl證書未來市場廣闊!成為成都創(chuàng)新互聯(lián)公司的ssl證書銷售渠道,可以享受市場價格4-6折優(yōu)惠!如果有意向歡迎電話聯(lián)系或者加微信:13518219792(備注:SSL證書合作)期待與您的合作!
前言
在很多的實際場景中,我們需要得到某個包名下面所有的類,比如我們在使用SpringMVC的時候,知道SpringMVC可以掃描指定包下的所有類,
代碼如下:
package com.gujin.utils; import java.io.File; import java.io.FileFilter; import java.io.IOException; import java.net.JarURLConnection; import java.net.URL; import java.net.URLDecoder; import java.util.ArrayList; import java.util.Enumeration; import java.util.List; import java.util.jar.JarEntry; import java.util.jar.JarFile; public class HQScanPackage { /** 是否循環(huán)迭代 **/ boolean recursive = true; /** 包名集合 **/ private ListpackageNames = new ArrayList (); /** 過濾器 **/ private HQScanPackageFilter filter = null; /** 監(jiān)聽器 **/ private HQScanPackageListener listener = null; /** * 是否循環(huán)迭代 * * @return */ public boolean isRecursive() { return recursive; } /** * 設(shè)置是否循環(huán)迭代 * * @param recursive */ public void setRecursive(boolean recursive) { this.recursive = recursive; } /** * 獲得過濾器 * * @return */ public HQScanPackageFilter getFilter() { return filter; } /** * 設(shè)置過濾器 * * @param filter */ public void setFilter(HQScanPackageFilter filter) { this.filter = filter; } /** * 獲得監(jiān)聽器 * * @return */ public HQScanPackageListener getListener() { return listener; } /** * 設(shè)置監(jiān)聽器 * * @param listener */ public void setListener(HQScanPackageListener listener) { this.listener = listener; } /** * 添加掃描包 * * @param packageName */ public void addPackage(String packageName) { if (packageName == null || !packageName.matches("[\\w]+(\\.[\\w]+)*")) { throw new IllegalArgumentException("非法包名."); } this.packageNames.add(packageName); } /** * 清空掃描包 */ public void clearPackage() { this.packageNames.clear(); } /** * 掃描 */ public void scan() { for (String packageName : packageNames) { scan(packageName); } } /** * 是否接受 * * @param clazz * @return */ private boolean accept(Class> clazz) { if (this.filter != null) { return this.filter.accept(clazz); } return true; } /** * 觸發(fā)掃描到合法類 * * @param clazz * @return */ private void trrigerOnScanClass(Class> clazz) { if (this.listener != null) { this.listener.onScanClass(clazz); } } /** * 掃描到類 * * @param clazz * @return */ private void onScanClass(Class> clazz) { if (accept(clazz)) { trrigerOnScanClass(clazz); } } /** * 從包package中獲取所有的Class * * @param packageName * @return */ private void scan(String packageName) { // 獲取包的名字 并進(jìn)行替換 String packageDirName = packageName.replace('.', '/'); // 定義一個枚舉的集合 并進(jìn)行循環(huán)來處理這個目錄下的things Enumeration dirs = null; try { dirs = Thread.currentThread().getContextClassLoader() .getResources(packageDirName); // 循環(huán)迭代下去 while (dirs.hasMoreElements()) { // 獲取下一個元素 URL url = dirs.nextElement(); // 得到協(xié)議的名稱 String protocol = url.getProtocol(); // 如果是以文件的形式保存在服務(wù)器上 if ("file".equals(protocol)) { // 獲取包的物理路徑 String filePath = URLDecoder.decode(url.getFile(), "UTF-8"); // 以文件的方式掃描整個包下的文件 并添加到集合中 findAndAddClassesInPackageByFile(packageName, filePath); } else if ("jar".equals(protocol)) { // 如果是jar包文件 // 定義一個JarFile JarFile jar = null; try { // 獲取jar jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 從此jar包 得到一個枚舉類 Enumeration entries = jar.entries(); // 同樣的進(jìn)行循環(huán)迭代 while (entries.hasMoreElements()) { // 獲取jar里的一個實體 可以是目錄 和一些jar包里的其他文件 如META-INF等文件 JarEntry entry = entries.nextElement(); String name = entry.getName(); // 如果是以/開頭的 if (name.charAt(0) == '/') { // 獲取后面的字符串 name = name.substring(1); } // 如果前半部分和定義的包名相同 if (name.startsWith(packageDirName)) { int idx = name.lastIndexOf('/'); // 如果以"/"結(jié)尾 是一個包 if (idx != -1) { // 獲取包名 把"/"替換成"." packageName = name.substring(0, idx).replace('/', '.'); } // 如果可以迭代下去 并且是一個包 if ((idx != -1) || recursive) { // 如果是一個.class文件 而且不是目錄 if (name.endsWith(".class") && !entry.isDirectory()) { // 去掉后面的".class" 獲取真正的類名 String className = name.substring( packageName.length() + 1, name.length() - 6); try { // 添加到classes // 使用Class.forName會觸發(fā)類靜態(tài)方法 Class> clazz = Thread.currentThread() .getContextClassLoader().loadClass( packageName + '.' + className); onScanClass(clazz); } catch (ClassNotFoundException e) { System.err.println("加載類出錯"); } } } } } } catch (IOException e) { System.err.println("在掃描用戶定義視圖時從jar包獲取文件出錯"); e.printStackTrace(); } } } } catch (IOException e) { System.err.println("掃描出錯"); e.printStackTrace(); } } /** * 以文件的形式來獲取包下的所有Class * * @param packageName * @param packagePath */ private void findAndAddClassesInPackageByFile(String packageName, String packagePath) { // 獲取此包的目錄 建立一個File File dir = new File(packagePath); // 如果不存在或者 也不是目錄就直接返回 if (!dir.exists() || !dir.isDirectory()) { System.err.println("用戶定義包名 " + packageName + " 下沒有任何文件"); return; } // 如果存在 就獲取包下的所有文件 包括目錄 File[] dirfiles = dir.listFiles(new FileFilter() { // 自定義過濾規(guī)則 如果可以循環(huán)(包含子目錄) 或則是以.class結(jié)尾的文件(編譯好的java類文件) public boolean accept(File file) { return (recursive && file.isDirectory()) || (file.getName().endsWith(".class")); } }); // 循環(huán)所有文件 for (File file : dirfiles) { // 如果是目錄 則繼續(xù)掃描 if (file.isDirectory()) { findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath()); } else { // 如果是java類文件 去掉后面的.class 只留下類名 String className = file.getName().substring(0, file.getName().length() - 6); try { Class> clazz = Thread.currentThread().getContextClassLoader() .loadClass(packageName + '.' + className); onScanClass(clazz); } catch (ClassNotFoundException e) { System.err.println("添加用戶自定義視圖類錯誤 找不到此類的.class文件"); e.printStackTrace(); } } } } /** * 掃描包過濾器 * * @author jianggujin * */ public static interface HQScanPackageFilter { /** * 是否接受 * * @param clazz * @return */ public boolean accept(Class> clazz); } /** * 掃描包監(jiān)聽 * * @author jianggujin * */ public static interface HQScanPackageListener { /** * 掃描到合法類執(zhí)行 * * @param clazz */ public void onScanClass(Class> clazz); } public static void main(String[] args) { HQScanPackage scanPackage = new HQScanPackage(); scanPackage.addPackage(HQScanPackage.class.getPackage().getName()); scanPackage.setFilter(new HQScanPackageFilter() { @Override public boolean accept(Class> clazz) { return true; } }); scanPackage.setListener(new HQScanPackageListener() { @Override public void onScanClass(Class> clazz) { System.out.println(clazz); } }); scanPackage.scan(); } }
運行可以得到如下結(jié)果:
class com.gujin.utils.HQScanPackage$1 class com.gujin.utils.HQScanPackage$2 class com.gujin.utils.HQScanPackage$3 interface com.gujin.utils.HQScanPackage$HQScanPackageFilter interface com.gujin.utils.HQScanPackage$HQScanPackageListener class com.gujin.utils.HQScanPackage
以上是“java如何實現(xiàn)一個掃描包的工具類”這篇文章的所有內(nèi)容,感謝各位的閱讀!相信大家都有了一定的了解,希望分享的內(nèi)容對大家有所幫助,如果還想學(xué)習(xí)更多知識,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道!