码农小汪之理解Java注解。

2021年09月15日 阅读数:2
这篇文章主要向大家介绍码农小汪之理解Java注解。,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。

既然是理解注解?咱们的啥子事注解呢?咱们平时的时候是否有过使用这个东西呢?我想得,咱们可能都是碰见过的,只是没有思考过这个问题,到底哦是怎么实现和处理的。java

Annotation(注解)

就是Java提供了一种元程序中的元素关联任何信息和着任何元数据(metadata)的途径和方法。Annotion(注解)是一个接口,程序能够经过反射来获取指定程序元素的Annotion对象,而后经过Annotion对象来获取注解里面的元数据。它能够用于建立文档,跟踪代码中的依赖性,甚至执行基本编译时检查。从某些方面看,annotation就像修饰符同样被使用,并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在Annotation的“name=value”结构对中。程序员

Annotation的成员

在Annotation类型中以无参数的方法的形式被声明。其方法名和返回值定义了该成员的名字和类型。在此有一个特定的默认语法:容许声明任何Annotation成员的默认值:一个Annotation能够将name=value对做为没有定义默认值的Annotation成员的值,固然也可使用name=value对来覆盖其它成员默认值。这一点有些近似类的继承特性,父类的构造函数能够做为子类的默认构造函数,可是也能够被子类覆盖。
Annotation能被用来为某个程序元素(类、方法、成员变量等)关联任何的信息。须要注意的是,这里存在着一个基本的规则:Annotation不能影响程序代码的执行,不管增长、删除 Annotation,代码都始终如一的执行。另外,尽管一些annotation经过java的反射api方法在运行时被访问,而java语言解释器在工做时忽略了这些annotation。正是因为java虚拟机忽略了Annotation,致使了annotation类型在代码中是“不起做用”的; 只有经过某种配套的工具才会对annotation类型中的信息进行访问和处理。api

注解的分类:

注解参数的个数分类:

  • 标记注解:一个没有成员定义的Annotation类型被称为标记注解。这种Annotation类型仅使用自身的存在与否来为咱们提供信息。好比后面的系统注解@Override;数组

  • 单值注解app

  • 完整注解

根据注解使用方法和用途

  • JDK内置系统注解
    @Override:用于修饰此方法覆盖了父类的方法;
    @Deprecated:用于修饰已通过时的方法
    @SuppressWarnnings:用于通知java编译器禁止特定的编译警告。
  • 元注解
  • 自定义注解

下面的都是咱们的系统内置的注解,相信你们平时的时候也会碰见这种东西,咱们仍是有必要了解这些东东怎么回事的,使用起来的时候,才会知之为知之。

 @Override 是一个标记注解类型,它被用做标注方法。它说明了被标注的方法重载了父类的方法,起到了断言的做用。若是咱们使用了这种Annotation在一个没有覆盖父类方法的方法时,java编译器将以一个编译错误来警示。这个annotaton经常在咱们试图覆盖父类方法而确又写错了方法名时发挥威力。
 @Deprecated,标记已过期。同 样Deprecated也是一个标记注解。当一个类型或者类型成员使用@Deprecated修饰的话,编译器将不鼓励使用这个被标注的程序元素。并且这种修饰具备必定的 “延续性”:若是咱们在代码中经过继承或者覆盖的方式使用了这个过期的类型或者成员,虽然继承或者覆盖后的类型或者成员并非被声明为 @Deprecated,但编译器仍然要报警。
@SuppressWarnnings,抑制编译器警告。@SuppressWarnings 被用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告。ide


要学习java的注解,本身也想写一个注解这个玩意的话,咱们的首先了解哈咱们的元注解,这个是本身自定义注解的前提条件函数

元注解:

元注解的做用就是负责注解其余注解   

@Target

@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
做用:用于描述注解的使用范围(即:被描述的注解能够用在什么地方)
取值(ElementType)有:工具

