如何獲取包下所有類中的註解的值(java工具類)

Posted on by

獲取包下所有類中註解的值

作用：

這個工具類主要的作用就是獲取類中的註解的值。

應用場景：

做權限的時候獲取@RequestMapping();的值，自動添加到數據庫中。

/**    
   * getRequestMappingValue方法描述:  
   * 作者:thh    
   * 日期:2016年7月18日 下午5:41:00         
   * 異常對象:@param packageName
   * 異常對象:@return 
*/
    public static List<String> getRequestMappingValue(String packageName) {
    GetAnnotationValueUtil getAnnotationValueUtil = new GetAnnotationValueUtil();
         //第一個class類的集合  
        List<Class<?>> classes = new ArrayList<Class<?>>();  
        //是否循環迭代  
        boolean recursive = true;  
        //獲取包的名字 並進行替換  
        String packageDirName = packageName.replace('.', '/');  
        //定義一個枚舉的集合 並進行循環來處理這個目錄下的文件 
        Enumeration<URL> dirs;  
        try {  
            //讀取指定package下的所有class
            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);
                } 
            }  
        } catch (IOException e) { 
            e.printStackTrace();  
        } 
        List<String> stringList = new ArrayList<String>();
        for (Class<?> clazz : classes) {
            //循環獲取所有的類
            Class<?> c = clazz;
            //獲取類的所有方法
            Method[] methods = c.getMethods();
            for (Method method : methods) {
                //獲取RequestMapping註解
                RequestMapping annotation = method.getAnnotation(RequestMapping.class);
                if (annotation != null) {
                    //獲取註解的value值
                    String[] value = annotation.value();
                    for (String string : value) {
                        //放入List集合
                        stringList.add(string);
                    }
                }
            }
        }
        return stringList;
    }
    /**    
     * findAndAddClassesInPackageByFile方法描述:  
     * 作者:thh
     * 日期:2016年7月18日 下午5:41:12         
     * 異常對象:@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(Thread.currentThread().getContextClassLoader().loadClass(packageName + "." + className));  
                } catch (ClassNotFoundException e) {  
                    e.printStackTrace();  
                }  
            }  
        } 
    }

java 類,變量,方法上註解值的獲取

首先定義三個註解類, 分別適用於類,成員變量, 方法

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface LeiMode {
 public int value() default 1;
}
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FiledMode {
 public int value() default 1;
}
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TreahMode {
 public int value() default 1;
}

然後,定義一個類,使用瞭註解

@LeiMode(5)
public class AnnotationDemo { 
 @FiledMode(10)
 private int itest;
 
 @TreahMode()
 private void test(){}
}

1.獲取類上的註解值

LeiMode annotation = AnnotationDemo.class.getAnnotation(LeiMode.class);
System.out.println(annotation.value());

2.獲取所有變量,並獲取指定方法上的註解信息

Field[] fields = AnnotationDemo.class.getDeclaredFields();
  Field field = null;
  for(Field f : fields){
   if(f.getName().equals("itest")){
    field = f;
    break;
   }
  }  
  FiledMode annotation = field.getAnnotation(FiledMode.class);
  System.out.println(annotation.value());

3.獲取指定變量上的註解信息

Field field = AnnotationDemo.class.getDeclaredField("itest");
  FiledMode annotation = field.getAnnotation(FiledMode.class);  
  System.out.println(annotation.value());

4.獲取所有方法,並獲取指定方法上的註解信息

Method[] methods = AnnotationDemo.class.getDeclaredMethods(); //可以獲取私有方法和公有方法, getMethods() 獲取公有方法
  Method meth = null;
  for(Method method : methods){
   if(method.getName().equals("test")){
    meth = method;
    break;
   }
  }
  Annotation annotation = meth.getAnnotations()[0];
  TreahMode mode = (TreahMode) annotation;
  System.out.println(mode.value());

5.獲取指定方法上的註解信息

Method method = AnnotationDemo.class.getDeclaredMethod("test", null);//可以獲取私有方法和公有方法
  System.out.println(method);
  Annotation[] annotations = method.getAnnotations();
  Annotation annotation = annotations[0];
  System.out.println(annotation);
  
  TreahMode mode = (TreahMode) annotation;
  System.out.println(mode.value());

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：