扫描某个包下所有的类，输出所有使用了特定注解的类的注解值

最近学习了注解的使用，今天做一个小结，有需要改进的地方欢迎指正。

代码功能：扫描某个包下所有的类，输出所有使用了特定注解的类的注解值：

工程代码结构：

1、注解：PeopleAnnotion

package annotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface PeopleAnnotion {public String say();} 

定义注解使用在方法之上，

2、被注解的类：IPeople、BlackPeople、WhitePeople、YellowPeople

package entity;import annotation.PeopleAnnotion;public abstract class IPeople {@PeopleAnnotion(say="NoColor")public abstract void say();public void walk(){System.out.println("I can Walk");}}

package entity;import annotation.PeopleAnnotion;public class WhitePeople extends IPeople {@Override@PeopleAnnotion(say = "White")public void say() {System.out.println("I am White");}}

package entity;import annotation.PeopleAnnotion;public class YellowPeople extends IPeople{@Override@PeopleAnnotion(say="Yellow")public void say() {System.out.println("I am Yellow");}}

package entity;import annotation.PeopleAnnotion;public class BlackPeople extends IPeople{@Override@PeopleAnnotion(say="Black")public void say() {System.out.println("I am Black");}}

3、获取包内所有类：ClassUtil

package util;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 ClassUtil {/** * 通过包名获取包内所有类 *  * @param pkg * @return */public static List<Class<?>> getAllClassByPackageName(Package pkg) {String packageName = pkg.getName();// 获取当前包下以及子包下所以的类List<Class<?>> returnClassList = getClasses(packageName);return returnClassList;}/** * 通过接口名取得某个接口下所有实现这个接口的类 */public static List<Class<?>> getAllClassByInterface(Class<?> c) {List<Class<?>> returnClassList = null;if (c.isInterface()) {// 获取当前的包名String packageName = c.getPackage().getName();// 获取当前包下以及子包下所以的类List<Class<?>> allClass = getClasses(packageName);if (allClass != null) {returnClassList = new ArrayList<Class<?>>();for (Class<?> cls : allClass) {// 判断是否是同一个接口if (c.isAssignableFrom(cls)) {// 本身不加入进去if (!c.equals(cls)) {returnClassList.add(cls);}}}}}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 */private static List<Class<?>> getClasses(String packageName) {// 第一个class类的集合List<Class<?>> classes = new ArrayList<Class<?>>();// 是否循环迭代boolean recursive = true;// 获取包的名字 并进行替换String packageDirName = packageName.replace('.', '/');// 定义一个枚举的集合 并进行循环来处理这个目录下的thingsEnumeration<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包文件// 定义一个JarFileJarFile jar;try {// 获取jarjar = ((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 {// 添加到classesclasses.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 */private static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, List<Class<?>> classes) {// 获取此包的目录 建立一个FileFile 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();}}}}}

4、获取特定包内注解方法的注解值：AnnotationUtil

package util;import java.lang.reflect.Method;import java.util.List;import annotation.PeopleAnnotion;public class AnnotationUtil {public static void validAnnotation(List<Class<?>> clsList){if (clsList != null && clsList.size() > 0) {for (Class<?> cls : clsList) {//获取类中的所有的方法Method[] methods = cls.getDeclaredMethods();if (methods != null && methods.length > 0) {for (Method method : methods) {PeopleAnnotion peopleAnnotion = (PeopleAnnotion) method.getAnnotation(PeopleAnnotion.class);if (peopleAnnotion != null) {//可以做权限验证System.out.println(peopleAnnotion.say());}}}}}}}

 5、测试类：Test

package main;import java.util.List;import javax.crypto.KeyGenerator;import javax.crypto.Mac;import javax.crypto.SecretKey;import javax.crypto.spec.SecretKeySpec;import entity.BlackPeople;import util.AnnotationUtil;import util.ClassUtil;public class Test {public static void main(String[] args) throws InstantiationException, IllegalAccessException {// 获取特定包下所有的类(包括接口和类)List<Class<?>> clsList = ClassUtil.getAllClassByPackageName(BlackPeople.class.getPackage());//输出所有使用了特定注解的类的注解值AnnotationUtil.validAnnotation(clsList);}}