Java注解学习笔记

作为一个Android开发者,关于注解应该用的很多,比如大名鼎鼎的ButterKnife框架,就是主要依赖于注解实现的。在开发过程中我们也实际的体会到了注解的遍历。但是关于注解的开发,很多人却并不熟悉,一方面注解这个概念引入的较晚,大概在Java5.0时才引入。另一方面,关于它的一些高级操作都必须借助于反射,而很多人又对反射掌握的并不是很好。今天,在这里就把Java注解做一个学习。

首先注解其实就是一个接口,但是为了和接口进行区分,便是下面这个样子,这里我们先以最常见的Override注解为例:

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

如上面所示,要定义一个注解只需像定义一个接口一样,但是要在interface前面加@符号。但是仅仅这样声明的话,这个注解是没有任何功能的。要使一个注解有功能,我们要先从元注解开始了解。

元注解就是几个基本注解,用于注解自定义注解的,就像Java中的基本数据类型。若是没有那几个基本类型,所有Java程序可能就无从谈起了。以上面Override 注解为例,它有两个元注解,分别是Retention和Target。元注解的功能就是定义个限制我们的注解的功能和行为。首先先来了解一下所有的元注解。

元注解并不多,因为它们是基本的注解,所以只覆盖一些重要的部分(就像基本数据类型一样),一共有下面5种:

  • 1、@Retention
    这个注解类似于一种声明周期的概念,他规定一个注解的存活时间。它的值为一个枚举类:RetentionPolicy。共有一下三种:
 RetentionPolicy.SOURCE //定义该注解仅在源码中保留,编译时便会被抛弃

 RetentionPolicy.CLASS  //定义该注解只保留到字节码文件中,但不会被加载到虚拟机

 RetentionPolicy.RUNTIME //定义该注解最后会被加载到虚拟机中,运行时可得

就像那个Override 注解一样,他只是标记某个方法是父类的重写,对程序运行没有任何影响,为了不增大程序体积,所以只需在源码阶段保留,做一个提示就好。

  • 2、@Target
    这个注解规定该注解的应用范围,以Override 为例,他只是标记该方法是否是重写方法,所以只能用在方法上,也就是METHOD,该元注解的值是枚举类ElementType,一共有下面几个值:
    ElementType.TYPE //可以用在类,接口(包括注解),枚举

    ElementType.FIELD  //可以用在成员变量(包括枚举值)

    ElementType.METHOD  //可以用在方法上

    ElementType.PARAMETER //可以用在参数上

    ElementType.CONSTRUCTOR //可以用在构造方法上

    ElementType.LOCAL_VARIABLE  //可以用在局部方法

    ElementType.ANNOTATION_TYPE //可以用在注解上

    ElementType.PACKAGE //可以用在包上

    ElementType.TYPE_PARAMETER //用来标注类型参数

    ElementType.TYPE_USE //能标注任何类型名称
  • 3、@Documented
    这个注解意味着该注解将包含在 javadoc 中 ,将会被javadoc工具提取成文档
  • 4、@Inherited
    以这个注解修饰的注解去标注一个类时,这个类的子类也同样会拥有该注解。说起来比较拗口,下面代码解释一下:
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation{}


@MyAnnotation
public class A {}


public class B extends A {}

在上面代码中B虽然没有MyAnnotation注解,但是A有,而且MyAnnotation有Inherited声明,所以B也有MyAnnotation注解。

  • 5.@Repeatable
    这是Java1.8的新特性,他表示一个注解可以重复注解多次。我们举一个例子:

正常情况下重复一个注解会报错:



但是我们做如下修改后·:

@Retention(RetentionPolicy.RUNTIME)
public @interface Values {
    MyAnnotation[] value();
}

@Repeatable(value = Values.class)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String Author() default "chen";
}

这样就不会报错了:



至于多个注解的值可以这样取:

if (MyClass.class.isAnnotationPresent(Values.class)){
            Values values = MyClass.class.getAnnotation(Values.class);
            for (MyAnnotation annotation : values.value())
                System.out.println(annotation.Author());
        }

上面介绍了5种元注解,下面介绍注解本身的知识,注解本身其实相当于一种接口,我们应用注解时,就相当于实现注解中的方法。那么注解作为一种特殊的存在,他的方法有没有什么特殊要求呢?

这里要说明的是,注解实际上是没有方法的,它只有成员变量,但是成员变量的声明和接口方法很类似,只不过都是无参的形式。所以怎样理解都行。首先注解的成员类型只能为基本数据类型、类、接口或者是注解。它可以有默认值,以default关键字修饰。举例如下:

public @interface MyAnnotation {
    String Author() default "chen";
}

在使用时如下:

@MyAnnotation(Author = "liu")
public class MyClass {
    @MyAnnotation(Author = "li")
    public void fun(){

    }
}

另外,如果一个注解仅有一个名字为value的成员变量时,应用是括号中可以直接写值,而不必写变量名,如在上面的Repeatable注解中的例子,MyAnnotation 可以这样写:

@Repeatable(Values.class)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String Author() default "chen";
}

上面就是注解的定义和应用。但是仅有这样是不够的,注解依其字面意思就可以知道,就类似与注释标签的意思,注解是用来给别人看的,那么我么你在程序运行中,怎么拿到注解的内容呢?

首先,对于类的注解可以这样:

if (MyClass.class.isAnnotationPresent(MyAnnotation.class)){
        MyAnnotation annotation = MyClass.class.getAnnotation(MyAnnotation.class);
        System.out.println(annotation.Author());
}

也就是首先判断某各类是否有某个注解,然后再拿到该注解,然后取值。对应的还有一个更笼统的方法:isAnnotation();判读时候有注解修饰,然后拿到全部注解:getAnnotations()。

其次对于成员变量或者方法的注解,则要依靠反射了:

        try {
            Method testMethod = MyClass.class.getDeclaredMethod("fun");
            MyAnnotation annotation = testMethod.getAnnotation(MyAnnotation.class);
            if (annotation!=null)
                System.out.println(annotation.Author());
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }

对于方法,没有判断是否有某个注解的方法,只能直接去取,不为空的话就是有,然后再取值就可以,当然也可以拿到全部注解:getAnnotations()。

对于方法中的参数也很简单:

            Method method = MyClass.class.getDeclaredMethod("fun");
            MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
            Parameter parameter = method.getParameters()[0];
            parameter.getAnnotation(MyAnnotation.class);

基本套路都是一样的,关键是借助于反射。

到这里注解的介绍基本上就完成了,不能否认,注解如果运用恰当,绝对是一个强大的工具。

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

推荐阅读更多精彩内容