当前位置:首页 > 全部子站 > IT > 思科认证

Java实战篇:设计自己的Annotation

来源:长理培训发布时间:2017-12-21 16:25:43

  第一部分:了解一下java1.5起默认的三个annotation类型:

  一个是@Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。

  一个是@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.

  一个是@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.

  如果不清楚上面三个类型的具体用法,各位可以baidu或google一下的,很简单的。

  第二部分:讲一下annotation的概念,再来讲一下怎样设计自己的annotation.

  首先在jdk自带的java.lang.annotation包里,打开如下几个源文件:

  1、源文件Target.java

  代码

 

@Documented 
@Target(ElementType.ANNOTATION_TYPE) 
ElementType value(); 


  其中的@interface是一个关键字,在设计annotations的时候必须把一个类型定义为@interface,而不能用class或interface关键字(会不会觉得sun有点吝啬,偏偏搞得与interface这么像).

  2、源文件Retention.java

  代码

 

@Documented 
@Target(ElementType.ANNOTATION_TYPE) 
RetentionPolicy value(); 


  看到这里,大家可能都模糊了,都不知道在说什么,别急,往下看一下.

  在上面的文件都用到了RetentionPolicy,ElementType这两个字段,你可能就会猜到这是两个java文件.的确,这两个文件的源代码

  3、源文件RetentionPolicy.java

  代码

 

public enum RetentionPolicy { 
CLASS, 
}


  这是一个enum类型,共有三个值,分别是SOURCE,CLASS 和 RUNTIME.

  SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,Annotation的数据就会消失,并不会保留在编译好的.class文件里面。

  ClASS的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这一些信息加载到虚拟机(JVM)中去.注意一下,当你没有设定一个Annotation类型的Retention值时,系统默认值是CLASS.

  第三个,是RUNTIME,表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到JVM中去的.

  举一个例子,如@Override里面的Retention设为SOURCE,编译成功了就不要这一些检查的信息;相反,@Deprecated里面的Retention设为RUNTIME,表示除了在编译时会警告我们使用了哪个被Deprecated的方法,在执行的时候也可以查出该方法是否被Deprecated.

  4、源文件ElementType.java

  代码

 

public enum ElementType { 
LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE 


  @Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下:TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和Annotation类型上.

  另外,从1的源代码可以看出,@Target自己也用了自己来声明自己,只能用在ANNOTATION_TYPE之上. 

  举几个正确的例子:

 

@Target(ElementType.METHOD) 
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)


  具体参考一下javadoc文档

  上面一下1和2的源文件,它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.

  另外一点,如果需要把Annotation的数据继承给子类,那么就会用到@Inherited这一个Annotation类型. 

  一个是@Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。

  一个是@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.

  一个是@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.

  如果不清楚上面三个类型的具体用法,各位可以baidu或google一下的,很简单的。

  第二部分:讲一下annotation的概念,再来讲一下怎样设计自己的annotation.

  首先在jdk自带的java.lang.annotation包里,打开如下几个源文件:

  1、源文件Target.java

  代码

 

@Documented 
@Target(ElementType.ANNOTATION_TYPE) 
ElementType value(); 


  其中的@interface是一个关键字,在设计annotations的时候必须把一个类型定义为@interface,而不能用class或interface关键字(会不会觉得sun有点吝啬,偏偏搞得与interface这么像).

  2、源文件Retention.java

  代码

 

@Documented 
@Target(ElementType.ANNOTATION_TYPE) 
RetentionPolicy value(); 


  看到这里,大家可能都模糊了,都不知道在说什么,别急,往下看一下.

  在上面的文件都用到了RetentionPolicy,ElementType这两个字段,你可能就会猜到这是两个java文件.的确,这两个文件的源代码

  3、源文件RetentionPolicy.java

  代码

 

public enum RetentionPolicy { 
CLASS, 
}


  这是一个enum类型,共有三个值,分别是SOURCE,CLASS 和 RUNTIME.

  SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,Annotation的数据就会消失,并不会保留在编译好的.class文件里面。

  ClASS的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这一些信息加载到虚拟机(JVM)中去.注意一下,当你没有设定一个Annotation类型的Retention值时,系统默认值是CLASS.

  第三个,是RUNTIME,表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到JVM中去的.

  举一个例子,如@Override里面的Retention设为SOURCE,编译成功了就不要这一些检查的信息;相反,@Deprecated里面的Retention设为RUNTIME,表示除了在编译时会警告我们使用了哪个被Deprecated的方法,在执行的时候也可以查出该方法是否被Deprecated.

  4、源文件ElementType.java

  代码

 

public enum ElementType { 
LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE 


  @Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下:TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和Annotation类型上.

  另外,从1的源代码可以看出,@Target自己也用了自己来声明自己,只能用在ANNOTATION_TYPE之上. 

  举几个正确的例子:

 

@Target(ElementType.METHOD) 
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)


  具体参考一下javadoc文档

  上面一下1和2的源文件,它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.

  另外一点,如果需要把Annotation的数据继承给子类,那么就会用到@Inherited这一个Annotation类型.

 

责编:罗莉

发表评论(共0条评论)
请自觉遵守互联网相关政策法规,评论内容只代表网友观点,发表审核后显示!

国家电网校园招聘考试直播课程通关班

  • 讲师:刘萍萍 / 谢楠
  • 课时:160h
  • 价格 4580

特色双名师解密新课程高频考点,送国家电网教材讲义,助力一次通关

配套通关班送国网在线题库一套

课程专业名称
讲师
课时
查看课程

国家电网招聘考试录播视频课程

  • 讲师:崔莹莹 / 刘萍萍
  • 课时:180h
  • 价格 3580

特色解密新课程高频考点,免费学习,助力一次通关

配套全套国网视频课程免费学习

课程专业名称
讲师
课时
查看课程
在线题库
面授课程更多>>
图书商城更多>>
在线报名
  • 报考专业:
    *(必填)
  • 姓名:
    *(必填)
  • 手机号码:
    *(必填)
返回顶部