详解Java编程中Annotation注解对象的使用方法_java

注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。
 
1.基本语法
Java SE5内置三种标准注解
@Override:表示当前的方法定义将覆盖超类中的方法.如果你不小心拼写错误,或者方法签名对不上被覆
盖的方法,编译器就会发出错误提示
@Deprecated:如果程序员使用了注解为它的元素,那么编译器就会发出警告信息
@SupperessWarnings:关闭不当的编译器警告信息.
Java SE5内置四种元注解
@Target:表示该注解可以用于什么地方.可能的ElementType参数包括:
1)CONSTRUCTOR:构造器的声明
2)FIELD:域声明(包括enum实例)
3)LOCAL_VARIABLE:局部变量声明
4)METHOD:方法声明
5)PACKAGE:包声明
6)PARAMETER:参数声明
7)TYPE:类、接口(包括注解类型)或enum声明
@Retention:表示需要在什么级别保存该注解信息.可选的RetentionPolicy参数包括:
1)SOURCE:注解将被编译器丢弃
2)CLASS:注解在class文件中可用,但会被VM丢弃
3)RUNTIME:VM将在运行期也保留注解,因此可以通过反射机制读取注解的信息
@Documented:将此注解包含在Javadoc中
@Inherited:允许子类继承父类中的注解
大多数时候,程序员主要是定义自己的注解，并编写自己的处理器来处理它们.
UseCase.java   

package com;  

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;  

@Target(ElementType.METHOD)//用来定义你的注解将应用在什么地方,本处应用为方法
//用来定义该注解在哪一个级别可用,在源代码中(source)类文件中(class)或者运行时(runtime)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
 public int id();
 public String description()default "no description";
}  

 PasswordUtils .java
package com;  

public class PasswordUtils {
 @UseCase(id=47,description="Passwords must contain at least one numeric")
 public boolean validatePassword(){
 return true;
 }  

 @UseCase(id=48)
 public String encryptPassword(String password){
 return password;
 }  

 @UseCase(id=49,description="Jong_Cai")
 public void showName(){
 System.out.println("Jong_Cai");
 }
}

 
2.编写注解处理器
 如果没有用来读取注解的工具,那注解也不会比注释更有用.使用注解的过程中.很重要的一个部
分就是创建与使用注解处理器.Java SE5扩展了反射机制的API,以帮助程序员构造这类工具.同时,它还提供了一个外部工具apt帮助程序员解析带有注解的Java源代码.下面是一个非常简单的注解处理器,我们将用它来读取PasswordUtils类,并使用反射机制查找@UseCase标记.我们为其提供了一组id值得,然后它会列出在PasswordUtils中找到的用例,以及缺失的用例.

 UseCaseTracker.java
package com;  

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;  

public class UseCaseTracker {
 public static void trackUseCases(List<Integer> list, Class<?> cl) {
 for (Method m : cl.getDeclaredMethods()) {
  UseCase us = m.getAnnotation(UseCase.class);
  if (us != null) {
  System.out.println("Found Use Case:" + us.id() + " "
   + us.description());
  list.remove(new Integer(us.id()));
  }
 }
 for (int i : list) {
  System.out.println("Warning:Missing use case-" + i);
 }
 }  

 public static void main(String[] args) {
 List<Integer> list = new ArrayList<Integer>();
 Collections.addAll(list, 47,48,49,50,51);
 trackUseCases(list, PasswordUtils.class);
 }
}

 
这个程序用到了两个反射的方法:getDeclaredMethods()和getAnnotation(),它们都属于AnnotatedElement接口(class,Method与Field等类都实现了该接口).getAnnotation()方法返回指定类型的注解对象,在这里就是UseCase,如果被注解的方法上没有该类型的注解,则返回null值.然后我们通过调用id()和description()方法从返回的UseCase对象中提取元素的值.其中encryptPassword()方法在注解的时候没有指定description的值,因此处理器在处理它对应的注解时,通过description()方法取得的是默认值no description.

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

3.实例
下面讲一下annotation的概念先，再来讲一下怎样设计自己的annotation.
首先在jdk自带的java.lang.annotation包里,打开如下几个源文件:
  
源文件Target.java

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
  ElementType[] value();  

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
  ElementType[] value();
}

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

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
  RetentionPolicy value();
} 

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
  RetentionPolicy value();
}

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

public enum RetentionPolicy {
 SOURCE,
 CLASS,
 RUNTIME
} 

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.

源文件ElementType.java

public enum ElementType {
 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
 LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
} 

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文档
  
   源文件它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话，使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.
   另外一点，如果需要把Annotation的数据继承给子类，那么就会用到@Inherited这一个Annotation类型. 
   
下面讲的设计一个最简单的Annotation例子,这一例子共用四个文件; 
Description.java

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();
} 

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",后加小括号.例:上面的例子就只有一个参数成员.

Name.java

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();
} 

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();
}

JavaEyer.java

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一用,写这一个例子,请见谅!";
  }
} 

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一用,写这一个例子,请见谅!";
  }
}

写一个可以运行提取JavaEyer信息的类TestAnnotation

 

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());
    }
   }
} 

 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());
    }
   }
}

运行结果：

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

以上是小编为您精心准备的的内容，在的博客、问答、公众号、人物、课程等栏目也有的相关内容，欢迎继续使用右上角搜索按钮进行搜索java
， annotation
注解
annotation 注解、annotation注解aip、spring注解annotation、annotation注解方式、annotation注解例子，以便于您获取更多的相关知识。

时间： 2024-10-03 14:01:31

