JAVA注解示例详解

本文转载自：http://hi.baidu.com/wjx_5893/item/dcaaeaf4ccb1982d753c4cf5

注解（Annotation） 为我们在代码中天界信息提供了一种形式化的方法，是我们可以在稍后某个时刻方便地使用这些数据（通过 解析注解 来使用这些数据）。

注解的语法比较简单，除了@符号的使用以外，它基本上与java的固有语法一致，java内置了三种注解，定义在java.lang包中。

@Override 表示当前方法是覆盖父类的方法。

@Deprecated 表示当前元素是不赞成使用的。

@SuppressWarnings 表示关闭一些不当的编译器警告信息。

下面是一个定义注解的实例

package Test_annotation;   

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

/* 
* 元注解@Target,@Retention,@Documented,@Inherited 
*   
*     @Target 表示该注解用于什么地方，可能的 ElemenetType 参数包括： 
*         ElemenetType.CONSTRUCTOR 构造器声明 
*         ElemenetType.FIELD 域声明（包括 enum 实例） 
*         ElemenetType.LOCAL_VARIABLE 局部变量声明 
*         ElemenetType.METHOD 方法声明 
*         ElemenetType.PACKAGE 包声明 
*         ElemenetType.PARAMETER 参数声明 
*         ElemenetType.TYPE 类，接口（包括注解类型）或enum声明 
*           
*     @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括： 
*         RetentionPolicy.SOURCE 注解将被编译器丢弃 
*         RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃 
*         RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。 
*           
*     @Documented 将此注解包含在 javadoc 中 
*       
*     @Inherited 允许子类继承父类中的注解 
*     
*/ 
@Target(ElementType.METHOD)   
@Retention(RetentionPolicy.RUNTIME)   
@Documented 
@Inherited 
/* 
* 定义注解 Test 
* 注解中含有两个元素 id 和 description 
* description 元素 有默认值 "no description" 
*/ 
public @interface Test {   
    public int id();   
    public String description() default "no description";   
}

下面是一个使用注解 和 解析注解的实例

package Test_annotation;   

import java.lang.reflect.Method;   

public class Test_1 {   
    /* 
     * 被注解的三个方法 
     */ 
    @Test(id = 1, description = "hello method_1")   
    public void method_1() {   
    }   

    @Test(id = 2)   
    public void method_2() {   
    }   

    @Test(id = 3, description = "last method")   
    public void method_3() {   
    }   

    /* 
     * 解析注解，将Test_1类 所有被注解方法 的信息打印出来 
     */ 
    public static void main(String[] args) {   
        Method[] methods = Test_1.class.getDeclaredMethods();   
        for (Method method : methods) {   
            /* 
             * 判断方法中是否有指定注解类型的注解 
             */ 
            boolean hasAnnotation = method.isAnnotationPresent(Test.class);   
            if (hasAnnotation) {   
                /* 
                 * 根据注解类型返回方法的指定类型注解 
                 */ 
                Test annotation = method.getAnnotation(Test.class);   
                System.out.println("Test( method = " + method.getName()   
                        + " , id = " + annotation.id() + " , description = " 
                        + annotation.description() + " )");   
            }   
        }   
    }   

}

输出结果如下：

Test( method = method_1 , id = 1 , description = hello method_1 ) 
Test( method = method_2 , id = 2 , description = no description ) 
Test( method = method_3 , id = 3 , description = last method )

注解的入级入门

　　注解为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。它是对来自像C#之类的其他语言对Java造成的语言特性压力所做出的一种回应。

一、Java内置基本注解

　　在Java中内置几种了基本的注解，下面列出几种常用的注解：

　　1、@Deprecated：用该注解注释的程序元素，表明不鼓励程序员使用这样的元素，通常是它很危险或存在更好的选择。

　　2、@Override：表明当前的方法定义将覆盖超类中的方法。

　　3、@SuppressWarnings：表明关闭不当的编译器警告信息。

　　4、@Documented：表明某一类型的注释将通过javadoc和类似的默认工具进行文档化。

　　5、@Inherited：允许子类继承父类中的注解。

　　6、@Retention：表明需要在什么级别保存该注解信息。

　　7、@Target：表明该注解可以用于什么地方。

　　8、@Generated：该注解用于标记已生成的源代码，它可以用于区分单个文件中用户编写的代码和生成的代码。

　　9、@PostConstruct：该注解用于在依赖关系注入完成之后需要执行的方法上，以执行任何初始化。

　　10、@PreDestroy：该注解作为回调通知用于各方法，以表示该实例正处于被容器移除的过程中。

　　11、@Resource：该注解用于标记应用程序所需要的资源。

二、定义注解

　　注解的定义看起来很像接口的定义，具体代码如下：

Java代码

1. import java.lang.annotation.*;   
2.   
3. @Target(ElementType.METHOD)   
4. @Retention(RetentionPolicy.RUTIME)   
5. public @interface Test {}  

import java.lang.annotation.*;@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUTIME)public @interface Test {}

　　除了@符号之外，@Test的定义很像一个空的接口，定义一个注解的时候，要用到一些元注解（Java内置的注解），如上面例子中的定义，@Target表明新定义的注解将用于方法定义上，@Retention表明新定义的注解将在运行时起作用。在注解中，一般都会包含一些元素以表示某些值，而没有元素的注解称为标记注解，如上面的@Test注解，下面定义一个新的注解，将包含一些元素，如：

Java代码

1. import java.lang.annotation.*;   
2.   
3. @Target(ElementType.METHOD)   
4. @Retention(RetentionPolicy.RUNTIME)   
5. public @interface UseCase   
6. {   
7. 　　public int id();   
8. 　　public String description() default "no description";   
9. }  

import java.lang.annotation.*;@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface UseCase{　　public int id();　　public String description() default "no description";}

　　该注解中定义了两个元素id和description，其中description元素通过default指定了默认值。

三、注解处理器

　　如果没有用来读取注解的工具，那注解也不会比注释更有用，使用注解的过程中，很重要的一部分就是创建与使用注解处理器，而注解处理器的编写需要更加实际应用来灵活应用。

四、注意地方

　　1、注解元素可以用的类型只有：所有基本类型(int,float,boolean)、String、Class、enum、Annotation、以上类型的数组。

　　2、在定义元素的默认值时有限制，首先，元素不能有不确定的值，也就是说，元素必须要么具有默认值，要么在使用注解时提供元素的值；其次，对于非基本类型的元素，不能以null作为其值。

　　3、注解不支持继承。

本文转载自：http://hi.baidu.com/wjx_5893/item/dcaaeaf4ccb1982d753c4cf5