Java 初识注解

一、注解的基本概念

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

Annotation(注解,也叫元数据)是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符,即描述数据的数据。

Java自带有四种内置注解 (定义在java.lang中):

注解名称 作用
@Override 表示当前方法将覆盖父类中的方法,主要用于保证方法签名和拼写的准确性。
@Deprecated 表示已被废弃,如果使用了被它注解的元素,会被警告。
@SuppressWarnings 关闭编译器的警告信息
@SafeVarargs 表示该方法参数长度可变

Java还提供了四种元注解(定义在java.lang.annotation),用于新注解的创建:

注解名称 作用和可能的参数
@Documented 表示注解将被保存在Javadoc中,无参数
@Retention 表示在什么级别保存注解信息(注解的生命周期),可能的RetentionPolicy参数:
SOURCE:只保存在源代码中,编译时将被编译器丢弃(例如@Override@SuppressWarnings
CLASS:默认项,会被保存在class文件中,但运行时会被虚拟机丢弃
RUNTIME:会被保存在class文件中,运行时被虚拟机保留,并通过反射机制读取信息(例如@Deprecated@SafeVarargs
@Target 表示注解可用于什么地方,可能的ElementType参数:
TYPE:类、接口(包括注解)、enum
FIELD:域声明(包括enum实例)
METHOD:方法声明
PARAMETER:参数声明
CONSTRUCTOR:构造器声明
LOCAL_VARIABLE:局部变量声明
ANNOTATION_TYPE:注解声明
PACKAGE:包声明
@Inherited 允许子类继承父类中的注解,无参数

更多的注解体现在第三方库(如ButterKnife、Retrofit)和Android(如@Nullable)中。

二、详解元注解

@Documented

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

表示注解将被保存在Javadoc中

什么是Javadoc?javadoc是Sun公司提供的一个技术,它可以从源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

举个栗子:
先自定义一个注解,并用@Documented修饰:

@Documented
@interface DocumentedAnnotation {
    String name() default "name";
    int age() default 0;
}

再创建一个类,并在类和方法前加上自定义的注解:

@DocumentedAnnotation(name = "Rimson", age = 18)
public class DocumentedAnnotationTest {

    @DocumentedAnnotation(name = "Rimson", age = 18)
    public String toString() {
        return "hello";
    }
}

接着生成Javadoc文件,笔者使用的是IDEA编译器(也可以直接使用javadoc命令生成),选择菜单栏-> Tools -> Genetate JavaDoc...,选中Whole project并指定Output directory,然后选择OK,不管是这种方式还是javadoc命令行,都能看到以下内容:


在刚才选择的目录中,找到index.html并打开,可以看到类和方法都显示在这个javadoc文件中:


如果去掉自定义注解中的@Documented,再生成javadoc:

自定义注释将不会出现在javadoc中。同理,即使在代码中的toString()方法加上@Override注解,javadoc中也不会出现该注解,因为@Override这个注解本身并没有被加上@Documented

@Retention

用来表示注解的保留策略(声明周期)

  • SOURCE:源码级别,注解只保留在源文件阶段,当.java文件被编译成.class文件时,注解就会被去掉。这种声明周期的注解,常常用于检验代码规范,提示代码错误等等,被编译之后它们就不再起作用。例如@Override@SuppressWarnings只是在编写源代码时,帮助编程人员检验方法签名是否准确以及去除不必要的警告。

  • CLASS:字节码级别,注解保留到字节码文件阶段,当JVM通过ClassLoader向内存中加载字节码文件时,注解就会被去掉;这种生命周期主要运用在,某些需要对字节码进行处理的场合。

  • RUNTIME:运行时级别,上面两种保留策略在运行时都会被去掉,也就是不能通过反射机制,调用getAnnotationgetAnnotations 获取注解的内容;只有这种策略的注解,当JVM运行时,可以获取内容并得到执行。主要用于注解信息非常重要的场合,例如Butterknife的注解。

@Target

表示可以被注解修饰的内容。

@Inherited

加上此注解后的注解,可以被子注解继承。

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

推荐阅读更多精彩内容

  • 2017.12.16宝清熹微复盘【小确幸】 ①买到嫂子爱吃的枣糕②享受一下打车去哥哥家③我们一起去吃日本料理火锅,...
    熹微林阅读 164评论 0 1
  • 做为在历史上产生了最多的疯子,爱和恨对方都要变的如此疯癫痴狂、歇斯底里,你难道不觉得人是这世界最为脆弱的生...
    山毛榉怪阅读 184评论 0 1
  • 归并排序是建立在归并操作上的一种有效的排序算法,该算法是采用分治法(Divide and Conquer)的一个非...
    萧何爱英语阅读 1,138评论 0 0
  • 简爱最终还是和罗切斯特先生在一起了。简爱一直追求平等,可是这个时候的简(年轻有活力的,上流社会的女子)和罗切斯特(...
    樱桃裙_72阅读 471评论 0 1