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 @interface Target {
5. ElementType[] value();
6.}
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Target { ElementType[] value(); }
其中的@interface是一个关键字，在设计annotations的时候必须把一个类型定义为@interface，而不能用class或interface关键字(会不会觉得sun有点吝啬,偏偏搞得与interface这么像).
2、源文件Retention.java
Java代码
1.@Documented
2.@Retention(RetentionPolicy.RUNTIME)
3.@Target(ElementType.ANNOTATION_TYPE)
4.public @interface Retention {
5. RetentionPolicy value();
6.}
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Retention { RetentionPolicy value(); }
看到这里，大家可能都模糊了,都不知道在说什么，别急，往下看一下.
在上面的文件都用到了RetentionPolicy，ElementType这两个字段,你可能就会猜到这是两个java文件.的确，这两个文件的源代码如下：
3、源文件RetentionPolicy.java
Java代码
1.public enum RetentionPolicy {
2. SOURCE,
3. CLASS,
4. RUNTIME
5.}
public enum RetentionPolicy { SOURCE, CLASS, RUNTIME }
这是一个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.public enum ElementType {
2. TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
3. LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
4.}
public enum ElementType { TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, 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之上.
如果一个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.package lighter.javaeye.com;
2.
3.import java.lang.annotation.Documented;
4.import java.lang.annotation.ElementType;
5.import java.lang.annotation.Retention;
6.import java.lang.annotation.RetentionPolicy;
7.import java.lang.annotation.Target;
8.
9.@Target(ElementType.TYPE)
10.@Retention(RetentionPolicy.RUNTIME)
11.@Documented
12.public @interface Description {
13. String value();
14.}
package lighter.javaeye.com; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Description { String value(); }
说明:所有的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.package lighter.javaeye.com;
2.
3.import java.lang.annotation.Documented;
4.import java.lang.annotation.ElementType;
5.import java.lang.annotation.Retention;
6.import java.lang.annotation.RetentionPolicy;
7.import java.lang.annotation.Target;
8.
9. //注意这里的@Target与@Description里的不同,参数成员也不同
10.@Target(ElementType.METHOD)
11.@Retention(RetentionPolicy.RUNTIME)
12.@Documented
13.public @interface Name {
14. String originate();
15. String community();
16.}
package lighter.javaeye.com; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; //注意这里的@Target与@Description里的不同,参数成员也不同 @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Name { String originate(); String community(); }
3、JavaEyer.java
Java代码
1.package lighter.javaeye.com;
2.
3.@Description("javaeye,做最棒的软件开发交流社区")
4.public class JavaEyer {
5. @Name(originate="创始人:robbin",community="javaEye")
6. public String getName()
7. {
8. return null;
9. }
10.
11. @Name(originate="创始人:江南白衣",community="springside")
12. public String getName2()
13. {
14. return "借用两位的id一用,写这一个例子,请见谅!";
15. }
16.}
package lighter.javaeye.com; @Description("javaeye,做最棒的软件开发交流社区") public class JavaEyer { @Name(originate="创始人:robbin",community="javaEye") public String getName() { return null; } @Name(originate="创始人:江南白衣",community="springside") public String getName2() { return "借用两位的id一用,写这一个例子,请见谅!"; } }
4、最后，写一个可以运行提取JavaEyer信息的类TestAnnotation
Java代码
1. package lighter.javaeye.com;
2.
3. import java.lang.reflect.Method;
4. import java.util.HashSet;
5. import java.util.Set;
6.
7. public class TestAnnotation {
8. /**
9. * author lighter
10. * 说明:具体关天Annotation的API的用法请参见javaDoc文档
11. */
12. public static void main(String[] args) throws Exception {
13. String CLASS_NAME = "lighter.javaeye.com.JavaEyer";
14. Class test = Class.forName(CLASS_NAME);
15. Method[] method = test.getMethods();
16. boolean flag = test.isAnnotationPresent(Description.class);
17. if(flag)
18. {
19. Description des = (Description)test.getAnnotation(Description.class);
20. System.out.println("描述:"+des.value());
21. System.out.println("-----------------");
22. }
23.
24. //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去
25. Set<Method> set = new HashSet<Method>();
26. for(int i=0;i<method.length;i++)
27. {
28. boolean otherFlag = method[i].isAnnotationPresent(Name.class);
29. if(otherFlag) set.add(method[i]);
30. }
31. for(Method m: set)
32. {
33. Name name = m.getAnnotation(Name.class);
34. System.out.println(name.originate());
35. System.out.println("创建的社区:"+name.community());
36. }
37. }
38.}
package lighter.javaeye.com; import java.lang.reflect.Method; import java.util.HashSet; import java.util.Set; public class TestAnnotation { /** * author lighter * 说明:具体关天Annotation的API的用法请参见javaDoc文档 */ public static void main(String[] args) throws Exception { String CLASS_NAME = "lighter.javaeye.com.JavaEyer"; Class test = Class.forName(CLASS_NAME); Method[] method = test.getMethods(); boolean flag = test.isAnnotationPresent(Description.class); if(flag) { Description des = (Description)test.getAnnotation(Description.class); System.out.println("描述:"+des.value()); System.out.println("-----------------"); } //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去 Set<Method> set = new HashSet<Method>(); for(int i=0;i<method.length;i++) { boolean otherFlag = method[i].isAnnotationPresent(Name.class); if(otherFlag) set.add(method[i]); } for(Method m: set) { Name name = m.getAnnotation(Name.class); System.out.println(name.originate()); System.out.println("创建的社区:"+name.community()); } } }
5、运行结果：
描述:javaeye,做最棒的软件开发交流社区
-----------------
创始人:robbin
创建的社区:javaEye
创始人:江南白衣
创建的社区:springside
分享到：
相关推荐
java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解...
### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中，良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑，还能方便其他开发者理解代码意图，从而提高整个团队的工作效率。Eclipse作为一款...
Java注解是Java编程语言中的一个重要特性，它允许在代码中添加元数据，为编译器、解释器或任何其他工具提供额外的信息。在Java Web服务（WebService）开发中，注解的应用极大地简化了服务的创建和配置。本文将深入...
Java注解是Java编程语言中的一个重要特性，它们提供了一种元数据的方式，允许程序员在代码中插入信息，这些信息可以被编译器或运行时环境用于处理代码。注解不仅简化了开发，还增强了代码的可读性和维护性。本资料...
除了上述框架特定的注解，还有一些通用的Java注解，如@Override表明方法重写父类方法，@Deprecated标记已废弃的方法，@ SuppressWarnings抑制编译器警告。理解并熟练运用这些注解，能够提升代码质量，减少出错可能性...
Java注解是Java编程语言中的一个重要特性，它允许程序员在代码中嵌入元数据，这些元数据可以被编译器或运行时环境用来执行各种任务，例如代码分析、验证、生成代码、部署等。注解提供了更加灵活和可扩展的方式来处理...
Java注解是Java编程语言中的一个重要特性，它提供了一种元数据的方式，允许程序员在代码中插入额外的信息，这些信息可以被编译器或者运行时环境用来执行特定的任务。注解在现代Java开发中扮演了不可或缺的角色，尤其...
java注解和反射的个人学习笔记
本文将深入探讨Java注释的类型、用途，以及如何创建和使用注释模板，以帮助您和您的团队提升代码质量。 1. **Java注释类型**： - **单行注释**：以`//`开头，常用于快速添加临时性的注释或简单的解释。 - **多行...
Java注解是自JDK1.5版本引入的一种元数据机制，它允许程序员在源代码的各个层次（类、方法、变量等）嵌入信息，这些信息可以被编译器或者运行时系统用来进行各种处理。注解简化了配置文件的使用，提高了代码的可读性...
Java注解是Java编程语言中的一个重要特性，它允许程序员在代码中嵌入元数据（metadata），这些元数据不直接影响程序的执行，但可以被编译器或运行时环境用来进行各种处理，如验证、动态代理、持久化、资源管理等。...
本篇文章将深入探讨Java注解的使用及其在实际开发中的应用。 首先，我们了解Java注解的基本结构。一个注解以`@`符号开头，后面跟着注解类型，如`@Override`或`@Deprecated`。注解可以带有参数，参数以键值对的形式...
完整注释可以包含多个参数，但 Java 内置的注解通常只使用上述两种形式。 元数据的作用主要体现在三个方面： - **编写文档**： 通过如 Javadoc 一样的工具，可以从注解中提取信息来生成代码的文档，提高代码的...
Java注解（Annotation）是Java语言的一个重要特性，它为元数据提供了强大的支持。元数据是一种描述数据的数据，它提供了一种安全的方式，使我们可以在不改变程序代码本身的情况下，向编译器或运行时环境提供额外的...
Java注解（Annotation）是Java语言的一个重要特性，它为元数据提供了一种结构化的方式。元数据是在程序代码中包含的关于程序本身的信息，但这些信息并不直接影响程序的执行。注解允许开发者向编译器、JVM或工具提供...
Java注解、反射、字节码和类加载机制是Java编程中的核心概念，它们在实际开发中扮演着重要角色。让我们深入探讨这些知识点。 **Java注解(Annotation)**: Java注解是一种元数据，它提供了在编译时或运行时处理代码的...
超级好用的 java 注释模板，吐血总结，整理。吐血总结，整理。
在本教程中，我们将深入探讨如何使用Spring 4框架，特别是其基于Java注解的配置方式，来构建一个高效、可维护的系统。Spring 4是Java企业级应用开发的首选框架，它提供了广泛的功能，包括依赖注入、AOP（面向切面...
Eclipse作为一款强大的Java集成开发环境（IDE），提供了许多便捷的功能，其中之一就是“Eclipse Java 注释模板”。通过配置和使用这些模板，程序员可以快速地为代码添加注释，提高代码的可读性和维护性。下面我们将...