Annotations 0

java annotations basics

What are Anotations?

如果用一个单词来描述Annotation那就是Metadata, Metadata是描述数据的数据,所以Annotation可以理解为code的元数据描述。Annotation在JDK5.0版本被引入,大概是如下图这样的

@Override
public String toString() {
    return "This is String Representation of current object."
}

这里重载了toString()方法,用到了@Override注解。如果去掉了@Override,代码也能正常运行。那为什么还要用它呢?@Override注解告诉编译器这是一个重载方法,是关于method的描述。如果父类中没有这个方法,那么编译器会报错,如下:

Error:(8, 5) java: 方法不会覆盖或实现超类型的方法

重新定义:
Annotation是用来装饰class、method、field、parameter、variable、constructor和package的一种特殊Java结构体。

How Annotations Work

Java内置的Override注解源码如下:

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

可以看出Override没有什么东西,又怎么做到检验重载方法是否定义在父类中。原因是Annotation只是metadata,不包含任何的业务逻辑。可以这么来理解,Annotation是class、method、package、field的装饰信息的生产者,对应的还有一个信息的消费者。那这里的@Override的问题就好理解了,Override是信息的提供者,JVM是信息的消费者,在二进制层面来检测重载方法的是否存在于父类中。

How to Write Custom Annotations

JDK提供了4中内置的元注解,作用是注解其他的注解,分别是

@Documented - Whether to put the annotation in Javadocs
@Retention - When the annotation is needed
@Target? - Places the annotation can go
@Inherited - Whether subclasses get the annotation

@Retention - Annotation被保留的时间长短,标注注解的生命周期。3种RetentionPolicy的取值说明如下

RetentionPolicy.SOURCE - 在编译期间就被抛弃。这类注解在编译完成后就没有任何意义了,不会被写到字节码里。比如@Override、@SuppressWarnings

RetentionPolicy.CLASS - 在class加载时被抛弃。适合在编译成字节码后做一些处理,而且是Retention的默认值。

RetentionPolicy.RUNTIME - 不抛弃。这类注解适用于运行时反射

@Target - 注解放置的位置
如果不指定@Target的话,可以放到任何地方,一般的使用如下

ElementType.TYPE (class, interface, enum)
ElementType.FIELD (instance variable)
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE (on another annotation)
ElementType.PACKAGE (remember package-info.java)

@Inherited – 控制是否影响子类

注解的内容(属性)仅支持String和enum类型,所有属性被定义成方法,还可以提供默认值

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
public enum Priority {LOW, MEDIUM, HIGH}
public enum Status {STARTED, NOT_STARTED}
String author() default "Yash";
Priority priority() default Priority.LOW;
Status status() default Status.NOT_STARTED;
}

那么@Todo注解的使用方式是怎么呢,如下

@Todo(priority = Todo.Priority.MEDIUM, author = "Yashwant", status = Todo.Status.STARTED)
public void incompleteMethod1() {
//Some business logic is written
//But it’s not complete yet
}

如果Annotation里面仅有一个属性,可以命名为"value",如下

@interface Author{
String value();
}
@Author("Yashwant")
public void someMethod() {
}

How to use custom Annotations

1, 反射

反射会提供Class、Method和Field对象,这些对象都有共同的方法getAnnotation(),强转成自定义的Annotation后就可以使用在Annotation内部定义的属性,如下

Class businessLogicClass = BusinessLogic.class;
for(Method method : businessLogicClass.getMethods()) {
Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);
if(todoAnnotation != null) {
System.out.println(" Method Name : " + method.getName());
System.out.println(" Author : " + todoAnnotation.author());
System.out.println(" Priority : " + todoAnnotation.priority());
System.out.println(" Status : " + todoAnnotation.status());
}
}
## 2,Android里的@StringDef@IntDef代替Enum
[点这查看](http://tools.android.com/tech-docs/support-annotations)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容

  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,141评论 0 2
  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 29,119评论 15 116
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • Java 8自Java 5(发行于2004)以来最具革命性的版本。Java 8 为Java语言、编译器、类库、开发...
    谁在烽烟彼岸阅读 886评论 0 4
  • 不同服务器上的不同数据库表结构,字段互相拷贝 1.不同服务器上,同一类数据库,postgresql数据库之间互相拷...
    邓凯献阅读 4,772评论 0 1