首页 > 代码库 > java注解

java注解

2024-07-29 12:05:09   223人阅读

1、什么是java注解
    注解，顾名思义，注解,就是对某一事物进行添加注释说明，会存放一些信息，这些信息可能对以后某个时段来说是很有用处的。 java提供了一套注解机制，使得我们可以对方法、类、参数、包、域以及变量等添加标准(即附上某些信息)，且在以后某个时段通过反射将标注的信息提取出来以供使用。

2、JDK提供的基本注解 
a. @SuppressWarnings 该注解的作用是阻止编译器发出某些警告信息。它可以有以下参数:
    deprecation：过时的类或方法警告。
    unchecked：执行了未检查的转换时警告。
    fallthrough：当Switch程序块直接通往下一种情况而没有Break时的警告。
    path：在类路径、源文件路径等中有不存在的路径时的警告。
    serial：当在可序列化的类上缺少serialVersionUID定义时的警告。
    finally：任何finally子句不能完成时的警告。
    all：关于以上所有情况的警告。
b.@Deprecated 该注解的作用是标记某个过时的类或方法。
c. @Override 该注解用在方法前面，用来标识该方法是重写父类的某个方法。 

3、元注解 
a. @Retention 它是被定义在一个注解类的前面，用来说明该注解的生命周期。它有以下参数：
    RetentionPolicy.SOURCE：指定注解只保留在一个源文件当中。
    RetentionPolicy.CLASS：指定注解只保留在一个class文件中。
    RetentionPolicy.RUNTIME：指定注解可以保留在程序运行期间。
b. @Target 它是被定义在一个注解类的前面，用来说明该注解可以被声明在哪些元素前。它有以下参数：
    ElementType.TYPE：说明该注解只能被声明在一个类前。
    ElementType.FIELD：说明该注解只能被声明在一个类的字段前。
    ElementType.METHOD：说明该注解只能被声明在一个类的方法前。
    ElementType.PARAMETER：说明该注解只能被声明在一个方法参数。
    ElementType.CONSTRUCTOR：说明该注解只能声明在一个类的构造方法前。
    ElementType.LOCAL_VARIABLE：说明该注解只能声明在一个局部变量前。
    ElementType.ANNOTATION_TYPE：说明该注解只能声明在一个注解类型前。
    ElementType.PACKAGE：说明该注解只能声明在一个包名前。 

4、注解的生命周期
一个注解可以有三个生命周期，它默认的生命周期是保留在一个CLASS文件，但它也可以由一个@Retetion的元注解指定它的生命周期。
    a.java源文件 当在一个注解类前定义了一个@Retetion(RetentionPolicy.SOURCE)的注解，那么说明该注解只保留在一个源文件当中，当编译器将源文件编译成class文件时，它不会将源文件中定义的注解保留在class文件中。
    b. class文件中 当在一个注解类前定义了一个@Retetion(RetentionPolicy.CLASS)的注解，那么说明该注解只保留在一个class文件当中，当加载class文件到内存时，虚拟机会将注解去掉，从而在程序中不能访问。
    c. 程序运行期间 当在一个注解类前定义了一个@Retetion(RetentionPolicy.RUNTIME)的注解，那么说明该注解在程序运行期间都会存在内存当中。此时，我们可以通过反射来获得定义在某个类上的所有注解。 

5、注解的定义 

一个简单的注解：
 public @interface Annotation01{
        //定义公共的final静态属性.....
        //定以公共的抽象方法......
 }
  a.注解可以有哪些成员 注解和接口相似，它只能定义final静态属性和公共抽象方法。
  b.注解的方法  
      1.方法前默认会加上public abstract
      2.在声明方法时可以定义方法的默认返回值。 例如: Stringcolor()default"blue"; String[]color()default{"blue","red",......}
      3.方法的返回值可以有哪些类型 8种基本类型，String、Class、枚举、注解及这些类型的数组。
  c.使用注解（参照下面的注解使用）注解的使用分为三个过程。 定义注解-->声明注解-->得到注解
      a.定义注解（参照上面的注解定义）
      b.声明注解
          1.在哪些元素上声明注解 如果定义注解时没有指定@Target元注解来限制它的使用范围，那么该注解可以使用在ElementType枚举指定的任何一个元素前。否则，只能声明在@Target元注解指定的元素前。 一般形式： @注解名()
          2.对注解的方法的返回值进行赋值 对于注解中定义的每一个没有默认返回值的方法，在声明注解时必须对它的每一个方法的返回值进行赋值。 一般形式: @注解名(方法名=方法返回值，、、、、、、) 如果方法返回的是一个数组时，那么将方法返回值写在{}符号里 @注解名(方法名={返回值1，返回值2，、、、、、、}，、、、、、、、)
          3.对于只含有value方法的注解，在声明注解时可以只写返回值。
      c.得到注解 对于生命周期为运行期间的注解，都可以通过反射获得该元素上的注解实例。
          1、声明在一个类中的注解 可以通过该类Class对象的getAnnotation或getAnnotations方法获得。
          2、声明在一个字段中的注解 通过Field对象的getAnnotation或getAnnotations方法获得
          3、声明在一个方法中的注解 通过Method对象的getAnnotation或getAnnotations方法获得 

6、例子
下面讲的设计一个最简单的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. }  
[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. }  

   说明:所有的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. }  
[java] 
        package lighter.javaeye.com;  
  1.   
  2. import java.lang.annotation.Documented;  
  3. import java.lang.annotation.ElementType;  
  4. import java.lang.annotation.Retention;  
  5. import java.lang.annotation.RetentionPolicy;  
  6. import java.lang.annotation.Target;  
  7.   
  8.  //注意这里的@Target与@Description里的不同,参数成员也不同  
  9. @Target(ElementType.METHOD)  
  10. @Retention(RetentionPolicy.RUNTIME)  
  11. @Documented  
  12. public @interface Name {  
  13.     String originate();  
  14.     String community();  
  15. }  



   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. }  
[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. }  


   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. }  
[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. }  


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


java注解


联系
我们