关于注解扫描获取类注解信息及对象实例-CSDN博客

本文链接：https://blog.csdn.net/tanliu1596/article/details/88904552

calss获取接口的信息，class的工具类实现扫描对应包下的接口的实现类

package org.physical.examination.framework;

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;

import org.physical.examination.framework.expression.ICalculate;

/** 
 * 类相关的工具类 
 *  
 * @author <a href="mailto:ohergal@gmail.com">ohergal</a> 
 *  
 */
public class ClassUtil {

	public static void main(String[] args) throws Exception {
		List<Class> classes = ClassUtil.getAllClassByInterface("org.physical.examination.framework.expression",
				ICalculate.class);
		for (Class clas : classes) {
			System.out.println(clas.getName());
		}
	}

	/** 
	 * 取得某个接口下所有实现这个接口的类 
	 * */
	public static List<Class> getAllClassByInterface(String packageName, Class base) {
		List<Class> returnClassList = null;
		if (base.isInterface()) {
			// 获取当前的包名
			// 获取当前包下以及子包下所以的类
			List<Class<?>> allClass = getClasses(packageName);
			if (allClass != null) {
				returnClassList = new ArrayList<Class>();
				for (Class classes : allClass) {
					// 判断是否是同一个接口
					if (base.isAssignableFrom(classes)) {
						// 本身不加入进去
						if (!base.equals(classes)) {
							returnClassList.add(classes);
						}
					}
				}
			}
		}

		return returnClassList;
	}

	/*
	 * 取得某一类所在包的所有类名 不含迭代
	 */
	public static String[] getPackageAllClassName(String classLocation, String packageName) {
		// 将packageName分解
		String[] packagePathSplit = packageName.split("[.]");
		String realClassLocation = classLocation;
		int packageLength = packagePathSplit.length;
		for (int i = 0; i < packageLength; i++) {
			realClassLocation = realClassLocation + File.separator + packagePathSplit[i];
		}
		File packeageDir = new File(realClassLocation);
		if (packeageDir.isDirectory()) {
			String[] allClassName = packeageDir.list();
			return allClassName;
		}
		return null;
	}

	/** 
	 * 从包package中获取所有的Class 
	 * @param pack 
	 * @return 
	 */
	public static List<Class<?>> getClasses(String packageName) {

		// 第一个class类的集合
		List<Class<?>> classes = new ArrayList<Class<?>>();
		// 是否循环迭代
		boolean recursive = true;
		// 获取包的名字 并进行替换
		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) {
											e.printStackTrace();
										}
									}
								}
							}
						}
					} catch (IOException e) {
						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,
			List<Class<?>> classes) {
		// 获取此包的目录 建立一个File
		File dir = new File(packagePath);
		// 如果不存在或者 也不是目录就直接返回
		if (!dir.exists() || !dir.isDirectory()) {
			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(Class.forName(packageName + '.' + className));
				} catch (ClassNotFoundException e) {
					e.printStackTrace();
				}
			}
		}
	}
}

通过注解获取我对象实例

public static void Scan() {
	String pageNameString = "org.physical.examination.framework.expression";
	List<Class> classes = ClassUtil.getAllClassByInterface(pageNameString, ICalculate.class);
	for (Class classType : classes) {
		Annotation tempAnnotation = classType.getAnnotation(CalculateAnnotation.class);
		if (tempAnnotation != null && tempAnnotation instanceof CalculateAnnotation) {
			CalculateAnnotation tempMsgCode = (CalculateAnnotation) tempAnnotation;
			try {
				ExcuteMaps.put(tempMsgCode.groupName() + "_" + tempMsgCode.innerID(), classType);
			} catch (Exception e) {
				Log4jUtil.error("解析注解错误", e);
			}
		}
	}

设计注解的接口的内部的key值

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface CalculateAnnotation {

	String groupName()  default "";
	String desc()  default "";
	String innerID() default "";
}

设计一个接口，其他的类必须实现这个接口，这样通过扫描这个接口就可以扫描到全部的实现类了

1
2
3

public interface ICalculate {
	String Calculate(String[] args);
}

实现类一


@CalculateAnnotation(groupName="BMI",innerID="1",desc="通用")
public class BMICalculate implements ICalculate {

	/**   
	 * <p>Title: Calculate</p>   
	 * <p>Description: </p>   
	 * @param args
	 * @return   
	 * @see org.physical.examination.framework.expression.ICalculate#Calculate(java.lang.String[])   
	 */  
	@Override
	public String Calculate(String[] args) {
		// TODO Auto-generated method stub
		return null;
	}
}

实现类二


@CalculateAnnotation(groupName="BMI",innerID="2",desc="another")
public class BMIAnother implements ICalculate{

	/**   
	 * <p>Title: Calculate</p>   
	 * <p>Description: </p>   
	 * @param args
	 * @return   
	 * @see org.physical.examination.framework.expression.ICalculate#Calculate(java.lang.String[])   
	 */  
	@Override
	public String Calculate(String[] args) {
		// TODO Auto-generated method stub
		return null;
	}
}

就是通过外部application.properties外部配置来获取那个具体的实现类来实现具体的业务逻辑，就是这样

通过反射来获取对象，执行相关的实现类的方法。


public String Execut(String gropStrings, String innerId, String[] args) {
	CalculateMange.Scan();
	String spellNameString = gropStrings + "_" + innerId;
	Class<ICalculate> clazz = ExcuteMaps.get(spellNameString);
	String calculate = "";
	ICalculate newInstance = null;
	try {
		newInstance = clazz.newInstance();
		calculate = newInstance.Calculate(args);
	} catch (InstantiationException | IllegalAccessException e) {
		e.printStackTrace();
	}
	return calculate;
}