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

写在前面

本文目的:让你能知道注解是什么东西,看懂注解的元注解,以及常见的注解。
其他:本文的注解有动词意思也有名词意思,动词的意思是注释,解释的意思。
本文结构
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警告,在最小的范围使用,比如能在方法注释就在方法注释,如若在类上使用会抑制这个类内的所有警告。

结语

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容