java實現(xiàn)一個掃描包的工具類實例代碼
更新時間:2017年10月17日 11:03:15 作者:蔣固金
很多框架,比如springmvc,mybatis等使用注解,為了處理注解,必然要對包進行掃描,所以下面這篇文章主要給大家分享介紹了關(guān)于利用java如何實現(xiàn)一個掃描包的工具類,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下。
前言
在很多的實際場景中,我們需要得到某個包名下面所有的類,比如我們在使用SpringMVC的時候,知道SpringMVC可以掃描指定包下的所有類,在平時的開發(fā)中,我們也有這樣的場景,所以今天寫一個掃描包的工具類,分享出來供大家參考學習,下面話不多說了,來一起看看詳細的介紹吧。
代碼如下:
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 List<String> packageNames = new ArrayList<String>();
/** 過濾器 **/
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)
{
// 獲取包的名字 并進行替換
String packageDirName = packageName.replace('.', '/');
// 定義一個枚舉的集合 并進行循環(huán)來處理這個目錄下的things
Enumeration<URL> 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<JarEntry> entries = jar.entries();
// 同樣的進行循環(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
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
SpringBoot利用隨機鹽值實現(xiàn)密碼的加密與驗證
這篇文章主要為大家詳細介紹了SpringBoot如何利用隨機鹽值實現(xiàn)密碼的加密與驗證,文中的示例代碼講解詳細,有需要的小伙伴可以參考下2024-02-02
IDEA報錯"Cannot?resolve?symbol"問題的解決辦法
早上來了,打開idea發(fā)現(xiàn)注解等都變紅報錯can’t resolvesymbol,由于這個錯之前也報過,所以記錄一下,這篇文章主要給大家介紹了關(guān)于IDEA報錯"Cannot?resolve?symbol"問題的解決辦法,需要的朋友可以參考下2023-11-11

