Java：注解（Annotation）深度理解 自定义注解

元注解的深度理解 自定义注解

注解

为元数据加以说明的 补充文字，用于解释包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 

常见的几种注解（√）

@Override

标明 定义的方法为重写的方法，会自动检测是否为合法的重写，如果不是，报编译错误！！！

@Deprecated

 当我们设计的方法不再适用，但又不能删除，需要做一些提醒给
 后面的调用者，可以考虑使用注解方式，会自动添加删除线

@SuppressWarnings 忽略警告

---

（一）自定义注解

1、自定义注解：

<1>使用@interface自定义注解时，自动继承java.lang.annotation.Annotation接口

<2>由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

<3>@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。

<4>方法的名称就是参数的名称，

返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。

<5>可以通过default来声明参数的默认值。

2自定义注解语法如下：

[修饰符] @interface 注解名{

    类型 变量名() default 默认值;
}
注意：默认值可以省略、

使用注解语法：

在修饰的包、类、方法、属性等上面：

@注解类名(变量名=值)

注意： 如果变量名 为value，则 可以简写  ：@注解类名(值)

      如果定义时有默认值，可以简写：@注解类名

---

（二）、元注解

1、定义：

注解其他注解。被用来提供对其它 annotation类型作说明。

Java5.0定义了4个标准的meta-annotation类型（元注解）

这些类型和它们所支持的类在java.lang.annotation包中可以找到
每个元注解的作用和相应参数的使用说明。

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

---

2、四个元注解的描述和参数：

@Target：

(1)描述：

用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

说明了Annotation所修饰的对象范围：

<1>Annotation可被用于 packages、types（类、接口、枚举、 Annotation类型）

<2>类型成员（方法、构造方法、成员变量、枚举值）

<3>方法参数和本地变量（如循环变量、catch参数）

<4>在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

(2)取值(ElementType)有：

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

(3)举例如下：

注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,

而注解NoDBColumn仅可用于注解类的成员变量。

代码如下

@Target(ElementType.TYPE)
  public @interface Table{
/**
 * 数据表名称注解，默认值为类名称
 * @return
 */
 public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

---

@Retention：

（1）描述：

 作用：表示需要在什么级别保存该注释信息，
 用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

<1>@Retention定义了该Annotation被保留的时间长短：
某些Annotation仅出现在源代码中，而被编译器丢弃；

<2>而另一些却被编译在class文件中；编译在class文件中的
Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取

<3>（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。

<4>使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

---

(2)取值（RetentionPoicy）有：

1.SOURCE:在源文件中有效（即源文件保留）

2.CLASS:在class文件中有效（即class保留）

3.RUNTIME:在运行时有效（即运行时保留）

Retention meta-annotation类型有唯一的value作为成员，它的取值来自

java.lang.annotation.RetentionPolicy的枚举类型值。

具体实例如下：

Column注解的的RetentionPolicy的属性值是RUTIME,

这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField"; 
public boolean defaultDBValue() default false;
}

---

@Documented:

(1)描述：

@Document 能否在文档注释显示

用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，

因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField"; 
public boolean defaultDBValue() default false;
}

---

@Inherited：

<1>@Inherited 元注解是一个标记注解

<2>@Inherited阐述了某个被标注的类型是被继承的。

<3>如果一个使用了@Inherited修饰的annotation类型被用于一个class，

则这个annotation将被用于该class的子类。

<4>注意：@Inherited annotation类型是被标注过的class的子类所继承。

类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

<5>当@Inherited annotation类型标注的annotation的Retention是

RetentionPolicy.RUNTIME，则反射API增强了这种继承性。

<6>如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的

annotation时、反射代码检查将展开工作：检查class和其父类，

直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

实现如下：

@Inherited
public @interface Greeting {
public enum FontColor{ BULE,RED,GREEN};
String name();
FontColor fontColor() default FontColor.GREEN;
}