Type means
CONSTRUCTOR 用于描述构造器
FIELD 用于描述域
LOCAL_VARIABLE 用于描述局部变量
METHOD 用于描述方法
PACKAGE 用于描述包
PARAMETER 用于描述参数
TYPE 用于描述类、接口(包括注解类型) 或enum声明

@Retention

 做用:表示须要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
 @Retention定义了该Annotation被保留的时间长短:某些Annotation仅出如今源代码中,而被编译器丢弃;而另外一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另外一些在class被装载时将被读取(请注意并不影响class的执行,由于Annotation与class在使用上是被分离的)。使用这个meta-Annotation能够对 Annotation的“生命周期”限制。学习

Type means
SOURCE 在源文件中有效(即源文件保留)
CLASS 在class文件中有效(即class保留)
RUNTIME 在运行时有效(即运行时保留)

@Documented

@Documented用于描述其它类型的annotation应该被做为被标注的程序成员的公共API,所以能够被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。ui

@Inherited:

 @Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。若是一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
  注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。


自定义注解:

使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其余细节。在定义注解时,不能继承其余的注解或接口。@interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。
定义注解格式:

public @interface 注解名 {定义体}

参数成员只能用基本类型

byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;

注解元素的默认值

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


注解处理器类

若是没有用来读取注解的方法和工做,那么注解也就不会比注释更有用处了。使用注解的过程当中,很重要的一部分就是建立于使用注解处理器。Java SE5扩展了反射机制的API,以帮助程序员快速的构造自定义注解处理器。注解处理器类库(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 extends Annotation> T getAnnotation(Class annotationClass): 返回改程序元素上存在的、指定类型的注解,若是该类型注解不存在,则返回null。

方法2:

Annotation[] getAnnotations():返回该程序元素上存在的全部注解。

方法3:

boolean is AnnotationPresent(Class< ?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,不然返回false.

方法4:

Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的全部注释。与此接口中的其余方法不一样,该方法将忽略继承的注释。(若是没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者能够随意修改返回的数组;这不会对其余调用者返回的数组产生任何影响。
 
  下面是个简单的实现咱们的处理器:
  码农小汪之理解Java注解。_java

其实下面的是参考别人的试试写的,咱们并非要本身去书写注解这个东西,仅仅的意义是知道,这个是怎么完成工做的,这个很重要。

package annotionDemo;
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;

/**
 * 
 * @author JetWang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    public enum Color{BLUE,RED,BLACK};
    Color fruitclor() default Color.BLUE;

}
package annotionDemo;

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;
/**
 * 
 * @author JetWang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
  String value() default " ";
}
package annotionDemo;

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;
/**
 * 
 * @author JetWang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {

    public int id() default -1;

    public String name() default "";

    public String address() default "";

}

注解的处理器的使用!

package annotionDemo;

import java.lang.reflect.Field;

import annotionDemo.FruitColor.Color;

/**
 * 
 * @author JetWang
 *
 */
public class Apple {
    @FruitName(value = "dapingguo")
    private String appName;

    @FruitProvider(id = 1, address = "XXXX", name = "xxx-provider")
    private String appProvider;

    @FruitColor(fruitclor = Color.RED)
    private String appColor;

    public String getAppName() {
        return appName;
    }

    public void setAppName(String appName) {
        this.appName = appName;
    }

    public String getAppProvider() {
        return appProvider;
    }

    public void setAppProvider(String appProvider) {
        this.appProvider = appProvider;
    }

    public String getAppColor() {
        return appColor;
    }

    public void setAppColor(String appColor) {
        this.appColor = appColor;
    }

    public static void main(String[] args) {

        String strFruitName = " 水果名称:";
        String strFruitColor = " 水果颜色:";
        String strFruitProvicer = "供应商信息:";
        Field[] fileFields = Apple.class.getDeclaredFields();
        for (Field field : fileFields) {
            if (field.isAnnotationPresent(FruitName.class)) {

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

}


结果:
 水果名称:dapingguo
 供应商编号:1 供应商名称:xxx-provider 供应商地址:XXXX
 水果颜色:RED

好辣,就这些了…..
 http://www.zhihu.com/question/24401191