美文网首页
Java注解全解析

Java注解全解析

作者: 星星_点灯 | 来源:发表于2018-04-19 16:32 被阅读30次

    什么是注解?

    Annontation(注解)是Java5开始引入的新特征。它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类、方法、成员变量等)进行关联。与类、接口、枚举是在同一个层次,可以理解为java 的一个类型。Java中的类、方法、变量、参数、包都可以被注解;

    Java中常见的注解

    @Override:我们常常见到,表示覆盖活重写了父类的方法;
    @deprecated: 表示该方法已经过时了,我们在开发时有时用到某个类的方法时,该方法会被横线划掉,说明该方法时添加了@deprecated注解的,方法已过时,不建议使用;
    @SuppressWarnings:表示忽略警告,比如我们在用到上述过时的方法时,编译器会有警告,我们可以标注该注解忽略掉编译器的警告;

    元注解

    元注解是什么呢?元注解是用来注解注解的注解。哈哈,是不是很绕,其实元注解就是用来标示、声明普通注解的,是一种基础注解,像上面我们提到的java中常见的注解,那些注解都是由元注解修饰、标示或者声明才决定了这些普通注解的作用的;java中的元注解有以下几个:

    @Retention
    Retention英文的意思是保留,当@Retention用到注解上的时候表示该注解要保留到哪个阶段,或者说表示了注解的生命周期,它的取值如下:
    RetentionPolicy.SOURCE:注解只在源码阶段保留,当编译器开始编译时就会被忽略、丢弃;
    RetentionPolicy.CLASS:注解被保留到编译阶段,并不会被加载进jvm;
    RetentionPolicy.RUNTIME:注解会保留到程序运行阶段,它会被加载进jvm,并且在程序运行时可以获取到;

    @Documented
    documented是文档的意思,所以该元注解的意思是能够将注解中的元素包含到 Javadoc 中去;

    @Target
    target是目标的意思,它表示注解要作用的目标;意思就是被@Target修饰的注解就限定了使用场景;
    @Target有以下取值:
    ElementType.TYPE:类,接口(包括注解类型)或enum声明;
    ElementType.CONSTRUCTOR:构造器声明 ;
    ElementType.FIELD:属性、字段声明;
    ElementType.LOCAL_VARIABLE:局部变量声明;
    ElementType.METHOD:方法声明;
    ElementType.PACKAGE:包声明;
    ElementType.PARAMETER:方法内的参数声明;

    @Inherited
    inherited是继承的意思,表示如果父类有被该元注解修饰的注解,那么允许子类继承父类的注解;

    @Repeatable
    Repeatable是可重复的,所以该元注解的作用是可重复的,这个是java1.8才加进来的,算是一个新的特性,什么样的注解是可以重复使用的呢,例如我们定义一个职位的注解,一个人可以有很多职位,比如:即是工程师又是产品又是设计师等等;

    注解的分类

    注解按照运行机制分类可以分为:
    1、源码注解 对应@Retention 的 RetentionPolicy.SOURCE
    2、编译时注解 对应@Retention 的 RetentionPolicy.CLASS
    3、运行时注解 对应@Retention 的 RetentionPolicy.RUNTIME

    自定义注解

    上面讲了很多注解的基础知识,那么注解到底是如何创建的呢?接下来我们就来创建几个自定义注解,详细解释一下注解的使用;
    注解通过 @interface 关键字进行定义,它的形式跟接口很类似,不过前面多了一个 @ 符号;

    public @interface MyAnnotation {
        //自定义注解
    }
    

    如代码所示,我们就定义了一个简单的注解,接下来我们就可以使用了;

    @MyAnnotation
    public class Person {
    
    }
    

    我们可以用注解来修饰任意一个类,但是这样的注解就是一个简单的标识,没有实际意义,接下来我们来说一下注解的属性;

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        int age();
    
        String name();
    }
    

    上面的注解,我们限定了其可以修饰的范围,以及它生效的阶段;还定义了两个属性,age和name,在使用的时候我们可以对属性进行赋值,赋值的方式是在注解的括号内以 value=”” 形式,多个属性之间用 ,隔开;

    @MyAnnotation(age = 20,name = "fanbingbing")
    public class Person {
    
    }
    

    需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

    注解中属性可以有默认值,默认值需要用 default 关键值指定。

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        int age() default 0;
    
        String name() default "object";
    }
    

    设置了默认值后的注解,我们可以直接用,而不用赋值,也可以赋值来覆盖默认值;

    @MyAnnotation()
    public class Person {
    
    }
    

    这样的话,注解取的就是默认值;

    如果一个注解内仅仅只有一个属性时我们可以定义为 value,应用这个注解时可以直接接属性值填写到括号内。

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        String value();
    }
    

    使用

    @MyAnnotation("fanbingbing")
    public class Person {
    
    }
    

    注解的提取

    前面我们讲到注解的属性赋值等操作,那么这些属性值我们如何来获取呢?
    还是以上面的为例,我们自定义一个注解

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        int age() default 0;
    
        String name() default "object";
    }
    

    用来修饰一个类

    @MyAnnotation(age = 20,name = "fanbingbing")
    public class Person {
    
    }
    

    获取注解的值

    boolean isAnnotation = Person.class.isAnnotationPresent(MyAnnotation.class);
    if (isAnnotation) {
         MyAnnotation myAnnotation = Person.class.getAnnotation(MyAnnotation.class);
         Log.d("Test", "age=" + myAnnotation.age());
         Log.d("Test", "name=" + myAnnotation.name());
    }
    

    控制台输出:


    获取注解的值

    可以看出我们是通过反射来获取注解相关的值的,这里我们介绍一下用到的几个方法:

    public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
    

    该方法用来判断是否应用了某个注解;

    public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
    

    该方法来获取 Annotation 对象;
    或者

    public Annotation[] getAnnotations() {}
    

    该方法用来获取类中的所有注解;

    接下来我们来说一下如何获取一个类中成员变量和成员方法的注解;
    首先我们新建一个用来注解成员变量的注解

    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyFieldAnnotation {
    
    }
    

    然后再定义一个用来注解方法的注解

    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyMethodAnnotation {
    
    }
    

    新建一个类,使用上述注解

    @MyAnnotation(age = 20, name = "fanbingbing")
    public class Person {
    
        @MyFieldAnnotation
        public int count;
    
    
        @MyMethodAnnotation
        public void myMethod(){
    
        }
    }
    

    主程序中获取属性和方法中的注解:

          try {
                //获取属性上的注解
                Field field = Person.class.getDeclaredField("count");
                MyFieldAnnotation myFieldAnnotation = field.getAnnotation(MyFieldAnnotation.class);
                Log.d("Test", "MyFieldAnnotation = " + myFieldAnnotation.annotationType().getSimpleName());
    
                //获取方法上的注解
                Method method = Person.class.getDeclaredMethod("myMethod");
                MyMethodAnnotation myMethodAnnotation = method.getAnnotation(MyMethodAnnotation.class);
                Log.d("Test", "MyMethodAnnotation = " + myMethodAnnotation.annotationType().getSimpleName());
    
            } catch (Exception e) {
                e.printStackTrace();
            }
    

    控制台输出


    获取方法和属性注解

    可以看到我们要获取属性和方法的注解,首先要通过反射获取到Field和Method对象,然后通过具体的对象来获取相应的注解就可以了;

    注解的使用场景

    到此,我们大概已经了解了什么是注解,已经注解的使用和自定义注解的创建和获取,那么注解到底有什么用呢,什么情况下要用到注解呢?我们来看一下java的官方文档是如何说明的:

    注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。
    注解有许多用处,主要如下: 
    - 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息;
    - 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理; 
    - 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取;
    

    通过官方文档我们可以窥探到,注解不是代码的一部分,是用来为我们的代码服务的,用来标示和修饰代码,起到辅助代码编写的作用;同时还可以用来生成相应的文档,在运行阶段还能对注解的代码进行提取,来帮助我们完成相应的逻辑处理等等;
    关于注解本篇就介绍到此,相信大家对注解已经有了一定的了解和认识;

    相关文章

      网友评论

          本文标题:Java注解全解析

          本文链接:https://www.haomeiwen.com/subject/inlbkftx.html