注解

注解

什么是注解（Annotation）？

注释：给程序员看的，帮助程序员理解程序的代码逻辑

注解：给程序看的，可以让程序根据有无注解而执行不同的代码逻辑

• Annotation是从JDK5.0开始引入的新技术。
• Annotation的作用：
  – 不是程序本身，可以对程序作出解释。(这一点，跟注释没什么区别) – 可以被其他程序(比如：编译器等)读取。(注解信息处理流程，是注解和注释的重大区别。如果没有注解信息处理流程，则注解毫无意义)
• Annotation的格式：
  – 注解是以“@注释名” 在代码中存在的，我们最常见的一个注解就是在重写父类方法或者实现接口的时候，方法上边有一行@Override，这个就是注解。还可以添加一些参数值，例如：
  @SuppressWarnings(value=“unchecked”)。
• Annotation在哪里使用?
  – 可以附加在package, class, method, field等上面，相当于给它们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

内置注解

@Override

定义在java.lang.Override中，此注释只适用于修辞方法，表示一个方法声明打算重写超类(父类)中的另一个方法声明。

@Deprecated

– 定义在java.lang.Deprecated中，此注释可用于修辞方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险，或者已过时，存在更好的选择。

@SuppressWarnings

– 定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。
– 与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数值都是已经定义好了的，我们选择性的使用就好了，参数如下（部分常见的）：

– @SuppressWarnings(“unchecked”) – @SuppressWarnings(value={“unchecked”
,“deprecation”})
我们在看看就一个例子：

这是没加注解的：

在eclipse中我们写了这样一行代码，明显看到List 、list、ArraryList下边有明显的黄色的波浪线，List有这样一句警告：List is a raw type. References to generic type List should be parameterized，其实就是我们没加泛型的原因，但是我们就不想加，又不想看到这个黄色的波浪线，所以我们加个注解：
list下边的警告是因为list没有被使用，我们也可以加个注解忽略警告（其实没啥用这个注解）：

或者直接加个all:

自定义注解

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

• 要点：
  – @interface用来声明一个注解
• 格式为：
  – public @interface 注解名 {定义体} – 其中的每一个方法实际上是声明了一个配置参数。
  – 方法的名称就是参数的名称
  – 返回值类型就是参数的类型（返回值类型只能是基本数据类型、Class类型、String类型、enum类型、Annotation类型、以上所有类型的数组）

public @interface MyAnnotation {	
	String value();
}

– 可以通过default来声明参数的默认值。

public @interface MyAnnotation {	
	String value() default "null";
}

– 如果只有一个参数成员，一般参数名为value，可以省略“value=”
– 没有成员定义的 Annotation称为标记;包含成员变量的Annotation称为元数据Annotation。

• 注意：
  注解元素必须要有值。我们定义注解元素时，经常使用空字符串、0作为默认值。也经常使用负数(比如：-1)表示不存在的含义。

自定义注解必须配上注解的信息处理流程才有意义。

元注解

• 元注解的作用就是负责注解其他注解。 Java定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。
• 这些类型和它们所支持的类在java.lang.annotation包中可以
  找到
  – @Target
  – @Retention
  – @Documented
  – @Inherited

@Target

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


– @Target(value=ElementType.TYPE)

@Retention

@Retention 表示需要在什么级别保存该注释信息，用于描述注解的生命周期，

@Retention的作用范围：

@Documented

@Documented注解的作用是：描述在使用 javadoc 工具为类生成帮助文档时是否要保留其注解信息。

@Inherited

@Inherited注解的作用是：使被它修饰的注解具有继承性（如果某个类使用了被@Inherited修饰的注解，则其子类将自动具有该注解）。

利用反射获取注解:

try {
Class clazz = Class.forName("com.bjsxt.test.annotation.SxtStudent");
//获得类的所有有效注解
Annotation[] annotations=clazz.getAnnotations();
for (Annotation a : annotations) {
System.out.println(a);
}
//获得类的指定的注解
SxtTable st = (SxtTable) clazz.getAnnotation(SxtTable.class);
System.out.println(st.value());
//获得类的属性的注解
Field f = clazz.getDeclaredField("studentName");
SxtField sxtField = f.getAnnotation(SxtField.class);
System.out.println(sxtField.columnName()+"--"+sxtField.type()+"--"+sxtField.length());
//根据获得的表名、字段的信息，拼出DDL语句，然后，使用JDBC执行这个SQL，在数据库中生成相关的表
} catch (Exception e) {
e.printStackTrace();
}