`
picluo
  • 浏览: 340504 次
  • 性别: Icon_minigender_1
  • 来自: 大力亚
社区版块
存档分类
最新评论

springside中的注解:设计自己的Annotation

阅读更多

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

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

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

Java代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20%20%20%40Documented%0A%20%20%20%40Retention(RetentionPolicy.RUNTIME)%0A%20%20%20%40Target(ElementType.ANNOTATION_TYPE)%0A%20%20%20public%20%40interface%20Target%20%7B%0A%20%20%20%20%20%20ElementType%5B%5D%20value()%3B%0A%20%20%20%7D"></embed>
  1. @Documented  
  2. @Retention(RetentionPolicy.RUNTIME)  
  3. @Target(ElementType.ANNOTATION_TYPE)  
  4. public @interface Target {  
  5.    ElementType[] value();  
  6. }  


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

Java代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20%20%20%40Documented%0A%20%20%20%40Retention(RetentionPolicy.RUNTIME)%0A%20%20%20%40Target(ElementType.ANNOTATION_TYPE)%0A%20%20%20public%20%40interface%20Retention%20%7B%0A%20%20%20%20%20%20RetentionPolicy%20value()%3B%0A%20%20%20%7D"></embed>
  1. @Documented  
  2. @Retention(RetentionPolicy.RUNTIME)  
  3. @Target(ElementType.ANNOTATION_TYPE)  
  4. public @interface Retention {  
  5.    RetentionPolicy value();  
  6. }  



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

Java代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20%20%20%20public%20enum%20RetentionPolicy%20%7B%0A%20%20%20%20%20SOURCE%2C%0A%20%20%20%20%20CLASS%2C%0A%20%20%20%20%20RUNTIME%0A%20%20%20%20%7D"></embed>
  1. public enum RetentionPolicy {  
  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代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20%20%20public%20enum%20ElementType%20%7B%0A%20%20%20%20TYPE%2C%20FIELD%2C%20METHOD%2C%20PARAMETER%2C%20CONSTRUCTOR%2C%0A%20%20%20%20LOCAL_VARIABLE%2C%20ANNOTATION_TYPE%2CPACKAGE%0A%20%20%20%7D"></embed>
  1. public enum ElementType {  
  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代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20%20%20package%20lighter.iteye.com%3B%0A%0A%20%20%20import%20java.lang.annotation.Documented%3B%0A%20%20%20import%20java.lang.annotation.ElementType%3B%0A%20%20%20import%20java.lang.annotation.Retention%3B%0A%20%20%20import%20java.lang.annotation.RetentionPolicy%3B%0A%20%20%20import%20java.lang.annotation.Target%3B%0A%0A%20%20%20%40Target(ElementType.TYPE)%0A%20%20%20%40Retention(RetentionPolicy.RUNTIME)%0A%20%20%20%40Documented%0A%20%20%20public%20%40interface%20Description%20%7B%0A%20%20%20%20%20%20%20String%20value()%3B%0A%20%20%20%7D"></embed>
  1. package lighter.iteye.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. }  


   
   说明:所有的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代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20%20%20package%20lighter.iteye.com%3B%0A%0A%20%20%20import%20java.lang.annotation.Documented%3B%0A%20%20%20import%20java.lang.annotation.ElementType%3B%0A%20%20%20import%20java.lang.annotation.Retention%3B%0A%20%20%20import%20java.lang.annotation.RetentionPolicy%3B%0A%20%20%20import%20java.lang.annotation.Target%3B%0A%0A%20%20%20%20%2F%2F%E6%B3%A8%E6%84%8F%E8%BF%99%E9%87%8C%E7%9A%84%40Target%E4%B8%8E%40Description%E9%87%8C%E7%9A%84%E4%B8%8D%E5%90%8C%2C%E5%8F%82%E6%95%B0%E6%88%90%E5%91%98%E4%B9%9F%E4%B8%8D%E5%90%8C%0A%20%20%20%40Target(ElementType.METHOD)%0A%20%20%20%40Retention(RetentionPolicy.RUNTIME)%0A%20%20%20%40Documented%0A%20%20%20public%20%40interface%20Name%20%7B%0A%20%20%20%20%20%20%20String%20originate()%3B%0A%20%20%20%20%20%20%20String%20community()%3B%0A%20%20%20%7D"></embed>
  1. package lighter.iteye.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. }  



   3、JavaEyer.java 

Java代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=package%20lighter.iteye.com%3B%0A%0A%40Description(%22javaeye%2C%E5%81%9A%E6%9C%80%E6%A3%92%E7%9A%84%E8%BD%AF%E4%BB%B6%E5%BC%80%E5%8F%91%E4%BA%A4%E6%B5%81%E7%A4%BE%E5%8C%BA%22)%0Apublic%20class%20JavaEyer%20%7B%0A%09%40Name(originate%3D%22%E5%88%9B%E5%A7%8B%E4%BA%BA%3Arobbin%22%2Ccommunity%3D%22javaEye%22)%0A%09public%20String%20getName()%0A%09%7B%0A%09%09return%20null%3B%0A%09%7D%0A%09%0A%09%40Name(originate%3D%22%E5%88%9B%E5%A7%8B%E4%BA%BA%3A%E6%B1%9F%E5%8D%97%E7%99%BD%E8%A1%A3%22%2Ccommunity%3D%22springside%22)%0A%09public%20String%20getName2()%0A%09%7B%0A%09%09return%20%22%E5%80%9F%E7%94%A8%E4%B8%A4%E4%BD%8D%E7%9A%84id%E4%B8%80%E7%94%A8%2C%E5%86%99%E8%BF%99%E4%B8%80%E4%B8%AA%E4%BE%8B%E5%AD%90%2C%E8%AF%B7%E8%A7%81%E8%B0%85!%22%3B%0A%09%7D%0A%7D"></embed>
  1. package lighter.iteye.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. }  


   4、最后,写一个可以运行提取JavaEyer信息的类TestAnnotation 

Java代码 <embed type="application/x-shockwave-flash" width="14" height="15" src="http://www.iteye.com/javascripts/syntaxhighlighter/clipboard_new.swf" pluginspage="http://www.macromedia.com/go/getflashplayer" allowscriptaccess="always" quality="high" flashvars="clipboard=%20package%20lighter.iteye.com%3B%0A%0A%20%20import%20java.lang.reflect.Method%3B%0A%20%20import%20java.util.HashSet%3B%0A%20%20import%20java.util.Set%3B%0A%0A%20%20public%20class%20TestAnnotation%20%7B%0A%09%2F**%0A%09%20*%20author%20lighter%0A%09%20*%20%E8%AF%B4%E6%98%8E%3A%E5%85%B7%E4%BD%93%E5%85%B3%E5%A4%A9Annotation%E7%9A%84API%E7%9A%84%E7%94%A8%E6%B3%95%E8%AF%B7%E5%8F%82%E8%A7%81javaDoc%E6%96%87%E6%A1%A3%0A%09%20*%2F%0A%20%20%20%20%20%20%20public%20static%20void%20main(String%5B%5D%20args)%20throws%20Exception%20%7B%0A%20%20%20%20%20%20%20String%20%20CLASS_NAME%20%3D%20%22lighter.iteye.com.JavaEyer%22%3B%0A%20%20%20%20%20%20%20Class%20%20test%20%3D%20Class.forName(CLASS_NAME)%3B%0A%20%20%20%20%20%20%20Method%5B%5D%20method%20%3D%20test.getMethods()%3B%0A%20%20%20%20%20%20%20boolean%20flag%20%3D%20test.isAnnotationPresent(Description.class)%3B%0A%20%20%20%20%20%20%20%20if(flag)%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%09Description%20des%20%3D%20(Description)test.getAnnotation(Description.class)%3B%0A%20%20%20%20%20%20%20%20%09System.out.println(%22%E6%8F%8F%E8%BF%B0%3A%22%2Bdes.value())%3B%0A%20%20%20%20%20%20%20%20%09System.out.println(%22-----------------%22)%3B%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%2F%2F%E6%8A%8AJavaEyer%E8%BF%99%E4%B8%80%E7%B1%BB%E6%9C%89%E5%88%A9%E7%94%A8%E5%88%B0%40Name%E7%9A%84%E5%85%A8%E9%83%A8%E6%96%B9%E6%B3%95%E4%BF%9D%E5%AD%98%E5%88%B0Set%E4%B8%AD%E5%8E%BB%0A%20%20%20%20%20%20%20%20Set%3CMethod%3E%20set%20%3D%20new%20HashSet%3CMethod%3E()%3B%0A%20%20%20%20%20%20%20%20for(int%20i%3D0%3Bi%3Cmethod.length%3Bi%2B%2B)%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%09boolean%20otherFlag%20%3D%20method%5Bi%5D.isAnnotationPresent(Name.class)%3B%0A%20%20%20%20%20%20%20%20%09if(otherFlag)%20set.add(method%5Bi%5D)%3B%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20for(Method%20m%3A%20set)%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%09Name%20name%20%3D%20m.getAnnotation(Name.class)%3B%0A%20%20%20%20%20%20%20%20%09System.out.println(name.originate())%3B%0A%20%20%20%20%20%20%20%20%09System.out.println(%22%E5%88%9B%E5%BB%BA%E7%9A%84%E7%A4%BE%E5%8C%BA%3A%22%2Bname.community())%3B%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%7D%0A%7D"></embed>
  1.  package lighter.iteye.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.iteye.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. colo
    2
    1
    分享到:
    评论

相关推荐

    springside-core-4.2.2.GA(含关联的test.jar)

    pom.xml配置 ...mvn install:install-file -DgroupId=org.springside -DartifactId=springside-core -Dversion=4.2.2.GA -Dfile=./springside-core-4.2.2.GA.jar -Dpackaging=jar -DgeneratePom=true

    springside4.3.0的jar包

    我找了很久,都是那种hubgit上的那种,一直没明白怎么用,终于后来会了,不明白为什么不直接提供jar包,还要自己生成。这个是已生成成功的。仅支持Oracle, H2, MySql, PostgreSql, SQLServer。包括core和utils,以及...

    springside-core-4.1.0.GA.jar

    1. **模块化设计**:Springside采用了模块化的设计,允许开发者根据需求选择加载特定模块,如Core、Hibernate、Guava等,这样可以降低项目的依赖性,提高代码的可维护性和性能。 2. **代码生成器**:内置的代码生成...

    springside-core-4.3.0.jar

    springside-core-4.3.0.jar 最新版springside-core的jar包

    Springside-core-4.1.0/Springside-core-4.1.0

    SpringSide是Java开发中的一款轻量级框架,它基于Spring框架,旨在简化企业级应用的开发流程。本文将深入探讨SpringSide-core-4.1.0的核心特性,以及其在实际项目中的应用。 一、SpringSide概述 SpringSide是一款...

    springside-4.0.0.GA.zip

    通过深入研究SpringSide 4.0.0.GA,开发者可以学习到如何有效地整合Spring Framework和其他相关技术,提升自己的JavaEE开发技能。无论是对于新手还是资深开发者,SpringSide都是一个不可多得的学习和参考资料库,它...

    springside-core-4.2.2.GA相关jar包

    学习和使用SpringSide Core 4.2.2.GA,开发者可以深入理解Spring框架的精髓,掌握Spring MVC的Web开发技巧,并通过实践提升自己的Java开发能力。同时,了解和遵循项目中的最佳实践,有助于养成良好的编程习惯,提升...

    有springside4.2.3-GA.jar 包

    本文将围绕springside4.2.3-GA.jar这个核心组件,探讨其在Java应用中的重要作用以及如何利用它提升开发效率。 首先,我们需要理解什么是.jar文件。.jar(Java Archive)是Java平台上的归档文件格式,用于集合多个类...

    springside-core-4.2.2.GA.pom

    springside-core-4.2.2.GA.pom springside-core-4.2.2.GA.pomspringside-core-4.2.2.GA.pomspringside-core-4.2.2.GA.pomspringside-core-4.2.2.GA.pom

    springside.jar

    《springside.jar在Java应用中的使用详解》 在Java开发领域,springside.jar是一个备受推崇的开源项目,它为开发者提供了丰富的工具和最佳实践,以简化Spring框架的使用。本文将深入探讨springside.jar的核心功能,...

    springside3-core-3.0.4 源码

    8. **设计模式**:在springside3-core-3.0.4的源码中,我们可以找到许多设计模式的应用,如工厂模式、单例模式、代理模式等,这些都是提升代码可读性和可维护性的重要手段。 9. **代码规范**:源码遵循了一套统一的...

    SpringSide 项目源码

    SpringSide 中的控制器类(Controller)遵循 Spring MVC 设计模式,通过注解(如 `@RequestMapping`)来定义请求映射,实现业务逻辑与视图的分离。 ### 六、Spring Data JPA Spring Data JPA 提供了对 JPA 的简化...

    springside4-4.0.1.GA

    springside4官方最新版 SpringSide是以Spring Framework为核心的,Pragmatic风格的JavaEE应用参考示例,是JavaEE世界中的主流技术选型,最佳实践的总结与演示。

    springside

    《SpringSide:全面解析与应用》 SpringSide项目是一个基于Java的开源软件开发框架,它以Spring Framework为核心,旨在提供一套简洁、规范的项目构建和开发实践。在深入理解SpringSide之前,我们首先需要了解Spring...

    springside-core-4.2.2.GA-tests.jar

    springside-core-4.2.2.GA-tests.jar

    SpringSide3-core-3.3.4

    1. **模块化设计**:SpringSide3-core的核心模块采用了模块化的结构,包括了Spring MVC、Hibernate、Quartz等常见框架的集成,使得开发者可以按需选择,避免了过度依赖,提升了项目的可维护性和灵活性。 2. **配置...

    springside-core-4.0.0.RC3.jar (找老久)

    springside-core-4.0.0.RC3.jar (找老久)

    springside-core-4.2.2.GA.jar

    springside-core-4.2.2.GA.jar 亲测可用

    springside-core-4.2.3-GA.jar

    springside-core-4.2.3-GA.jar,如果jar包不完整,可能会导致异常:LifecycleProcessor not initialized - call 'refresh' before invoking lifecycle methods via the context

    springside的一个应用实例

    在实际应用中,SpringSide的Web API设计通常遵循以下步骤: 1. **定义资源(Resources)**:确定API将暴露哪些资源,比如用户、文章等,每个资源对应一个URL路径。 2. **设计操作(Operations)**:为每个资源定义...

Global site tag (gtag.js) - Google Analytics