注解

介绍

jdk1.5之后Java增加了对元数据(MetaData)的支持,也就是Annotation(注解),他是代码里的特殊标记,
这些标记可以在编译,类加载,运行时被读取,并执行相应操作。通过使用注解可以在不改变原有逻辑的情况下,
在源文件中添加补充信息,代码分析工具,开发工具,部署工具,可以更具这些信息进行验证和部署。
Annotation就像Java修饰符一样,可以用于修饰包、类、构造器、方法、变量、参数、局部变量,这些信息
存储在Annotation的"name=value“中。
Annotation对程序的运行无影响,如果希望Annotation在运行时其到作用,就需要通过配套工具对
annotation中的信息进行访问处理,这一工具统称为APT。

基本的Annotation

java5为我们提供了基本的Annotation,使用时在前面加上@,

        /**
         * 最常用的,限定重写父类方法,
         * 他在使用中我们感觉不到,主要是他作用是告诉编译器检查这个方法
         * 保证父类包含一个被该方法重写的方法,否则编译出错,避免程序员低级错误。
         */
        @Override

        /**
         * 标记过时
         * 标记类,方法等已过时,使用过时类、方法时编译器会发出警告
         */
        @Deprecated

        /**
         * 抑制编译警告
         * 有时程序编译会发出警告,但这时程序仍可正常运行,我们取消警告时使用。
         */
        @SuppressWarnings(value = "unchecked")

        /**
         * 堆污染 Java7出现
         * 在泛型的使用中有时会发生堆污染
         */
        @SafeVarargs

        /**
         * 函数式接口 Java8出现
         * 用该注解标记的接口必须是函数式接口
         */
        @FunctionalInterface

jdk的元Annotation

jdk除了除了五种基本的annotation外,在java.lang.annotation包下提供了6个Meta Annotation(元
annotation),其中5个都是用来修饰其他Annotation的,

  1. @Retention
    只能修饰annotation,用来指定修饰的Annotation可以保留多长时间。它包含一个RetentionPolicy类型
    使用该注解时,必须指定该类型值,类型值包含
    • RetentionPolicy.CLASS:编译器把annotation记录在class文件中,运行时jvm无法获取Annotation
      信息,这个是默认值。
    • RetentionPolicy.RUNTIME:编译器把annotation记录在class文件中,运行时可获取annotation
      信息,程序可通过反射获取annotation信息。
    • RetentionPolicy.SOURCE:annotation只保留在源代码中,编译器直接丢弃annotation,
        @Retention(value = RetentionPolicy.RUNTIME)
        public @interface Testable{}
  1. @Target
    也是只能修饰一个Annotation的定义,它用于指定被修饰的Annotation能用于修饰那些程序单元,@Target
    也包含一个名为value的成员,该成员值如下
    • ElementType.ANNOTTION_TYPE:指定该策略的annotation只能修饰annotation。
    • ElementType.CONSTRUCTOR:指定该策略的annotation只能修饰构造器
    • ElementType.FIELD:指定该策略的annotation只能修饰成员变量
    • ElementType.LOCAL_VARIABLE:指定该annotation只能修饰局部变量
    • ElementType.METHOD:指定该annotation只能修饰方法定义
    • ElementType.PACKAGE:指定该annotation只能修饰包定义
    • ElementType.PARAMETER:指定该annotation只能修饰参数
    • ElementType.TYPE:指定该annotation可以修饰类、接口(包括注解)、枚举定义。
        @Target(ElementType.FIELD)
        public @interface ActionListenerFor{}
  1. @Documented
    用于指定该元annotation修饰的annotation类将被Javadoc工具提取成文档,就是你定义的注解有@Documented
    修饰,在自动提取API文档时,文档的方法会带有这个注解
  2. @Inherited
    该元annotation指定被它修饰的annotation将具有继承性,例如使用该元注解自定义的annotation,在修饰
    了一个类后,该类的子类则默认使用你自定义的注解
//自定义注解
@Inherited
public @interface Inheritable{}

//使用自定义注解
@Inheritable
class Base{}

//检测子类是否带有注解
public class MyBase extends Base{
    public static void main(String [] args){
        //利用发射,来检查是否有注解,输出:true
        System.out.println(MyBase.class.isAnnotationPresent(Inheritable.class));
    }
}

自定义注解

自定义注解使用关键字 @interface,定义一个新的annotation类型与定义一个接口非常像,自定义注解后
就可以在任何地方使用了,

//自定义注解
public @interface Test{}

自定义注解的成员变量

自定义注解的成员变量以无形参的方法形式来声明,其方法名和返回值定义该成员变量的名字和类型,
还可以为注解的成员变量设置默认值,以方法名后 default关键字 后在变量的值实现,

public @interface Test{
    //定义String 类型的name成员变量,默认值为 “tian"
    String name() default "tian";
    int age() default 2 ;
}

//使用
@Test(name = "song", age = 12)
public class Person{}

提取Annotation信息

提取annotation信息需要了解Java反射的使用,annotation也是是类/类成员的一种属性,通过反射我们
可以得到annotation的信息,在利用这些信息进行进一步的操作。

/**
* 注意使用Retention,只有指定Retention为RetentionPolicy.RUNTIME
* 时在运行时才能获得注解信息
*/
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Test {
    String name() default "tian";
    int age() default 12;
}

//使用自定义注解
@Test(name = "song", age = 27)
public class Person {
}

//利用反射获取注解信息
public static void main(String[] args) {
    Annotation[] annotations = Person.class.getAnnotations();
    for (Annotation annotation : annotations) {
        if (annotation instanceof Test) {
            log(((Test) annotation).name());
        }
    }
}

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

推荐阅读更多精彩内容