什么是注解?

注解是一种元数据,具有描绘效果,一种代码等级的阐明,它是JDK 1.5及今后版别引进的一个特性,与类、接口、枚举是在同一个层次。它能够声明在包、类、字段、办法、局部变量、办法参数等的前面,用来对这些元素进行阐明,注释。


注解的效果

1、符号效果,供给信息让编译器能够完成格局查看,例如@override
2、生成文档,这是常见功用,也是Java最早供给的注解
3、使代码逻辑明晰,简练


注解的分类

第一种分类:依照来历分类

1、根本内置注解,是指Java自带的几个Annotation,如@Override、Deprecated、@SuppressWarnings

2、元注解(meta-annotation),是指担任注解其他注解的注解,JDK 1.5及今后版别界说了4个规范的元注解类型,如下:

  • 1、@Target
  • 2、@Retention
  • 3、@Documented
  • 4、@Inherited

3、自界说注解

第二种分类:依照效果域分类
  • 1、源码时注解(RetentionPolicy.SOURCE)
  • 2、编译时注解(RetentionPolicy.CLASS)
  • 3、运转时注解(RetentionPolicy.RUNTIME)
第三种分类:依照运转机制分类
  • 1、源码注解:只在源码中存在,编译成.class文件就不存在了。
  • 2、编译时注解:在源码和.class文件中都存在。像前面的@Override、@Deprecated、@SuppressWarnings,他们都归于编译时注解。
  • 3、运转时注解:在运转阶段还起效果,甚至会影响运转逻辑的注解。像@Autowired主动注入的这样一种注解就归于运转时注解,它会在程序运转的时分把你的成员变量主动的注入进来。

注解的了解

要深化学习注解,有必要能界说自己的注解,在界说自己的注解钱,有必要了解Java为咱们供给的元注解和相关界说注解的语法

元注解:

元注解的效果就是担任注解其他注解。Java5.0界说了4个规范的meta-annotation类型,它们被用来供给对其它 annotation类型作阐明。Java5.0界说的元注解:

  • 1.@Target,
  • 2.@Retention,
  • 3.@Documented,
  • 4.@Inherited

这些类型和它们所支撑的类在java.lang.annotation包中能够找到。下面咱们看一下每个元注解的效果和相应分参数的运用阐明。

@Target:

   @Target阐明晰Annotation所润饰的方针规模:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(办法、结构办法、成员变量、枚举值)、办法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中运用了target可更加明晰其润饰的方针。

  效果:用于描绘注解的运用规模(即:被描绘的注解能够用在什么地方)

  取值(ElementType)有:
1.CONSTRUCTOR:用于描绘结构器
2.FIELD:用于描绘域
3.LOCAL_VARIABLE:用于描绘局部变量
4.METHOD:用于描绘办法
5.PACKAGE:用于描绘包
6.PARAMETER:用于描绘参数
7.TYPE:用于描绘类、接口(包括注解类型) 或enum声明

@Retention:

  @Retention界说了该Annotation被保存的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation或许会被虚拟机忽略,而另一些在class被装载时将被读取(请留意并不影响class的执行,因为Annotation与class在运用上是被分离的)。运用这个meta-Annotation能够对 Annotation的“生命周期”限制。

  效果:表示需要在什么等级保存该注释信息,用于描绘注解的生命周期(即:被描绘的注解在什么规模内有用)

  取值(RetentionPoicy)有:
1.SOURCE:在源文件中有用(即源文件保存)
2.CLASS:在class文件中有用(即class保存)
3.RUNTIME:在运转时有用(即运转时保存)
4.

@Documented:

  @Documented用于描绘其它类型的annotation应该被作为被标示的程序成员的公共API,因而能够被例如javadoc此类的工具文档化。Documented是一个符号注解,没有成员。

@Inherited:

  @Inherited 元注解是一个符号注解,@Inherited阐述了某个被标示的类型是被承继的。假如一个运用了@Inherited润饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

  留意:@Inherited annotation类型是被标示过的class的子类所承继。类并不从它所完成的接口承继annotation,办法并不从它所重载的办法承继annotation。

  当@Inherited annotation类型标示的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种承继性。假如咱们运用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码查看将展开工作:查看class和其父类,直到发现指定的annotation类型被发现,或者抵达类承继结构的顶层。


自界说注解

运用@interface 自界说注解时,自定承继java.lang.annotation.Annotation接口,由编译程序主动完成其他细节,在界说注解时,不能承继其他的注解或接口。@interface用来声明一个注解,其中的每一个办法实际上是声明晰一个装备参数。办法的称号就是参数的称号,回来值类型就是参数的类型(回来值类型只能是根本类型、Class、String、enum)。能够经过default来声明参数的默许值。
界说注解格局:
public @interface 注解名 {界说体}

