美文网首页Android开发经验谈
那些高端、优雅的注解是怎么实现的 <1> -- 自定义注解语法

那些高端、优雅的注解是怎么实现的 <1> -- 自定义注解语法

作者: ifjgm | 来源:发表于2019-10-12 21:49 被阅读0次

    概述

    使用元注解来定义我们自己的注解,就是自定义注解。
    一个自定义注解可能像下面这样

    @Target({ElementType.TYPE,ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    @Documented
    public @interface Message {
        String decr() default "类名";
    
        String author();
    
        int age();
    
    }
    

    接下来,我们下如何定义,各个关键字、元注解的作用。

    自定义注解系列文章

    一:使用@interface关键字定义

    使用@interface关键字定义一个注解,@interface 后面是自定义注解的名称,如下所示。

    image

    二:声明成员

    注解可以有0到多个成员,下面看下如何声明。

    • 成员不能有参数,不能抛出异常,


      image
    • 当成员有参数或抛出异常则会报错时,编译器会报错


      image
    • 成员类型受限:只能为 Java 基本数据类型、String、ClassAnnotation 、Enumeration

    • 如果只有一个成员,该成员应该命名为 value,可以在使用时忽略成员名和赋值号(=),如果命名为其他的,虽然不会报错,但不能忽略成员名和赋值号。并且这是个约定俗成的做法,就不要杠了

    • 用default指明成员的默认值


      image
    • 注解类可以没有成员,这样的注解称为标识注解

    三:元注解

    元注解是用来注解注解的原始注解,每个元注解有不同的作用和用法,下面逐一看下。

    1.@Target({})

    指明作用范围。可以同时指定多个枚举,从而使得该注解可以作用到多个场合。
    如作用范围为@Target({ElementType.TYPE,ElementType.METHOD})的注解,就可以注解在类声明和方法声明的地方。下面是指定范围的枚举值说明

    • TYPE:类、接口(包括注释类型)或枚举声明

    • FIELD:字段声明(包括枚举常量)

    • METHOD:方法声明

    • PARAMETER:参数声明

    • CONSTRUCTOR:构造函数声明

    • LOCAL_VARIABLE:局部变量声明

    • ANNOTATION_TYPE:注解类型声明

    • PACKAGE:包申明

    • TYPE_PARAMETER: 类型参数声明(1.8新加入),表示这个注解可以用来标注类型参数

    • TYPE_USE:类型使用声明(1.8新加入),用于标注各种类型,只要是类型名称,都可以进行注解

    2.@Retention()

    指明生命周期(分类的时候根据生命周期分类就是依据这个),生命下周起只能指定一个

    • SOURCE(源码):Annotations are to be discarded by the compiler.(会被编译器抛弃)

    • CLASS(class期间):Annotations are to be recorded in the class file by the compiler,but need not be retained by the VM at run time. This is the default behavior.(在.class 期间存在,在VM期间被抛弃,也是默认生命周期)

    • RUNTIME(运行期) :Annotations are to be recorded in the class file by the compiler and retained by the VM at run time, so they may be read reflectively.(一直保留到运行期间,所以可以通过反射获取)

    3.Inherited

    标识注解,允许子类继承父类的注解,即它所标注的注解将具有继承性。(后面会详细阐述)

    4.Documented

    也是标识注解,生成javadoc时是否会包含注解

    四:使用自定义注解

    1.一般注解使用方式

    假设有如下注解

    @Target({ElementType.TYPE,ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    @Documented
    public @interface Message {
        String decr() default "类名";
    
        String author();
    
        int age();
    
    }
    

    可以像如下方式使用

    @Message(decr = "动物类",author = "zhang",age = 28)
    public class Animal {
        String name;
        String age;
    
       }
    

    当然因为有作用域的限制,不能把作用在方法声明上的注解用在类名声明上。我上面这个自定义注解既可以用在类声明上也可以用在方法声明上。

    2.只有一个成员的注解使用方式

    如下注解

    
    @Target({ElementType.TYPE,ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    @Documented
    public @interface Message {
        String value() default "类名";
        
    }
    

    就可以像下面这样使用,可以省略参数名和赋值号(=)

    @Message("动物类")
    public class Animal {
        String name;
        String age;
       }
    

    五:总结

    现在这样的自定义注解,虽然可以使用了。并没有什么特别的功能呢,也不会影响业务逻辑。现在你还看不到注解的强大和魅力,下一节注解的解析,才是注解强大的关键。

    相关文章

      网友评论

        本文标题:那些高端、优雅的注解是怎么实现的 <1> -- 自定义注解语法

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