Java梳理之理解注解

现在的Java开发框架大多都会使用注解,如Spring,所以这里梳理一下注解方面,为之后深入理解框架做铺垫。

注解又称元数据,在《Java编程思想》中说到:它为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后可以很方便的使用这些数据。在有注解之前,一般会使用注释或者javadoc在程序代码中保留相应信息,Java1.5之后,可以通过注解来做这些事情,而且就像我们平常看到的Spring框架注解一样,不仅是保存元数据,我们还可以利用annotation包下的api编写注解处理器来处理这些注解,达到影响程序的效果。

注解定义

注解的语法比较简单,声明注解的关键字并不是annotation或者其他,它使用的是@interface。下面声明一个标记注解:

/**
**标记注解示例
**/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface AnnotationTest{  
}

在上面这个示例中,除了多@符号外,注解的定义整体上和接口的定义非常相似。上面的标记注解中没有定义任何的字段,就像是一个空接口,其实它和接口除了定义上有interface关键字重复外,并没有其他一样的地方,两者完全是两个不同的概念。
可以看到,在上面这个简单示例中还使用了其他两个元注解(负责注解其他注解)@Target@Retention用来定义注解,其中@Target指明该类型的注解可以注解的程序元素的范围,如果没有使用这个元注解,则说明可以使用在任何地方;而@Retention指明注解被保留的时间长短。保存策略RetentionPolicy取值为SOURCE,CLASS,RUNTIME,其中SOURCE指仅存在于源文件中,生成二进制表示时注解会丢失;CLASS表示会存在在二进制表示中,但是运行时会丢失;RUNTIME表示会存在在运行时,这为之后的反射处理注释影响程序的运行带来了可能。Java内置了四个元注解,还有如@Documented表示将此注解包含在Javadoc中,@Inherited表示允许子类继承父类的注解。
经过上面这个简单注解之后,我们可以考虑为注解加上元素,如下所示:

/**
**有元素的注解
**/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
@interface AnnotationTest{
    String createby();
    String lastupdate();
    int version() default 1;
}

在这个注解中,存在几个注解的元素,在使用的时候需要为元素赋值。当然,就像int version() default "1"元素一样,注解的元素可以有默认值default,其中默认值必须是相同类型的值或表达式,而且不能为null
类似于类的字段方法定义,注解元素定义也需要约束,如下所示:

注解内的元素定义约束:
1.元素的定义只能是基本数据类型、String类型、其他注解类型、Class或Class的某种特定泛型的调用和前面几种类型的数组。
2.元素不能声明任何的参数。
3.元素不能有任何throws字句。
4.元素不能定义类型参数 (泛型)。

在使用时,需要为这个注解的所有元素都赋值,如果有默认值可以使用默认值。如下使用所示:

/**
**使用自定义注解
**/
@AnnotationTest(createby="小二",lastupdate="2017-11-05",version=1)
public void test(){
    }

不仅是这样用,在上面的约束条件中有提到,注解的元素还可以是一个注解类型,这为注解带来了很大的灵活性,如下:

/**
**注解元素使用注解类型示例
**/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
@interface AnnotationTest{
    String createby();
    String lastupdate();
    Revision version();
}
@interface Revision{
    int min() default 1;
    int max() default 2;
}
/**
**注解元素是注解的使用
**/
@AnnotationTest(createby="小二",lastupdate="2017-11-05",version=@Revision)
public void test(){
    }
//如果没有默认值或默认值不正确,则需要指定值
@AnnotationTest(createby="小二",lastupdate="2017-11-05",version=@Revision(max=3))
    public void test(){
    }

这里需要提的是,注解还有几个隐式的约束条件,即,注解都隐式的扩展自Annotation接口,注解元素不是直接或间接的声明为它自己,注解不支持继承extends

注解处理器

如果没有注解处理器,那么引入注解这个功能并不比注释来的更有用。在Java1.5扩展了反射机制的API用来处理注释。下面看一个简单的注释处理器:

/**
**注解处理器,反射处理
**/
public static void annotationTracker(Class c){
        for(Method m:c.getDeclaredMethods()){
            AnnotationTest test = m.getAnnotation(AnnotationTest.class);
            if(test!=null)
            System.out.println("--method name = "+m.getName()+";--annotation value{ create by = "+test.createby()+",lastupdate="+test.lastupdate()+",version = "+test.version().min()+"-"+test.version().max()+"}");
        }
    }
输出:
--method name = test;--annotation value{ create by = 小二,lastupdate=2017-11-05,version = 1-3}
--method name = test1;--annotation value{ create by = 小二,lastupdate=2017-11-05,version = 1-2}
--method name = test2;--annotation value{ create by = 小二,lastupdate=2017-11-05,version = 0-1}

可以看到,在上面可以通过反射直接获取到注解的值,其前提条件是注解的保存策略必须是Runtime。在代码中,可以通过获取的值来进行逻辑判断以达到影响程序的效果,这也是很多框架使用注解的本质,但是框架的注解处理器特别复杂。

其实Java还提供了一个apt工具来解析处理注释,所以可以考虑使用apt来处理注释,需要注意的是,apt工具处理的是java源文件,而不是编译后的类文件,所以在使用的时候无法使用反射机制来获取信息。详情需要自行查看,这里只记录一下有这样一种方法处理注释。

Java內建注解:

@Override:使用该注解告知编译器父类的这个方法被重写了。
@Deprecated:不建议使用的方法,使用时最好说明为什么不建议使用和替代的方法。
@SuppressWarnings:忽略某个警告信息,范围只在source中,被编译后就不存在。

参考
《Java编程思想》
《Java程序设计语言》

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,077评论 25 707
  • 人的一生分五区: 一为童年,孩提无知 只懂欢笑 再为少年,少年有梦 敢与天齐 三为青年,青年追逐 诗与远方 四为中...
    毛小诗阅读 342评论 0 1
  • 心动如山倒 断爱如抽丝啊!
    你不是说说而已阅读 131评论 0 0
  • 我的家庭 我的姥姥爱料理、也爱唠叨,我的姥爷爱汽车、也爱拍照,我的爸爸是码农、搞通信哒,我的妈妈是奶牛、也爱画画!...
    枫叶不红阅读 422评论 0 8