注解参数的可支撑数据类型:

    1.一切根本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上一切类型的数组

Annotation类型里边的参数该怎么设定:
第一,只能用public或默许(default)这两个拜访权润饰.例如,String value();这儿把办法设为defaul默许类型;   
第二,参数成员只能用根本类型byte,short,char,int,long,float,double,boolean八种根本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这儿的参数成员就为String;  
第三,假如只有一个参数成员,最好把参数称号设为”value”,后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

简略的自界说注解和运用注解实例:

/**
 * 生果称号注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}

/**
 * 生果色彩注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 色彩枚举
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    /**
     * 色彩特点
     * @return
     */
    Color fruitColor() default Color.GREEN;
}
public class Apple {
    @FruitName("Apple")
    private String appleName;
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    public void displayName(){
        System.out.println("生果的名字是:苹果");
    }
}

注解元素的默许值:

  注解元素有必要有确认的值,要么在界说注解的默许值中指定,要么在运用注解时指定,非根本类型的注解元素的值不可为null。因而, 运用空字符串或0作为默许值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态,因为每个注解的声明中,一切元素都存在,而且都具有相应的值,为了绕开这个约束,咱们只能界说一些特殊的值,例如空字符串或者负数,一次表示某个元素不存在,在界说注解时,这已经成为一个习惯用法。

界说了注解,并在需要的时分给相关类,类特点加上注解信息,假如没有响应的注解信息处理流程,注解能够说是没有实用价值。如何让注解真真的发挥效果,主要就在于注解处理办法

注解处理器

注解处理器类库(java.lang.reflect.AnnotatedElement):

Java运用Annotation接口来代表程序元素前面的注解,该接口是一切Annotation类型的父接口。除此之外,Java在java.lang.reflect 包下新增了AnnotatedElement接口,该接口代表程序中能够接受注解的程序元素,该接口主要有如下几个完成类:

  Class:类界说
Constructor:结构器界说
Field:累的成员变量界说
Method:类的办法界说
Package:类的包界说

  java.lang.reflect 包下主要包括一些完成反射功用的工具类,实际上,java.lang.reflect 包一切供给的反射API扩大了读取运转时Annotation信息的才干。当一个Annotation类型被界说为运转时的Annotation后,该注解才干是运转时可见,当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。
AnnotatedElement 接口是一切程序元素(Class、Method和Constructor)的父接口,所以程序经过反射获取了某个类的AnnotatedElement方针之后,程序就能够调用该方针的如下四个个办法来拜访Annotation信息:

办法1: T getAnnotation(Class annotationClass): 回来改程序元素上存在的、指定类型的注解,假如该类型注解不存在,则回来null。
办法2:Annotation[] getAnnotations():回来该程序元素上存在的一切注解。
办法3:boolean is AnnotationPresent(Class

/***********注解声明***************/
/**
 * 生果称号注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}
/**
 * 生果色彩注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 色彩枚举
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    /**
     * 色彩特点
     * @return
     */
    Color fruitColor() default Color.GREEN;
}
/**
 * 生果供应者注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    /**
     * 供货商编号
     * @return
     */
    public int id() default -1;
    /**
     * 供货商称号
     * @return
     */
    public String name() default "";
    /**
     * 供货商地址
     * @return
     */
    public String address() default "";
}
/***********注解运用***************/
public class Apple {
    @FruitName("Apple")
    private String appleName;
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
    private String appleProvider;
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    public void setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
    public String getAppleProvider() {
        return appleProvider;
    }
    public void displayName(){
        System.out.println("生果的名字是:苹果");
    }
}
/***********注解处理器***************/
public class FruitInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        String strFruitName=" 生果称号:";
        String strFruitColor=" 生果色彩:";
        String strFruitProvicer="供货商信息:";
        Field[] fields = clazz.getDeclaredFields();
        for(Field field :fields){
            if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供货商编号:"+fruitProvider.id()+" 供货商称号:"+fruitProvider.name()+" 供货商地址:"+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}
/***********输出成果***************/
public class FruitRun {
    /**
     * @param args
     */
    public static void main(String[] args) {
        FruitInfoUtil.getFruitInfo(Apple.class);
    }
}
====================================
 生果称号:Apple
 生果色彩:RED
 供货商编号:1 供货商称号:陕西红富士集团 供货商地址:陕西省西安市延安路89号红富士大厦

再依据下图回顾一下Java注解的根底知识点(见下面导图),进一步加深对注解的各个知识点的了解和运用。

Java进阶知识 —— Java注解知识梳理

参考


  https://www.jianshu.com/p/24820bf3df5c
  http://www.cnblogs.com/peida/archive/2013/04/23/3036035.html