spring注解,在配置文件里面定义component scan package就能自动扫描对应包下面的class,然后根据注解生成相应的bean。
自己对这个功能很好奇,就搜了下,找到了实现的关键代码。
/**
* 从包package中获取所有的Class
*
* @param pack
* @return
*/
public static Set<Class<?>> getClasses(String pack) {
Set<Class<?>> classes = new LinkedHashSet<Class<?>>();// 第一个class类的集合
boolean recursive = true;// 是否循环迭代
String packageName = pack;// 获取包的名字 并进行替换
String packageDirName = packageName.replace('.', '/');
Enumeration<URL> dirs;// 定义一个枚举的集合 并进行循环来处理这个目录下的things
try {
dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
// 循环迭代下去
while (dirs.hasMoreElements()) {
// 获取下一个元素
URL url = dirs.nextElement();
// 得到协议的名称
String protocol = url.getProtocol();
// 如果是以文件的形式保存在服务器上
if ("file".equals(protocol)) {
// System.err.println("file类型的扫描");
// 获取包的物理路径
String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
// 以文件的方式扫描整个包下的文件 并添加到集合中
findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
} else if ("jar".equals(protocol)) {
// 如果是jar包文件
// 定义一个JarFile
// System.err.println("jar类型的扫描");
JarFile jar;
try {
// 获取jar
jar = ((JarURLConnection) url.openConnection()).getJarFile();
// 从此jar包 得到一个枚举类
Enumeration<JarEntry> entries = jar.entries();
// 同样的进行循环迭代
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('/');
// 如果以"/"结尾 是一个包
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
classes.add(Class.forName(packageName + '.' + className));
} catch (ClassNotFoundException e) {
// log.error("添加用户自定义视图类错误 找不到此类的.class文件");
e.printStackTrace();
}
}
}
}
}
} catch (IOException e) {
// log.error("在扫描用户定义视图时从jar包获取文件出错");
e.printStackTrace();
}
}
}
} catch (IOException e) {
e.printStackTrace();
}
return classes;
}
/**
* 以文件的形式来获取包下的所有Class
*
* @param packageName
* @param packagePath
* @param recursive
* @param classes
*/
public static void findAndAddClassesInPackageByFile(String packageName,
String packagePath, final boolean recursive, Set<Class<?>> classes) {
// 获取此包的目录 建立一个File
File dir = new File(packagePath);
// 如果不存在或者 也不是目录就直接返回
if (!dir.exists() || !dir.isDirectory()) {
// log.warn("用户定义包名 " + packageName + " 下没有任何文件");
return;
}
// 如果存在 就获取包下的所有文件 包括目录
File[] dirfiles = dir.listFiles(new FileFilter(){
// 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
public boolean accept(File file) {
return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
}
});
// 循环所有文件
for (File file : dirfiles) {
// 如果是目录 则继续扫描
if (file.isDirectory()) {
findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive,
classes);
} else {
// 如果是java类文件 去掉后面的.class 只留下类名
String className = file.getName().substring(0, file.getName().length() - 6);
try {
// 添加到集合中去
classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
}
直接拿过来用,可以扫描package对应的子package,不过是对当前classLoad下的所有jar进行扫描的。
实例:
package com.mnt.web.anoton;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.mnt.web.util.FileUtils;
/**
* 解析注解FrontCatch
*
* @author ltb
* @version 1.0
*
* 变更履历:
* v1.0 2015-4-13 ltb 初版
*/
public class FrontCacheParse {
/**
* 扫描的包列表
*/
private static String[] packageList = {
"com.mnt.web.mapping",
"com.mnt.web.controller",
"com.mnt.web.constants",
"com.mnt.communion.code"
};
@SuppressWarnings({"rawtypes", "unchecked"})
public static Map<String, Map<String, String>> parsing() {
Map<String, Map<String, String>> result = new HashMap<String, Map<String, String>>();
// 循环所有要扫描到的包 获得 这里的所有的类
List<Class<?>> allclass = new ArrayList<Class<?>>();
for (String pac : packageList) {
Set<Class<?>> sets = FileUtils.getClasses(pac);
allclass.addAll(sets);
}
// 循环所有类 如果已经标注上了 FrontCache 做解析
Map<String, String> _tmpMap = null;
for (Class clz : allclass) {
// System.out.println(clz.getName() + ": "+ clz.isAnnotationPresent(FrontCache.class));
if (clz.isAnnotationPresent(FrontCache.class)) {
FrontCache fc = (FrontCache) clz.getAnnotation(FrontCache.class);
String space = fc.space();// 获得空间
String type = fc.type();// 获得类型
_tmpMap = getAllParames(clz);// 解析属性和值
if ("jsp".equals(type)) {
for (Map.Entry<String, String> _fmap : _tmpMap.entrySet()) {
String key = _fmap.getKey();
_tmpMap.put(key, "/page" + _fmap.getValue() + ".jsp");
}
}
if (_tmpMap == null) {
continue;
}
if (result.containsKey(space)) {// 如果 结果里已经有该空间的值
Map<String, String> old_map = result.get(space);
_tmpMap.putAll(old_map);
}
result.put(space, _tmpMap);
}
}
return result;
}
/**
* 获得类的所有属性和属性值
*
* @author ltb
* @param clazz
*/
@SuppressWarnings("rawtypes")
private static Map<String, String> getAllParames(Class clazz) {
Map<String, String> result = new HashMap<String, String>();
Field[] fields = clazz.getDeclaredFields();
try {
for (Field fd : fields) {
result.put(fd.getName(), (String) fd.get(clazz));
}
} catch (Exception e) {
System.out.println("解析值失败");
return null;
}
return result;
}
public static void main(String[] args) throws Exception {
Map<String, Map<String, String>> res = parsing();
for (Map.Entry<String, Map<String, String>> re : res.entrySet()) {
System.out.println(re.getKey());
for (Map.Entry<String, String> con : re.getValue().entrySet()) {
System.out.println(con.getKey() + ": " + con.getValue());
}
System.out.println("---------------------------------------------");
}
}
}