详解Java编程中Annotation注解对象的使用方法_java的相关文章

详解Java编程中的反射在Android开发中的应用_Android

反射定义 "反射"(Reflection)能够让运行于JVM中的程序检测和修改运行时的行为.为何需要反射 反射带来的好处包括:     在运行时检测对象的类型.     动态构造某个类的对象.     检测类的属性和方法.     任意调用对象的方法.     修改构造函数.方法.属性的可见性. 反射方法Method getDeclaredMethod方法 声明如下: public Method getDeclaredMethod(String name, Class<?>

详解Java编程中包package的内容与包对象的规范_java

包的内容包的内容应该仔细设计,使其只包含在功能上相关的类和接口.包中的类可以自由地访问该包中其他类的非私有成员,有些类甚至可能有足够的权限去访问其他类的内部细节,为了避免这样的类对类成员进行误操作,我们需要对类成员进行保护.任何没有被声明为private的成员都可以被同一个包中的其他所有类型访问,所以任何不相关的类之间的藕合程度都可能会比我们所期望的程度高. 包还为寻找有用的接口和类的程序员提供了逻辑分组的功能.由不相关的类组成的包使程序员很难分辨出哪些接口和类是有用的,而类的逻辑分组可以帮助程

详解Java编程中对象的序列化_java

1. 什么是Java对象序列化 Java平台允许我们在内存中创建可复用的Java对象,但一般情况下,只有当JVM处于运行时,这些对象才可能存在,即,这些对象的生命周期不会比JVM的生命周期更长.但在现实应用中,就可能要求在JVM停止运行之后能够保存(持久化)指定的对象,并在将来重新读取被保存的对象.Java对象序列化就能够帮助我们实现该功能. 使用Java对象序列化,在保存对象时,会把其状态保存为一组字节,在未来,再将这些字节组装成对象.必须注意地是,对象序列化保存的是对象的"状态",

详解Java编程中线程同步以及定时启动线程的方法_java

使用wait()与notify()实现线程间协作 1. wait()与notify()/notifyAll()调用sleep()和yield()的时候锁并没有被释放,而调用wait()将释放锁.这样另一个任务(线程)可以获得当前对象的锁,从而进入它的synchronized方法中.可以通过notify()/notifyAll(),或者时间到期,从wait()中恢复执行. 只能在同步控制方法或同步块中调用wait().notify()和notifyAll().如果在非同步的方法里调用这些方法,在运

详解Java编程中的策略模式_java

策略模式属于对象的行为模式.其用意是针对一组算法,将每一个算法封装到具有共同接口的独立的类中,从而使得它们可以相互替换.策略模式使得算法可以在不影响到客户端的情况下发生变化. 策略模式的结构 策略模式是对算法的包装,是把使用算法的责任和算法本身分割开来,委派给不同的对象管理.策略模式通常把一个系列的算法包装到一系列的策略类里面,作为一个抽象策略类的子类.用一句话来说,就是:"准备一组算法,并将每一个算法封装起来,使得它们可以互换".下面就以一个示意性的实现讲解策略模式实例的结构. 这个

详解Java编程中对线程的中断处理_java

1. 引言 当我们点击某个杀毒软件的取消按钮来停止查杀病毒时,当我们在控制台敲入quit命令以结束某个后台服务时--都需要通过一个线程去取消另一个线程正在执行的任务.Java没有提供一种安全直接的方法来停止某个线程,但是Java提供了中断机制. 如果对Java中断没有一个全面的了解,可能会误以为被中断的线程将立马退出运行,但事实并非如此.中断机制是如何工作的?捕获或检测到中断后,是抛出InterruptedException还是重设中断状态以及在方法中吞掉中断状态会有什么后果?Thread.st

详解Java编程中向量(Vector)的应用_java

Vector(向量)是 java.util 包中的一个类,该类实现了类似动态数组的功能. 向量和数组相似,都可以保存一组数据(数据列表).但是数组的大小是固定的,一旦指定,就不能改变,而向量却提供了一种类似于"动态数组"的功能,向量与数组的重要区别之一就是向量的容量是可变的. 可以在向量的任意位置插入不同类型的对象,无需考虑对象的类型,也无需考虑向量的容量. 向量和数组分别适用于不同的场合,一般来说,下列场合更适合于使用向量: 如果需要频繁进行对象的插入和删除工作,或者因为需要处理的对

详解Java编程中线程的挂起、恢复和终止的方法_java

有时,线程的挂起是很有用的.例如,一个独立的线程可以用来显示当日的时间.如果用户不希望用时钟,线程被挂起.在任何情形下,挂起线程是很简单的,一旦挂起,重新启动线程也是一件简单的事. 挂起,终止和恢复线程机制在Java 2和早期版本中有所不同.尽管你运用Java 2的途径编写代码,你仍需了解这些操作在早期Java环境下是如何完成的.例如,你也许需要更新或维护老的代码.你也需要了解为什么Java 2会有这样的变化.因为这些原因,下面内容描述了执行线程控制的原始方法,接着是Java 2的方法. Jav

详解Java编程中面向字符的输出流_java

面向字符的输出流都是类 Writer 的子类,其类层次结构如图所示. 下表列出了 Writer 的主要子类及说明. 使用 FileWriter 类写入文件 FileWriter 类是 Writer 子类 OutputStreamWriter 类的子类,因此 FileWriter 类既可以使用 Writer类的方法也可以使用 OutputStreamWriter 类的方法来创建对象. 在使用 FileWriter 类写入文件时,必须先调用 FileWriter()构造方法创建 FileWriter