Java注解知识

作者: amazingokc | 来源:发表于2020-03-23 10:21 被阅读0次

    注解在平时开发中随处可见,不了解注解原理会觉得这是一个很神奇的东西,作为一个合格的码农,对一些常用的知识了解其内部原理是很有必要的。

    1.注解的定义

    注解通过 @interface关键字进行定义。

    public @interface TheAnnotation {
    }
    

    2.注解的应用

    可以放在一个类、构造函数、方法、属性等上

    @TheAnnotation 
    public class Test {
    }
    

    3.元注解

    元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。
    元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

    @Retention

    Retention 为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的存活时间。

    它的取值如下:

    RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
    RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
    RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

    @Retention(RetentionPolicy.RUNTIME)
    public @interface TheAnnotation {
    }
    
    @Documented

    顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

    @Target

    Target 是目标的意思,@Target 指定了注解运用的地方,就是本文开头所说那些应用地方。

    ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
    ElementType.CONSTRUCTOR 可以给构造方法进行注解
    ElementType.FIELD 可以给属性进行注解
    ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
    ElementType.METHOD 可以给方法进行注解
    ElementType.PACKAGE 可以给一个包进行注解
    ElementType.PARAMETER 可以给一个方法内的参数进行注解
    ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

    下面这个注解只用应用到类、接口或者枚举上面

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @interface TheAnnotation {}
    
    @Inherited

    Inherited 是继承的意思

    @Inherited
    @Retention(RetentionPolicy.RUNTIME)
    @interface TheAnnotation {}
    
    @TheAnnotation 
    public class A {}
    

    public class B extends A {}
    注解 TheAnnotation 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 TheAnnotation 这个注解。

    @Repeatable

    这个元注解稍微复杂一些,Repeatable 是可重复的意思,@Repeatable 是 Java 1.8 才加进来的。
    举个例子,一个人有多个身份的时候,可以用的这个元注解

    @interface Persons {
        Person[]  value();
    }
    
    
    @Repeatable(Persons.class)
    @interface Person{
        String position() default "";
    }
    
    
    @Person(position="singer")
    @Person(position="coder")
    public class Man{   
    }
    

    上面的 @Person 注解添加了 @Repeatable 元注解,@Repeatable括号里面中的注解相当于一个容器注解,用来放其他注解的,从上面代码可以看到这个容器注解用来放 @Person 注解的,然后就可以将多个 @Person 注解到Man类上,这个 Man 类就有了多层身份的意思。

    4.注解的属性

    上面的 @Person 注解里面的 String position() default "" 就是注解的属性,默认值是空字符串,也可以不写默认值。

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Person{
        
        int age();
        
        String name();
    
    }
    
    @Person(age=23,name="xiaoming")
    public class Man{
    
    }
    

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

    如果只有一个属性的时候,可以简洁写法

    public @interface Person{
            int age();
    }
    
    @Person(23)
    public class Man() {
    }
    

    如果一个属性都没有,则连括号都不需要写。

    5.注解提取

    前面4大点是注解的基本知识,注解本身并没有任何实际作用,关键作用的将这些注解提取出来,再做实际上的操作。注解的提取关键手段就是反射了。

    通过反射获取注解

    Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解

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

    getAnnotation() 方法来获取制定的 Annotation 对象。

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

    getAnnotations() 方法获取所有注解

    public Annotation[] getAnnotations() {}
    
    @Person(age = 28, name = "xiaoming")
    public class AnnotationTestActivity extends AppCompatActivity {
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_annotation_test);
    
            boolean isHadAnnotation = AnnotationTestActivity.class.isAnnotationPresent(Person.class);
            if (isHadAnnotation) {
                Person person = AnnotationTestActivity.class.getAnnotation(Person.class);
               
                System.out.println("age:" + person.age());
                System.out.println("name:" + person.name());
            }
        }
    }
    

    输出结果

    I/System.out: age:28
    I/System.out: name:xiaoming
    

    6.使用场景

    注解一般是供编译器和APT使用的,运行时通过反射提取,这对性能有一定的影响;APT编译期生成类、文档等,这对运行性能没有影响,但是编译稍微会慢一些,比如大名鼎鼎的Dagger2就是使用APT在编译期生成大量代码,完成依赖注入的工作,实现了代码解耦。另外例如ButterKnife、Eventbus都使用到了注解,多阅读这些源码,自己稍加练习,这样对注解的使用场景及理解就会更加深刻了。

    相关文章

      网友评论

        本文标题:Java注解知识

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