开发公司项目过程中,发现一段代码,太过麻烦,每次新增一个Class,就要去更改另外一个类,把这个类的对象写入到另外一个类的成员Map变量中,太麻烦了,而且还违反了开闭原则。(因为项目原因,不可以导入其他第三方jar包)
新建一个注解类
/**
* @author: LKP
* @date: 2019/2/13
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyRequestMapping {
String value();
}
元注解解析:
@Target 用来定义你的注解将应用于什么地方(例如是一个方法或者一个域,TYPE 类,接口(包括注解类型)或enum声明 )。
@Retention 用来定义该注解在哪一个级别可用,在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。
创建好自定义注解类之后,只需要在你新建的Class上加上该注解即可,写好value的值。
之后,我们来手写Reflections类,用于扫描指定包下面的Class。
/**
* 扫描执行目录下面的类
*
* @author: LKP
* @date: 2019/2/13
*/
public class MyReflections {
/**
* 需要扫描的包名
*/
private String packageStr;
public MyReflections(String packageStr) {
this.packageStr = packageStr;
}
public Set<Class<?>> getTypeAnnotatedWith(Class<?> annotationType) {
// 第一个class类的集合
Set<Class<?>> classes = new LinkedHashSet<>();
// 是否循环迭代
boolean recursive = true;
// 获取包的名字 并进行替换
String packageName = packageStr;
String packageDirName = packageName.replace('.', '/');
// 定义一个枚举的集合 并进行循环来处理这个目录下的things
Enumeration<URL> dirs;
try {
dirs = Thread.currentThread().getContextClassLoader().getResources(
packageDirName);
// 循环迭代下去
while (dirs.hasMoreElements()) {
// 获取下一个元素
URL url = dirs.nextElement();
// 得到协议的名称
String protocol = url.getProtocol();
// 如果是以文件的形式保存在服务器上
if ("file".equals(protocol)) {
// 获取包的物理路径
String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
// 以文件的方式扫描整个包下的文件 并添加到集合中
findAndAddClassesInPackageByFile(packageName, filePath,
recursive, classes);
} else if ("jar".equals(protocol)) {
// 如果是jar包文件
// 定义一个JarFile
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 deleteNotAnnotationClass(classes, annotationType);
}
/**
* 删除集合中没有指定注解的类
*
* @param classes
* @param annotationType
*/
public Set<Class<?>> deleteNotAnnotationClass(Set<Class<?>> classes, Class<?> annotationType) {
Set<Class<?>> newClasses = new LinkedHashSet<>();
for (Class<?> aClass : classes) {
MyRequestMapping annotationField = aClass.getAnnotation(MyRequestMapping.class);
if (annotationField != null) {
newClasses.add(aClass);
}
}
return newClasses;
}
/**
* 以文件的形式来获取包下的所有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;
}
// 如果存在 就获取包下的所有文件 包括目录
// 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
File[] dirfiles = dir.listFiles(file -> (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(Class.forName(packageName + '.' + className));
//经过回复同学的提醒,这里用forName有一些不好,会触发static方法,没有使用classLoader的load干净
classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
} catch (ClassNotFoundException e) {
// log.error("添加用户自定义视图类错误 找不到此类的.class文件");
e.printStackTrace();
}
}
}
}
}
代码中包含大量的注释,请直接阅读代码,结合注释。
最后只需要在合适的地方调用就可以了。(节选代码)
MyReflections myReflections = new MyReflections("com.xhtt.fzxy.console.handler");
Set<Class<?>> classSet = myReflections.getTypeAnnotatedWith(MyRequestMapping.class);
for (Class<?> aClass : classSet) {
MyRequestMapping myRequestMapping = aClass.getAnnotation(MyRequestMapping.class);
try {
postHandlers.put(myRequestMapping.value(), (BaseHandler) aClass.newInstance());
} catch (Exception e) {
e.printStackTrace();
}
}
这是改良前的代码
相信不用我多说,你也可以看出来新方式具备的优势了吧。