Java基础之Annotation(一)

1、概述

Annotation(注解)是JDK5.0及以后版本引入的。它用来修饰编程元素,如:包、类、构造方法、方法、成员变量、参数、局域变量等。Annotation是代码里的特殊标记,这些标记可以再编译、类加载、运行时被读取、并执行相应的处理。通过使用Annotation(注解),开发人员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充的信息。Annotation不能运行,它只有成员变量,没有方法。Annotation跟public、final等修饰符地位一样,都是程序元素的一部分,不能作为单独的程序元素使用。

2、注解的分类

注解分为两类,一类是元注解,另外一类是普通注解。

2.1 元注解

所谓元注解就是修饰注解的注解。拿到一个注解,如何知道它是否是元注解呢?需要看它的元注解(无论是元注解还是普通注解都是有元注解的),如果看到这样的元注解:@Target(ElementType.ANNOTATION_TYPE),那么此时这个注解一定是元注解。JDK提供了4种元注解:

2.1.1 @Documneted

如果定义注解A时,使用了@Documented修饰定义,则在用javadoc命令生成API文档后,所有使用注解A修饰的程序元素,将会包含注解A的说明。

2.1.2 @Inherited

@Inherited指定Annotation具有继承性。

2.1.3 @Retention

注解需要标明注解的生命周期,用于指定Annotation可以保留多长时间,这些信息是通过元注解实现。而这个元注解是:

public @interface Retention
{
    RetentionPolicy value();
}

Retention注解包含一个enum枚举类型的RetentionPolicy成员变量。使用@Retention时,必须为其value制定具体的值,包括如下几种情况:

  1. SOURCE: 注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃。
    Annotations are to be discarded by the compiler.
  2. CLASS: 注解被保留到class文件,jvm加载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.
  3. RUNTIME: 注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在,保存到class对象中,可以通过反射来获取。
    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.
    示例如下:
package com.demo1;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

@Retention(value=RetentionPolicy.RUNTIME) //name=value形式
@Retention(RetentionPolicy.RUNTIME) //直接指定

public @interface MyTag{

    String name() default "admin";

}

2.1.4 @Target

注解需要标明注解的修饰目标,这些信息是通过元注解实现。@Target指定Annotation用于修饰哪些程序元素。@Target也包含一个名为”value“的成员变量,该value成员变量类型为ElementType[ ],ElementType为枚举类型,这个元注解是:

public @interface Target
{
    ElementType[] value();
}

这个注解的成员变量值是enum类型ElementType。包括以下几种情况:

  1. TYPE:指的是在类,接口(包括注解)或者enum上使用的注解。

  2. FIELD:指的在field属性,也包括enum常量使用的注解。

  3. METHOD:指的是在方法声明上使用的注解。

  4. PARAMETER:指的是在参数上使用的注解,

  5. CONSTRUCTOR: 指的是在构造器使用的注解。

  6. LOCAL_VARIABLE:指的是在局部变量上使用的注解。

  7. ANNOTATION_TYPE:指的是在注解上使用的元注解

  8. PACKAGE:指的是在包上使用的注解。

示例如下:

package com.demo1;

import java.lang.annotation.ElementType;

import java.lang.annotation.Target;

@Target({ ElementType.FIELD, ElementType.METHOD }) //修饰成员变量和方法

public @interface MyTag {
    String name() default "admin";
}

2.2 普通注解

JDK默认提供了如下几个基本Annotation:

2.2.1 @Override

限定重写父类方法。对于子类中被@Override 修饰的方法,如果存在对应的被重写的父类方法,则正确;如果不存在,则报错。@Override 只能作用于方法,不能作用于其他程序元素

2.2.2 @Deprecated

用于表示某个程序元素(类、方法等)已过时。如果使用被@Deprecated修饰的类或方法等,编译器会发出警告。

2.2.3 @SuppressWarning

抑制编译器警告。指示被@SuppressWarning修饰的程序元素(以及该程序元素中的所有子元素,例如类以及该类中的方法.....)取消显示指定的编译器警告。例如,常见的@SuppressWarning(value="unchecked")

2.2.4 @SafeVarargs

@SafeVarargs是JDK 7 专门为抑制“堆污染”警告提供的。

3、自定义注解

定义新的Annotation类型使用@interface关键字(在原有interface关键字前增加@符号)。定义一个新的Annotation类型与定义一个接口很像,例如:
定义一个注解:

public @interface MyTag{
    string name() default "Lucy";
    int age() default 18;
}

使用自定义注解:

public class Test{
    @MyTag
    public void info(){
    ......
    }
}

