Java注解与自定义注解

注解与自定义注解

一、概念

1.1 什么是注解

注解（Annotation），也叫元数据。一种代码级别的说明。JDK5新增，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

1.2 作用：

​ （1） 编写文档：通过代码里标识的注解生成文档【生成文档doc文档】

​ （2） 代码分析：通过代码里标识的注解对代码进行分析【使用反射】

​ （3） 编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

2 JDK中预定义的注解

共 7 个，java.lang下三个， java.lang.annotation下四个

2.1 作用在代码的注解是：

@Override - 检查该方法是否是重载方法。

@Deprecated - 过时标记。

@SuppressWarnings - 压制警告。

2.2 元注解

（1）@Target - 描述注解作用域

@Target(ElementType.XX)

参数	作用域
ElementType.TYPE	接口、类、枚举、注解
ElementType.FIELD	字段、枚举的常量
ElementType.METHOD	方法
ElementType.PARAMETER	方法参数
ElementType.CONSTRUCTOR	构造函数
ElementType.LOCAL_VARIABLE	局部变量
ElementType.ANNOTATION_TYPE	注解
ElementType.PACKAGE	包

（2）@Retention - 描述注解被保留的阶段。

@Retention(RetentionPolicy.xx)

参数	保留阶段
RetentionPolicy.SOURCE	源码
RetentionPolicy.CLASS	源码、class字节码
RetentionPolicy.RUNTIME	源码、class字节码、运行时

（3）@Documented - 注解是否抽取到文档中

（4）@Inherited - 是否被子类继承

举个例子：

@Documented
@Inherited
@Target(value = { ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnoDemoClazz1 {
	
}

2.3 JDK新增注解

（1）@SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

（2）@FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。

（3）@Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

3 自定义注解

首先举个例子：

public @interface AnnoDemoClazz2 {
	int value(); //属性为基本数据类型
	String name() default "admin"; //属性为String
	Person person(); //属性为枚举
	AnnoDemoClazz3 anno3(); //属性为注解
	String[] strs(); //属性为数组，前四种的数组均可
}

public enum Person {
	P1,P2
}

public @interface AnnoDemoClazz3 {}

@AnnoDemoClazz2(person = Person.P1, value = 0, anno3 = @AnnoDemoClazz3, strs = { "aaa", "vvv" })
public class Worker {}

@AnnoDemoClazz2(person = Person.P1, value = 0, anno3 = @AnnoDemoClazz3, strs = "aaa")
public class Worker {}

解析：

（1）首先需要声明为@interface，其实本质上是以下代码：

public interface com.tang.annotation.MyAnno extends java.lang.annotation.Annotation {}

（2）属性（接口中的抽象方法）

• 1.属性的返回值类型有下列类型

  • 基本数据类型
  • String
  • 枚举
  • 注解
  • 以上类型的数组

• 2.定义了属性，在使用时需要给属性赋值

  • 定义时用default赋默认值，可以不用赋值
  • 如果只有一个属性value需要赋值，可以省略value
  • 数组赋值用{}包裹，如果数组只有一个值，括号可以省略