美文网首页
(Android)注解系列-注解基本概念

(Android)注解系列-注解基本概念

作者: 李_3d1b | 来源:发表于2017-11-14 11:52 被阅读0次

    写在前面

    本文目的:让你能知道注解是什么东西,看懂注解的元注解,以及常见的注解。
    其他:本文的注解有动词意思也有名词意思,动词的意思是注释,解释的意思。
    本文结构
    1.小例子解释
    2.怎么看注解(元注解解释)
    3.常见注解

    正文

    一、先看一个例子

    以下是Android中截取的一段代码

    @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
        }
    

    Override是我们最常见的注解,意味着这个方法必须是重写父类的方法,如果没有重写,编译器就会给出错误警告

    查看Override注解源代码:

    • 注解的类型(必须)是@interface,表示@Override是一个注解
    • 这个注解用用两个(元)注解注解
      @Target:说明Override注解只能注解方法
      @Retention:说明注解的访问范围(有效范围)是在.java中,不会在.class中,运行时也看不到。
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.SOURCE)
    public @interface Override {
    }
    

    二、什么是元注解?

    元注解就是标记在注解上的注解。
    元注解一共有以下几种:前面四种是java5引入,第五种是Java8中引入的。
    (1.8 java.lang.annotation包还引入了@Native,它不是元注解,它是指明该方法调用底层的C/C++方法)

    • @Target:指明该注解的可标记范围
    元素类型 适用于
    TYPE 类,接口,注解类,枚举类
    ANNOTATION 注解类
    FIELD 类属性
    LOCAL_VARIABLE 方法变量
    METHOD 方法
    CONSTRUCTOR 构造方法
    PACKAGE 包(没见过)
    PARAMETER 方法中的参数
    TYPE_PARAMETER(1.8) 类参数(没见过)
    TYPE_USE(1.8) 类型(没见过)
    • @Retention:用来指明该注解的生效范围
    元素类型 范围 主要作用
    SOURCE 源代码(在编译成class文件时不再保存) 用于标记提醒程序员以及IDE工具检测等
    CLASS(默认) 源代码和.class(编译时保存,但是在运行在VM的时不保存) 用于框架(如butterknife,dagger2等),利用编译时产生我们想要的java文件,没有用到反射不损耗性能,但是会增加类和方法数,注意64K限制
    RUNTIME 源代码,.class文件,运行时都存在 一般与反射配合使用
    • @Documented:在生成javadoc的时候将注解中的元素内容包含到javadoc中。一般javadoc不会包含注解内容。
    • @Inherited:注解可继承的意思。

    例:
    1.用@Inherted 注解了@Annotation_A
    2.用@Annotation_A注解了类A
    3.B继承A
    4.B其实也继承了A的注解@Annotation_A

    • @Repeatable(java.1.8):表明该注解可以重复注解(需要指定重复注解等价注解)

    假如我们要做一个蛋糕,用注解方法的确定蛋糕的颜色组成。代码:

    public class Cake {
    
        /**
         * 1.8之前
         */
        @Colors({@Color(name = "red"), @Color(name = "blue")})
        public void Create() {
        ...
        }
    
        /**
         * 1.8注解方式。我们只需要在Color注解类上添加注释@Repeatable(Colors.class),就可以用这种方式注解,等价于上面的方式
         */
        @Color(name = "red")
        @Color(name = "blue")
        public void createCakeNew() {
        ...
        }
    }
    

    注解类Color:

    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Repeatable(Colors.class)//表示重复注解等价于Colors
    public @interface Color {
       String name() default "white";
    }
    

    注解类Colors

    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Colors {
        Color[] value();
    }
    

    三、常见注解

    java.lang包下的基本注解简单介绍,更详细内容可以自行查看源码注释文档(1.7 1.8新增的暂时不介绍)

    注解 级别 作用
    @Ovrride SOURCE 重写父类方法
    @Deprecated RUNTIME 提示该包/类/方法/变量已经弃用,弃用原因可能是有bug或者有更优的替代者
    @SuppressWarnings SOURCE 抑制IDE警告,在最小的范围使用,比如能在方法注释就在方法注释,如若在类上使用会抑制这个类内的所有警告。

    结语

    全文如果有不正之处还望指正!

    相关文章

      网友评论

          本文标题:(Android)注解系列-注解基本概念

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