使用自定义注解时,会把Annotation单独放一行。并且放在所有修饰符之前,Annotation只有成员变量,没有方法。Annotation的成员变量在定义时以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。一旦在Annotation中定义了成员变量后,使用该Annotation时就必须为该Annotation的成员变量指定值。也可以在定义Annotation时为其成员变量指定默认值,使用该Annotation时可以不为这些成员变量指定值,而是直接使用默认值。
综上,自定义注解的语法与定义形式如下:

  1. 以@interface关键字定义;
  2. 注解包含成员,成员以无参数的方法的形式被声明。其方法名和返回值定义了该成员的名字和类型。
  3. 成员赋值是通过@Annotation(name=value)的形式。
  4. 注解需要标明注解的生命周期,注解的修饰目标等信息,这些信息是通过元注解实现。

通过分析@Target元注解源码可以加深对自定义注解语法的理解:

@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = { ElementType.ANNOTATION_TYPE } )
public @interface Target
{
    ElementType[] value();
}

源码分析如下:

  1. 元注解@Retention,成员value的值为RetentionPolicy.RUNTIME。
  2. 元注解@Target,成员value是个数组,用{}形式赋值,值为ElementType.ANNOTATION_TYPE。
  3. 成员名称为value,类型为ElementType[]。

另外,需要注意一下,如果成员名称是value,在赋值过程中可以简写。如果成员类型为数组,但是只赋值一个元素,则也可以简写。如上面的简写形式为:@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE)。

4、应用

当开发者使用了Annotation修饰了类、方法、Field等成员之后,这些Annotation不会自己生效,必须由开发者提供相应的代码来提取并处理Annotation信息。这些处理提取和处理Annotation的代码统称为APT(Annotation Processing Tool)。JDK主要提供了两个类,来完成Annotation的提取:

4.1 注解相关的类

4.1.1 java.lang.annotation.Annotation

这个接口是所有Annotation类型的父接口(Annotation本质是接口,而java.lang.annotation.Annotation接口是这些接口的父接口)。java.lang.annotation.Annotation接口部分源码如下:

package java.lang.annotation;

public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

java.lang.annotation.Annotation接口的主要方法是annotationType(),用于返回该注解的java.lang.Class。

4.1.2 java.lang.reflect.AnnotatedElement

该接口代表程序中可以被注解的程序元素。java.lang.reflect.AnnotatedElement接口部分源码如下:

package java.lang.reflect;

import java.lang.annotation.Annotation;

public interface AnnotatedElement {

     boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);

    <T extends Annotation> T getAnnotation(Class<T> annotationClass);

    Annotation[] getAnnotations();

    Annotation[] getDeclaredAnnotations();
}

主要方法有:

  1. isAnnotationPresent(Class<? extends Annotation> annotationClass):判断该程序元素上是否存在指定类型的注解,如果存在则返回true,否则返回false。
  2. getAnnotation(Class<T> annotationClass):返回该程序元素上存在的指定类型的注解,如果该类型的注解不存在,则返回null。
  3. Annotation[] getAnnotations():返回该程序元素上存在的所有注解。

特别强调:java.lang.reflect.AnnotatedElement接口是所有程序元素(例如java.lang.Class、java.lang.reflect.Method、java.lang.reflect.Constructor等)的父接口。
所以程序通过反射获取了某个类的AnnotatedElement对象(例如,A类method1()方法的java.lang.reflect.Method对象)后,就可以调用该对象的isAnnotationPresent9)、getAnnotation()等方法来访问注解信息。
也就是说,为了获取注解信息,必须使用反射知识。如果想要在运行时提取注解信息,在定义注解时,该注解必须使用@Retention(RetentionPolicy.RUNTIME)修饰。

5、注解本质

  1. 注解实质上会被编译器编译为接口,并且继承java.lang.annotation.Annotation接口。
  2. 注解的成员变量会被编译器编译为同名的抽象方法。
  3. 根据Java的class文件规范,class文件中会在程序元素的属性位置记录注解信息。例如,RuntimeVisibleAnnotations属性位置,记录修饰该类的注解有哪些;flags属性位置,记录该类是不是注解;在方法的AnnotationDefault属性位置,记录注解的成员变量默认值是多少。

6、注解的意义

  1. 为编译器提供辅助信息 — Annotations可以为编译器提供而外信息,以便于检测错误,抑制警告等.

  2. 编译源代码时进行而外操作 — 软件工具可以通过处理Annotation信息来生成原代码,xml文件等等.

  3. 运行时处理 — 有一些annotation甚至可以在程序运行时被检测,使用.

总之,注解是一种元数据,起到了”描述,配置“的作用。

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

推荐阅读更多精彩内容