`
k_lb
  • 浏览: 837782 次
  • 性别: Icon_minigender_1
  • 来自: 郑州
社区版块
存档分类
最新评论
  • kitleer: 据我所知,国内有款ETL调度监控工具TaskCTL,支持ket ...
    kettle调度

java注解学习 转载

 
阅读更多

来自于:http://www.iteye.com/topic/36659


Annotation在java的世界正铺天盖地展开,有空写这一篇简单的annotations的文章,算是关于Annotation入门的文章吧,希望能各位们能抛砖,共同学习......

不讲废话了,实践才是硬道理.

第一部分:了解一下java1.5起默认的三个annotation类型:
一个是@Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。
一个是@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
一个是@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.
如果不清楚上面三个类型的具体用法,各位可以baidu或google一下的,很简单的。

第二部分:讲一下annotation的概念先,再来讲一下怎样设计自己的annotation.
首先在jdk自带的java.lang.annotation包里,打开如下几个源文件:

1、源文件Target.java
Java代码收藏代码
  1. @Documented
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Target(ElementType.ANNOTATION_TYPE)
  4. public@interfaceTarget{
  5. ElementType[]value();
  6. }


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

2、源文件Retention.java
Java代码收藏代码
  1. @Documented
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Target(ElementType.ANNOTATION_TYPE)
  4. public@interfaceRetention{
  5. RetentionPolicyvalue();
  6. }


看到这里,大家可能都模糊了,都不知道在说什么,别急,往下看一下.
在上面的文件都用到了RetentionPolicy,ElementType这两个字段,你可能就会猜到这是两个java文件.的确,这两个文件的源代码如下:

3、源文件RetentionPolicy.java
Java代码收藏代码
  1. publicenumRetentionPolicy{
  2. SOURCE,
  3. CLASS,
  4. RUNTIME
  5. }

这是一个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
Java代码收藏代码
  1. publicenumElementType{
  2. TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,
  3. LOCAL_VARIABLE,ANNOTATION_TYPE,PACKAGE
  4. }

@Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下:TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和Annotation类型上.
另外,从1的源代码可以看出,@Target自己也用了自己来声明自己,只能用在ANNOTATION_TYPE之上.
如果一个Annotation类型没有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,这里的元素指的是上面的八种类型.
举几个正确的例子:
@Target(ElementType.METHOD)
@Target(value=ElementType.METHOD)
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)
具体参考一下javadoc文档

上面一下1和2的源文件,它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.
另外一点,如果需要把Annotation的数据继承给子类,那么就会用到@Inherited这一个Annotation类型.

第三部分:下面讲的设计一个最简单的Annotation例子,这一例子共用四个文件;
1、Description.java
Java代码收藏代码
  1. packagelighter.iteye.com;
  2. importjava.lang.annotation.Documented;
  3. importjava.lang.annotation.ElementType;
  4. importjava.lang.annotation.Retention;
  5. importjava.lang.annotation.RetentionPolicy;
  6. importjava.lang.annotation.Target;
  7. @Target(ElementType.TYPE)
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Documented
  10. public@interfaceDescription{
  11. Stringvalue();
  12. }


说明:所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.
最重要的一点,Annotation类型里面的参数该怎么设定:
第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型.
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String.
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:上面的例子就只有一个参数成员.

2、Name.java
Java代码收藏代码
  1. packagelighter.iteye.com;
  2. importjava.lang.annotation.Documented;
  3. importjava.lang.annotation.ElementType;
  4. importjava.lang.annotation.Retention;
  5. importjava.lang.annotation.RetentionPolicy;
  6. importjava.lang.annotation.Target;
  7. //注意这里的@Target与@Description里的不同,参数成员也不同
  8. @Target(ElementType.METHOD)
  9. @Retention(RetentionPolicy.RUNTIME)
  10. @Documented
  11. public@interfaceName{
  12. Stringoriginate();
  13. Stringcommunity();
  14. }


3、JavaEyer.java
Java代码收藏代码
  1. packagelighter.iteye.com;
  2. @Description("javaeye,做最棒的软件开发交流社区")
  3. publicclassJavaEyer{
  4. @Name(originate="创始人:robbin",community="javaEye")
  5. publicStringgetName()
  6. {
  7. returnnull;
  8. }
  9. @Name(originate="创始人:江南白衣",community="springside")
  10. publicStringgetName2()
  11. {
  12. return"借用两位的id一用,写这一个例子,请见谅!";
  13. }
  14. }

4、最后,写一个可以运行提取JavaEyer信息的类TestAnnotation
Java代码收藏代码
  1. packagelighter.iteye.com;
  2. importjava.lang.reflect.Method;
  3. importjava.util.HashSet;
  4. importjava.util.Set;
  5. publicclassTestAnnotation{
  6. /**
  7. *authorlighter
  8. *说明:具体关天Annotation的API的用法请参见javaDoc文档
  9. */
  10. publicstaticvoidmain(String[]args)throwsException{
  11. StringCLASS_NAME="lighter.iteye.com.JavaEyer";
  12. Classtest=Class.forName(CLASS_NAME);
  13. Method[]method=test.getMethods();
  14. booleanflag=test.isAnnotationPresent(Description.class);
  15. if(flag)
  16. {
  17. Descriptiondes=(Description)test.getAnnotation(Description.class);
  18. System.out.println("描述:"+des.value());
  19. System.out.println("-----------------");
  20. }
  21. //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去
  22. Set<Method>set=newHashSet<Method>();
  23. for(inti=0;i<method.length;i++)
  24. {
  25. booleanotherFlag=method[i].isAnnotationPresent(Name.class);
  26. if(otherFlag)set.add(method[i]);
  27. }
  28. for(Methodm:set)
  29. {
  30. Namename=m.getAnnotation(Name.class);
  31. System.out.println(name.originate());
  32. System.out.println("创建的社区:"+name.community());
  33. }
  34. }
  35. }

5、运行结果:
描述:javaeye,做最棒的软件开发交流社区
-----------------
创始人:robbin
创建的社区:javaEye
创始人:江南白衣
创建的社区:springside

这一篇文章写了两个小时有多啦,也算是一篇关于设计自定的Annotation的入门篇啦;另外,特在处声明,如果转载请注明出处:http://lighter.iteye.com。
参考资料:
1、http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html
2、http://caterpillar.onlyfun.net/Gossip/
3、http://calvin.iteye.com/blog/33210
分享到:
评论

相关推荐

    java编程事项(转载收集整理版)

    学习Java首先要了解变量声明、数据类型(如int、String等)、运算符、控制结构(如if语句、for循环、while循环)以及方法定义。 2. **类与对象**:Java是基于类的,这意味着一切皆为对象。理解类的定义、构造函数、...

    JAVA OA平台源码(转载)SPRING BOOT....

    【标题】:“JAVA OA平台源码(转载)SPRING BOOT...” 这个开源项目是一个基于Java技术的OA(Office Automation)管理系统的源代码实现,利用了Spring Boot框架进行开发。Spring Boot是Spring生态中的一个核心组件...

    java编程思想习题及答案

    这份资料可能是从www.pigkrtv.com等网站转载而来,旨在帮助学习者深化对Java编程语言的理解,提高编程技能。 在Java编程学习过程中,掌握基本概念、语法以及解决问题的能力至关重要。这份习题集涵盖了以下几个关键...

    leetcode下载-java-eight-part:『Java八股文』Java面试套路,Java进阶学习,打破内卷拿大厂Offer,升职加薪

    Java注解 :baby_chick: Redis 面试八股文 知识点详解 :tiger_face: 消息队列(kafka) :cow_face: 分布式 :ewe: 关系数据库 :frog: 五分钟入门系列 :horse_face: 设计模式 :light_bulb: 工具&效率提升 Git 基础教程: ...

    java事例集合1

    【描述】中的"事例集合1(转载)"表明这些内容可能来源于网络,可能是某个开发者或教育者收集并整理的Java编程实例,目的是帮助学习者通过实际操作来理解Java编程。而"看韩剧www.pigkrtv.com"这部分看起来像是无关的...

    Python学习 | 一个JAVA程序员两天的Python入门笔记

    人物:一个心血来潮学习Python的JAVA程序员 文章目录vlog正文入门基础注释算数运算符及优先级程序执行原理变量概念和定义方式变量的命名变量的输入和输出数据类型数值型非数值型列表元组列表与元组的互相转换字典...

    JAVA WEB 开发详解:XML+XSLT+SERVLET+JSP 深入剖析与实例应用.part2

    此外,本书的配套光盘还免费提供了价值人民币330元的java教学视频,对java语言进行了全面讲解,帮助一些不会java语言的读者快速地从java基础知识的学习中过渡到java web的学习与开发上. 第1部分 xml篇. 第1章 xml...

    java8源码-JavaGuide:从JavaGuide复制,添加一些个人注释

    学习手册,在公众号 后台回复“面试突击”即可获取。 :thumbs_up: 图解操作系统+HTTP+计算机网络的 PDF 资料。 一些闲话: JavaGuide 介绍:关于 JavaGuide 的相关介绍请看: 。PDF 版本请看: 。 在线阅读 :如果 ...

    JAVA WEB 开发详解:XML+XSLT+SERVLET+JSP 深入剖析与实例应用.part4

    此外,本书的配套光盘还免费提供了价值人民币330元的java教学视频,对java语言进行了全面讲解,帮助一些不会java语言的读者快速地从java基础知识的学习中过渡到java web的学习与开发上. 第1部分 xml篇. 第1章 xml...

    JAVA WEB 开发详解:XML+XSLT+SERVLET+JSP 深入剖析与实例应用.part5

    此外,本书的配套光盘还免费提供了价值人民币330元的java教学视频,对java语言进行了全面讲解,帮助一些不会java语言的读者快速地从java基础知识的学习中过渡到java web的学习与开发上. 第1部分 xml篇. 第1章 xml...

    JAVA WEB 开发详解:XML+XSLT+SERVLET+JSP 深入剖析与实例应用.part3

    此外,本书的配套光盘还免费提供了价值人民币330元的java教学视频,对java语言进行了全面讲解,帮助一些不会java语言的读者快速地从java基础知识的学习中过渡到java web的学习与开发上. 第1部分 xml篇. 第1章 xml...

    [转载]Android学习笔记(三):Andriod程序框架.doc

    这篇学习笔记主要涵盖了如何在Eclipse环境下创建一个基本的Android项目以及对Android程序框架的基本理解。以下是对这些内容的详细阐述: 首先,Android程序框架的核心组件是Activity,它是应用程序与用户交互的窗口...

    jackson-jar

    基于属性访问或注解的方式将json和POJO对象互相转换, 受JAXB基于注解的处理方式启发。通过org.codehaus.jackson.map.ObjectMapper读写json数据。它包含两种类型: 3.1 Simple Data Binding 用于json和Java Maps, ...

    hibernate官方入门教程 (转载)

    4. **持久化类和表的映射**: 使用XML文件(hibernate-mapping.xml)或Java注解(@Table, @Column等)定义实体类和数据库表之间的映射关系。 5. **Session接口**: Session是Hibernate的核心接口,负责与数据库进行...

    软件开发人成长经历(转载)

    "软件开发人成长经历(转载)"这个主题,旨在分享一位软件开发者从初学者到专业人士的蜕变过程,帮助那些渴望在这一行业中提升自己的人们找到方向。通过阅读《程序员感语.pdf》这样的资料,我们可以学习到许多关键的...

    SSM整合,参考尚硅谷视频,转载笔记,非原创,侵权删

    MyBatis允许开发者编写SQL语句,然后通过XML或注解方式将其绑定到Java接口方法上,实现了数据访问的灵活和高效。 **4. SSM整合步骤** - **引入依赖**:在项目中添加Spring、SpringMVC和MyBatis的依赖库。 - **配置...

    jdk常用命令

    在IT行业中,Java Development Kit(JDK)是Java编程的...通过阅读《JDK常用命令详解.doc》和《jdk-bin下的命令详解---转载,学习下.txt》,你可以更深入地学习每个命令的用法和具体示例,从而提升你的Java开发技能。

    Tomcat 7-9转载资源

    - **Servlet 3.0** 支持:Tomcat 7引入了Servlet 3.0规范,包括异步处理能力,预加载Servlet,以及改进的注解支持。 - **NIO连接器**:提供了非阻塞I/O,提升了高并发场景下的性能。 - **Jasper升级**:JSP编译器...

    jsr168 portlet(struts2+spring2.5+hibernate3.3)(转载)

    Spring 2.5版本引入了更多改进,如支持注解配置、更灵活的AOP、XML Schema-based配置等,增强了应用程序的可维护性和可测试性。 3. **Hibernate3.3**:Hibernate是一个对象关系映射(ORM)框架,它简化了数据库操作...

    dwr中文教程~转载的,共享一下

    2. **映射**:通过`@RemoteProxy`注解标记Java类或方法,使得它们可被JavaScript访问。 3. **JavaScript API**:DWR生成JavaScript接口,供前端使用,主要API有`DWR Engine`、`Call`、`Batch`等。 4. **通信**:...

Global site tag (gtag.js) - Google Analytics