Java 注解小结

 

在jdk1.5引进了注解的，有许多框架都使用了注解，例如spring，mybatis。

 

 

一、JDK内置系统注解：
@Override 用于修饰此方法覆盖了父类的方法;
@Deprecated 用于修饰已经过时的方法;
@Suppvisewarnings 用于通知java编译器禁止特定的编译警告。
 
注解按照运行机制划分
源码注解：注解只在源码中存在，编译成.class文件就不存在了；
编译时注解：注解在源码和.class文件中都存在；
运行时注解：在运行阶段还起作用，甚至会影响运行逻辑的注解； 

二、元注解：

 

 

注解的注解，即java为注解开发特准备的注解，即他们只能在我们自定义注解的时候使用。 

在java中有四种元注解

1.@Target

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

•  

表示该注解用于什么地方

public enum ElementType {
    /** 类，接口（包括注解类型）或enum声明  */
    TYPE,

    /** 域声明（包括 enum 实例） */
    FIELD,

    /** 方法声明 */
    METHOD,

    /** 参数声明 */
    PARAMETER,

    /** 构造器声明 */
    CONSTRUCTOR,

    /** 局部变量声明  */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /**  包声明  */
    PACKAGE,

    /**
     * 类型参数声明
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * 类型的使用
     *
     * @since 1.8
     */
    TYPE_USE
}

•  

2.@Retention

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

    RetentionPolicy value();
}

•  

表示该注解可以保存的范围

public enum RetentionPolicy {
    /**
     * 源代码：即此注解只能保存在源代码中
     * 当编译时，会被丢弃
     */
    SOURCE,

   /**
     * class文件：即此注解可以在class文件中保留
     * 但会被jvm丢弃
     */
    CLASS,

   /**
     * 运行期：即此注解可以在运行时保留
     * 可以通过反、反射获得编译器不仅把注解保存在class文件中，同时在运行java程序时，JVM也会保留注释，即可以通过反射来获取注释
     */
    RUNTIME
}

•  

3.@Documented

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

•  

即拥有这个注解的元素可以被javadoc此类的工具文档化。它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@return,@param 等。

4.@Inherited

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

•  

允许子类继承父类中的注解。即拥有此注解的元素其子类可以继承父类的注解。

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

三、自定义注解

 

自定义注解的元注解：

1. @Target—作用域（constructor(构造方法声明)，field（字段声明），local_variable（局部变量声明），method（方法声明），package（包声明），parameter（参数声明），type（类，接口声明））
2. @Retention—生命周期（source：只在源码显示，编译时会丢弃。class：编译时会记录到class中，运行时忽略。runtime：运行时存在，可以通过反射读取）
3. Inherited—标识注解(允许子类继承)
4. Documented—生成Javadoc
5. 若成员只有一个，必须为value，这个参数赋值可以不写value=XXX

成员以无参无异常方式声明。成员类型是受限的，合法的类型包括原始类型及String，Class，Annotation, Enumeration.

上面用了注解，程序中获得注解信息的方法是反射。
Class cls = Class.forName(“”);//使用类加载器加载类
cls.isAnnotationPresent(xx.class);//判断cls这个类上是否有xx的注解，找到类上注解
xx a = (xx)cls.getAnnotation(xx.class);//取得其上的注解

下面附一个实例，是框架如何使用注解描述参数。
结构图

A.java

package javaBasic;

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.PARAMETER ,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface A {
    String value();
    String name() default "bingone";
    int age() default 20;
}

• B.java

package javaBasic;

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.PARAMETER ,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface B {
    String value();
    String name() default "bingone";

}

• DataClass.java

package javaBasic;

public class DataClass {
    public String name;
    public int age;
    public DataClass(String name, int age) {
        super();
        this.name = name;
        this.age = age;
    }

}

• RunClass.java

package javaBasic;

public class RunClass {
    public static void run(@A("str") String str,@B("age")int age){
        System.out.println("In run Method str:" + str + "age:" + age);
    }
}

• TestClass.java

package javaBasic;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
/**
 * 通过注解传参数
 * @author gg_gogoing
 *
 */
public class TestClass {
    public static void parseMethod(DataClass data,Object obj,String mthname){
        //验证是否有注解
        //若有则两种方法：
        //1. 在编译时刻已经有了对应的表，查表即可
        //2. 如下的遍历方式。
        if(obj instanceof RunClass){
            String str = null;
            int age = 0;
            Method [] methods = (Method[])obj.getClass().getMethods();
            for(Method method :methods){
                if(method.getName().equals(mthname)){
                    Annotation[][] annotations = method.getParameterAnnotations();
                    for(Annotation[] tt : annotations){
                        for(Annotation t:tt){
                            if(t instanceof A){
                                str = data.name;
                            }else if(t instanceof B){
                                age = data.age;
                            }
                        }
                    }
                    RunClass.run(str, age);
                }
            }
        }
    }

    public static void main(String[] args) throws Exception, RuntimeException { // 主方法
        //不直接传参数，而是将一个类中的数据传入
        DataClass dc = new DataClass("gg_gogoing", 20);
        parseMethod(dc, new RunClass(), "run");

    }

}

•