3分钟快速掌握注解(Annotation)

由于本人能力有限,文中若有错误之处,欢迎指正。
转载请注明出处:http://www.jianshu.com/p/e3949dedbe48

写在前面

本篇主要讲解注解的基本概念、基本使用,以及容易产生迷惑的地方。实例应用将在后续的简文中继续分析。

什么是注解?

官方解释:能够添加到 Java 源代码的语法元数据。类、方法、变量、参数、包都可以被注解,可用来将信息元数据与程序元素进行关联。
注解(也被成为元数据)为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便地使用这些数据。

通俗来说:其实注解也是一种注释,只不过,注解可以指定保留的时间,以及携带一些相关的数据。而注释只能在源码中存在。

元注解

注解当中也会存在注解,这种给自定义注解使用的注解称为---元注解

  • @Rentention
    用来标记自定义注解的有效范围。有三种:
有效范围
RetentionPolicy.SOURCE 只在源代码中保留,编译器会忽略,一般都是用来增加代码的理解性或者帮助代码检查之类的,比如@Override
RetentionPolicy.CLASS 默认选择,能把注解保留到编译后的字节码class文件中,仅仅到字节码文件中,运行时是无法得到的。一般用在动态生成模板代码的类库中。比如ButterKnife
RetentionPolicy.RUNTIME 注解不仅 能保留到class字节码文件中,还能在运行通过反射获取到,这是最常用的一种。
  • @Target
    规定注解所修饰的对象范围。
修饰范围
ElementType.CONSTRUCTOR 构造器声明
ElementType.FIELD 成员变量、对象、属性(包括enum实例)
ElementType.LOCAL_VARIABLE 局部变量声明
ElementType.METHOD 方法声明
ElementType.PACKAGE 包声明
ElementType.PARAMETER 参数声明
ElementType.TYPE 类、接口(包括注解类型)或enum声明
  • @Documented
    标记着此注解会被javadoc工具提取成文档。

  • @Interited
    允许子类继承父类中的注解。将在最后以示例的形式讲解

自定义注解

我们可以在使用元注解的基础上,使用 @interface关键字实现自定义注解。其默认继承自:java.lang.annotation.Annotation。如下所示:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Inherited
public @interface MyAnnotation {
    int value() default 1;
    boolean canBeNull() default false;
}

上面的自定义注解可以这样使用:
@MyAnnotation @MyAnnotation() @MyAnnotation(1) @MyAnnotation(value=1) @MyAnnotation(canBuNull = true) @MyAnnotation(value = 1,canBuNull = true)

不能这样使用
@MyAnnotation(true)
因为当括号中的内容不以键值对的形式出现时,默认使用的是value =

注解元素

注解元素名来自于注解类的方法名,且有以下特点:

  1. 方法返回值只能是基本数据类型String, Class, annotation, enum它们的一维数组
  2. 所有方法没有方法体没有参数没有修饰符,默认为 public abstract修饰。不允许抛异常
  3. 若只有一个默认元素,可直接用value()函数。一个元素都没有表示该注解为标记注解(Mark Annotation)

默认值

注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定。
注解元素的值不能为null

@Retention(RetentionPolicy.RUNTIME)
@Target({FIELD, TYPE, METHOD})
public @interface MyAnnotation {

    int value() default 1;

    boolean[] canWrite() default {true, false};

    Class test();  // 定义的时候没有默认值,在使用的时候必须指定
}

// 使用示例
@MyAnnotation(value = 23, test = Integer.class)
int age;

@Interited元注解

允许子类继承父类中的注解。
当被@Inherited标注的注解的RetentionRetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用反射去查询一个@Inherited注解类型的注解时,反射代码检查将展开工作:检查class和其父类,直到指定的注解类型被发现,或者到达类继承结构的顶层Object

相对于其它元注解,@Interited元注解比较特殊,下面将以示例的形式帮助大家更好的理解它的作用:

首先我们定义一个自定义注解@MyAnnotation并使用@Interited标记

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
@Inherited
public @interface MyAnnotation {

    String value() default "";
}

定义一个类SuperClass

@MyAnnotation("SuperClass")
public class SuperClass {

    @MyAnnotation("SuperClass::testMethod")
    public void testMethod(){
    }
}

定义一个类SubClass继承自SuperClass

public class SubClass extends SuperClass {

}

测试主程序:

public class Main {

    public static void main(String[] args) throws Exception{

        testSuper();

        testSub();
    }

    private static void testSub() {
        MyAnnotation myAnnotation = SubClass.class.getAnnotation(MyAnnotation.class);
        if(myAnnotation == null){
            System.out.println("注解不存在");
            return;
        }
        String value = myAnnotation.value();
        System.out.println(value);
    }

    private static void testSuper() {
        MyAnnotation myAnnotation = SuperClass.class.getAnnotation(MyAnnotation.class);
        if(myAnnotation == null){
            System.out.println("注解不存在");
            return;
        }
        String value = myAnnotation.value();
        System.out.println(value);
    }

}

运行以上程序,testSub() testSuper() 都打印的是在SuperClass类标记的注解值SuperClass。而SubClass类中没有使用注解,所以,可以确定是从父类中继承过来的。这里面起到关键作用的就是@Interited元注解

还有很多种情况,大家可以自行编码尝试,下面给出总结
注: 父类使用的注解被@Inherited标注的情况下

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

推荐阅读更多精彩内容