如何获取包下所有类中的注解的值(java工具类)

 更新时间:2021年08月04日 09:50:39   作者:tan_thinker  
这篇文章主要介绍了如何获取包下所有类中的注解的值 (java工具类),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

获取包下所有类中注解的值

作用:

这个工具类主要的作用就是获取类中的注解的值。

应用场景:

做权限的时候获取@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());

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • javaweb如何使用华为云短信通知公共类调用

    javaweb如何使用华为云短信通知公共类调用

    这篇文章主要介绍了javaweb使用华为云短信通知公共类调用的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • IDEA创建SpringBoot父子Module项目的实现

    IDEA创建SpringBoot父子Module项目的实现

    本文主要介绍了IDEA创建SpringBoot父子Module项目的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05
  • RocketMQ事务消息原理与使用详解

    RocketMQ事务消息原理与使用详解

    RocketMQ事务消息(Transactional Message)是指应用本地事务和发送消息操作可以被定义到全局事务中,要么同时成功,要么同时失败。RocketMQ的事务消息提供类似 X/Open XA 的分布式事务功能,通过事务消息能达到分布式事务的最终一致
    2023-02-02
  • Java自定义简单标签实例

    Java自定义简单标签实例

    Java自定义简单标签可以方便的在页面输出信息,并且对于权限的控制,和对于Jsp标签和servlet代码的分离有着很好的作用
    2013-07-07
  • java字符串中常用的十个方法总结

    java字符串中常用的十个方法总结

    String类中提供了丰富的用于操作字符串的方法,下面这篇文章主要给大家介绍了关于java字符串中常用的十个方法,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-01-01
  • IDEA快速部署Spring Boot 项目到Docker的实现方法

    IDEA快速部署Spring Boot 项目到Docker的实现方法

    本文主要介绍了IDEA快速部署Spring Boot 项目到Docker的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-07-07
  • Java ThreadLocal的设计理念与作用

    Java ThreadLocal的设计理念与作用

    这篇文章主要介绍了Java ThreadLocal的设计理念与作用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • SpringBoot自动配置的实现原理

    SpringBoot自动配置的实现原理

    这篇文章主要介绍了详解SpringBoot自动配置原理,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • Java的常见热门ORM框架优缺点区别

    Java的常见热门ORM框架优缺点区别

    Java ORM框架是一种用于将Java对象映射到关系型数据库中的工具,使得开发人员能够通过对象操作数据库而不必直接使用SQL查询,Java开发变得更加高效和易于维护,选择适合你的ORM框架是根据你的需求决定的,比如你的应用场景,数据结构和技术水平等
    2024-02-02
  • java多线程的同步方法实例代码

    java多线程的同步方法实例代码

    这篇文章主要介绍了 java多线程的同步方法实例代码的相关资料,需要的朋友可以参考下
    2017-04-04

最新评论