聊聊 java 注解

概述

在上一篇Retrofit 2.0 的使用中可以看到很多应用了注解的地方,例如:

@HTTP(method = "get", path = "userInfo/{userId}", hasBody = false)
Call<ResponseBody> getCardNum(@Path("userId") int id);

那什么是注解呢?可以看下 Google 得到的解释

JDK 5中引入了源代码中的注解(annotation)这一机制。 注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。 注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。

通俗点说可以理解为注解是一种标签、说明,用来表示被该注解修饰的一方(可以是类、方法、属性等)的一些含义,例如:

@Override
public boolean onInterceptTouchEvent(MotionEvent ev) {
                return false;
}

@Override 这个应该很多人都见过的,onInterceptTouchEvent 这个方法被@Override 注解了,告诉编译器说这个方法是重写了父类里面的方法,如果一个类A里面的方法使用了这个注解,但是类A 的父类B里面没有这个方法的话编译器就会报错。

元注解

注解一般用来注解类、方法、类的属性等,元注解就是用来应用在注解上的注解,元字代表它是一种根源上的东西,用来修饰说明被应用的注解的含义及应用范围。java 中元注解有这么几个:@Retention、@Documented、@Target、@Inherited,java 7 版本开始增加了 @SafeVarargs、@FunctionalInterface(java 8 开始支持)、@Repeatable(java 8 开始支持)

  • @Retention:标注被@Retention 修饰的注解要怎么保存
  • @Documented:标注被@Documented 修饰的注解是否包含在用户文档中
  • @Target:表明@Target可以注解于哪种 java 成员,被@Target(METHOD) 注解的注解只能用于 method
  • @Inherited 继承,表明被@Inherited 修饰了的注解应用时会传递到子类,如果子类没有被其他注解应用的话。
  • @SafeVarargs 忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告
  • @FunctionalInterface 标识一个匿名函数或函数式接口
  • @Repeatable 表明被@Repeatable修饰了的注解去应用时可以有多个值,比如
@interface Roles {
    Role[]  value();
}

@Repeatable(Roles.class)
@interface Role{
    String value default "";
}

@Person(value="A")
@Person(value="B")
public class Man{

}

一个注解的Hello World

1、定义一个注解

@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface HelloAnnotation {
  String msg() default "Hello Wolrd";
}

注解由 @interface 声明,上面的例子中"String msg()" 是声明一个成员变量,并不是一个成员方法,需要注意的是注解只有成员变量,没有成员方法,default 后面代表的是该成员变量的一个默认值,如果使用该注解时没有传参数值使用默认值。

2、使用注解

//传入参数值
@Msg(msg = "Hello TestA")
public class TestA{
    
}
//不传使用默认值
@Msg
public class Test {
    
}

传入参数时使用 “参数名 = 值" 的方式传入,如果定义的注解只有一个成员变量,使用时则可以直接把值传进去,例如:

@Msg( "Hello TestA")
public class TestA{
    
}

注解在 Retrofit 中的使用

回到文章开头使用的例子

@HTTP(method = "get", path = "userInfo/{userId}", hasBody = false)
Call<ResponseBody> getCardNum(@Path("userId") int id);

看一下@HTTP 的定义

@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface HTTP {
  String method();
  /**
   * A relative or absolute path, or full URL of the endpoint. This value is optional if the first
   * parameter of the method is annotated with {@link Url @Url}.
   * <p>
   * See {@linkplain retrofit2.Retrofit.Builder#baseUrl(HttpUrl) base URL} for details of how
   * this is resolved against a base URL to create the full endpoint URL.
   */
  String path() default "";
  boolean hasBody() default false;
}

@HTTP 包含三个成员变量,method 声明这个请求的方法是“GET”、“POST”或者是其他,path 和 baseUrl 组成一个完整的请求URL。@HTTP 被 @Target(METHOD) 这个元注解修饰了,说明@HTTP 只能用于修饰方法,@Retention(RUNTIME) 说明了@HTTP 这个注解的生命周期为RetentionPolicy.RUNTIME,所以可以运行时通过反射获取。再来看下getCardNum(@Path("userId") int id) 里面用到的@Path

@Documented
@Retention(RUNTIME)
@Target(PARAMETER)
public @interface Path {
  String value();

  /**
   * Specifies whether the argument value to the annotated method parameter is already URL encoded.
   */
  boolean encoded() default false;
}

@Path 和@HTTP 的不同在于@Path 用于修饰 parameter,同样的是都可以在运行时通过反射获取,在运行时通过反射获取到修饰在getCardNum 这个方法上的注解的值可以得到这是一个 “GET” 请求的方法,path为"userInfo/{userId}",里面有一个userId 需要赋值,再从getCardNum 这个方法中找到被 值为“userId”的@Path 修饰的 parameter,把这个parameter 的值赋予 userId,这样一个 Http 请求就出来了。

以上只是个人学习过程中的理解,可能有错误的地方,希望看到的同学指出错误之处,互相学习。

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

推荐阅读更多精彩内容