JAVA注解开发（精讲）
Java注解开发
一. 什么是注解
Annotation（注解）就是Java提供了一种为程序元素关联任何信息或任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。
-
注解出现的位置
Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。从某些方面看，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类型中的信息进行访问和处理
5、注解的作用是什么
注解（Annotation） 为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后 某个时刻方便地使用这些数据（通过 解析注解 来使用这些数据），常见的作用有以下几种：
(1).生成文档。这是最常见的，也是java 最早提供的注解。常用的有@see @param @return 等；
(2).在编译时进行格式检查。如@Override放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出；
(3).跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量；
二.JDK自带的注解
- @Override 表示当前方法覆盖了父类的方法
此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明。如果方法利用此注释类型进行注解但没有重写超类方法，则编译器
会生成一条错误消息
- @Deprecated 表示方法已经过时,方法上有横线，使用时会有警告。
此注释可用于修辞方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。在使用不被赞成的程序元素或在不被赞成的代码中执行重写时，编译器会发出警告
3. @SuppressWarings 表示关闭一些警告信息(通知java编译器忽略特定的编译警告)
用来抑制编译时的警告信息。与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数值都是已经定义好了的，我们选择性的使用就好了，
参数如下：
实例代码:
我们在方法上面加上 @SuppressWarnings(“rawtypes”) .这是泛型的警告就会消失.但是还有一个变量未使用的警告
我们可以添加多种类型,多种类型用{}扩起来
另外，由于@SuppressWarnings注释只有一个参数，并且参数名为value，所以我们可以将上面一句注释简写为
@SuppressWarnings(“unchecked”)；
同时参数value可以取多个值如：
@SuppressWarnings(value={“unchecked”, “deprecation”})
或@SuppressWarnings({“unchecked”, “deprecation”})。
三.开发自定义注解
- 自定义注解的语法规则
(1).使用@interface关键字定义注解，注意关键字的位置
使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。
(2).成员以无参数无异常的方式声明，注意区别一般类成员变量的声明
其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称
(3).可以使用default为成员指定一个默认值，如上所示
(4).成员类型是受限的，合法的类型包括原始类型以及String、Class、Annotation、Enumeration （JAVA的基本数据类型有8种：
byte(字节)、short(短整型)、int(整数型)、long(长整型)、float(单精度浮点数类型)、double(双精度浮点数类型)、char(字符类型)、boolean(布尔类型）
(5).注解类可以没有成员，没有成员的注解称为标识注解，例如JDK注解中的@Override、@Deprecation
(6).如果注解只有一个成员，并且把成员取名为value()，则在使用时可以忽略成员名和赋值号“=” ,例如JDK注解的@SuppviseWarnings ；如果成员名 不为value，则使用时需指明成员名和赋值号"="，
- 元注解：
何为元注解？就是注解的注解，就是给你自己定义的注解添加注解，你自己定义了一个注解，但你想要你的注解有什么样的功能，此时就需要用元注解对你的注解进行说明了。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。
2.1、@Target
@Target说明了Annotation所修饰的对象范围：即注解的作用域，用于说明注解的使用范围（即注解可以用在什么地方，比如类的注解，方法注解，成员变量注解等等）
注意:如果Target元注解没有出现，那么定义的注解可以应用于程序的任何元素。
取值是在java.lang.annotation.ElementType这个枚举中规定的：
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
实例代码
2.2 @Retention
@Retention定义了该Annotation被保留的时间长短：
(1)某些Annotation仅出现在源代码中，而被编译器丢弃；
(2)而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，
(3)而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。
使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
@Retention的取值是在RetentionPoicy这个枚举中规定的
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在运行时有效（即运行时保留）
实例代码如下:
注意:注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理
2.3、@Documented
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。
2.4、@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类型被发现， 或者到达类继承结构的顶层。
(1) 定义注解1
(2) 定义注解2
(3) 定义一个基类
(4) 定义一个子类
(5) 通过反射获取子类中使用的所有的注解
四.注解开发实例:通过注解创建数据库表
-
创建Column注解,表示数据库中的字段信息
-
创建Table注解,表示数据库中的表
-
创建JavaBen类,使用定义的注解
- 创建Main方法,读取JavaBen类中的注解信息,根据注解信息自动生成DDL语句
*****************************
1.Java中的注释类型Annotation是一种引用数据类型，也称为注解。*
自定义注释的开发过程。
no.1.声明一个类My Annotation
no.2.把class 关键字改成 @interface，实质上声明了一个接口，这个接口自动的继承了Java.lang.annotation.Annotation接口。
2.常用内置注解： @Override @Deprecated @SuppressWarnings，以及它们各自的作用。*
@Deprecated,表示这个方法过时了,最好别用了 @Override表示方法重写，或者覆盖。
@SuppressWarnings让编译器忽略警告信息。 （@suppressWarnings({rawtypes})）
@suppressWarnings(value = {rawtypes})//泛型
3.自定义注解的时候，这几个注解你知道分别是干什么的吗？ @Retention @Target @Inherited @Documented*
no1. //@Target元注解是用来限定自定义注解的使用范围的。
@Target说明了Annotation所修饰的对象范围：即注解的作用域，
用于说明注解的使用范围（即注解可以用在什么地方，比如类的注解，方法注解，成员变量注解等等）
注意:如果Target元注解没有出现，那么定义的注解可以应用于程序的任何元素。
@Target取值是在java.lang.annotation.ElementType这个枚举中规定的：
//@Target({ ElementType.TYPE }) // 规定了自定义注解的使用范围是:只能在类型上面使用
@Target({ ElementType.TYPE, ElementType.METHOD }) // 规定了自定义注解的使用范围是:可以在类型上面使用,也可以在方法上面使用
@Retention(RetentionPolicy.RUNTIME) // 注解信息在运行时保留
public @interface MyAnnotation {
int age();
String name();
String schoolName() default "动力节点";
}
no2.@Retention定义了该Annotation被保留的时间长短：
// (1)某些Annotation仅出现在源代码中，而被编译器丢弃；
// (2)而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，运行时被忽略
// (3)而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。
// 使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
// @Retention的取值是在RetentionPoicy这个枚举中规定的
// 1.SOURCE:在源文件中有效（即源文件保留）
// 2.CLASS:在class文件中有效（即class保留）
// 3.RUNTIME:在运行时有效（即运行时保留,注意:只有注解信息在运行时保留,我们才能在运行时通过反射读取到注解信息）
// 注解的保留范围,只能三选一
no3.@Documented保存文件的
no4.@Inherit父类中使用的注解可以被子类继承.
自定义注解实际上就是一种类型而已,也就是引用类型(Java中除了8种基本类型之外,我们见到的任何类型都是引用类型)
类型的作用:(1)声明变量;(2)声明方法的参数;(3)声明方法的返回类型;(4)强制类型转换
因为我们在注解中声明了属性,所以在使用注解的时候必须要指明 属性值 ,多个属性之间没有顺序,多个属性之间通过逗号分隔
4.能够通过反射机制读取注解吗？*
能
package com.bjpowernode.annotationtest10;
import java.lang.reflect.Field;
public class ReflectTest {
/**
* 通过反射操作,获取类中携带的注解信息.根据读取到的信息生成数据库的建表语句
*
* @return
*/
public static String buildSql() {
// 准备数据库的建表语句
StringBuilder str = new StringBuilder("CREATE TABLE ");
// 获取Emp类对应的Class对象
Class claz = Emp.class;
// =============================================================
// 一.获取Emp类中携带的@Table注解,以此来获取表名信息
// (1)获取Emp类中携带的Table注解
Table table = (Table) claz.getAnnotation(Table.class);
System.out.println(table);
// (2)获取Table注解中的的属性信息
String tableName = table.tableName();// 获取表名信息
System.out.println(tableName);
// (3)把表名信息拼接到SQL语句中
str.append(tableName + " (");
// =============================================================
// 二:获取Emp类中携带的Column注解,来获取字段的相关信息
// (1)获取类中声明的所有的属性
Field[] fields = claz.getDeclaredFields();
// (2)遍历保存所有属性的Field的数组,取出每个属性
for (Field field : fields) {
// (3)判断属性中是否使用了Column注解
if (field.isAnnotationPresent(Column.class)) {
// (4)获取属性中使用的Column注解
Column column = field.getAnnotation(Column.class);
// (5)获取注解中携带的字段信息
String columnName = column.columnName(); // 获取字段名信息
String columnType = column.columnType(); // 获取字段类型信息
int columnLength = column.columnLength(); // 获取字段长度信息
String columnConstraint = column.columnConstraint(); // 获取字段约束信息
// (6)把字段的相关信息拼接到SQL语句中
if (columnName.equalsIgnoreCase("hiredate")) {
str.append(columnName + " " + columnType + " " + columnConstraint + ",");
System.out.println(str);
System.out.println();
} else {
str.append(columnName + " " + columnType + " (" + columnLength + ") " + columnConstraint + ",");
System.out.println(str);
}
}
}
// 去除SQL中最末尾的逗号,并且关闭SQL语句中的()
String sql = str.substring(0, str.length() -1) + ")";//截取字符串语句。
return sql;
}
public static void main(String[] args) {
String sql = buildSql();
System.out.println(sql);
}
}
5.java中的Annotation/注释类型，它有什么用？*
是为了在其他类中使用这个注释（使用注解来携带信息），这些携带信息可以在其他类的任何位置使用
从某些方面来看，annotatiom就像是一个修饰符一样来使用 ，并用于包，类型，方法，构造方法，成员变量，参数，本地变量声明中。
必须要和反射一起操作。【通过class 获取类的相关信息，通过class创建对象，通过class调用对象的方法和属性，这种操作称为反射操作。】
要想执行反射操作，必须先获取指定类名的class。
eg.String.class
class.forname("字符串")
String obj="Hello",Class claz = obj.getClass()
6. 注解中声明属性的语法比较怪异,即像在Java类中声明属性,又像在Java类中声明方法(实际上:即是声明了属性,又是声明了方法)
注解中声明属性的规范: 属性类型 属性名称 ();
属性名称的规范:名词或名词性短语,第一个单词首字符小写,其余单词首字符大写
在使用注解的时候,通过注解中的属性来携带信息
因为我们在注解中声明了属性,所以在使用注解的时候必须要指明属性值,多个属性之间没有顺序,多个属性之间通过逗号分隔
7.可以给注解中的属性提供缺省值
// 我们可以在注解中声明属性.(在注解中通过属性来携带信息)
public @interface MyAnnotation {
// 注解中声明属性的语法比较怪异,即像在Java类中声明属性,又像在Java类中声明方法(实际上:即是声明了属性,又是声明了方法)
// 注解中声明属性的规范: 属性类型 属性名称 ();
// 属性名称的规范:名词或名词性短语,第一个单词首字符小写,其余单词首字符大写
int age();
String name();
// 可以给注解中的属性提供缺省值
String schoolName() default "动力节点";
int [] arr() ;
8.如果注解中只有一个属性,并且属性名称是value,这样的话我们使用注解的时候,可以指明属性名称,也可以忽略属性名称
@MyAnnotation(value = { "Hello", "World" })
public class Main {
@MyAnnotation({ "Hello", "World" })
public static void main(String[] args) {
}
package com.bjpowernode.annotation8;
public @interface MyAnnotation {
String[] value();
}
9.方法重写要求访问权限不能降低，
priority : private 私有的，访问权限最低
default默认的
protected 受保护的 父子关系中常用
public 访问权限最高。
也不能抛出比父类更多的异常。 exceotion
IO exception
file not found
10.现实中的一个实体对应着一个数据库表;一个数据库表会对应着一个Java类;
实体中的属性成为表中的字段;表中的字段对应着类中的属性
和数据库表对应着的类称为JavaBean类,JavaBean的规范
1.类中的属性私有化,并且提供公开的getter/settter()方法
2.类中覆盖toString()方法 (为了输出对象做好了准备)
3.类中覆盖hashCode()/equals()方法(覆盖hashCode()/equals()的目的是为了把JavaBean类的对象放到HashMap/HashSet中做好准备)
4.类中提供公开的无参数的构造方法
5.该类要实现Serialiazble接口,并且声明serialVersionUID(使用Eclipse工具生成的) 为序列化做好了准备
我们要执行的功能,根据一个写好的JavaBean类,自动的生成数据库的建表语句(DDL)
创建数据库表所需要的信息:
(1)表名信息
(2)字段的信息,包括 字段名称,字段类型,字段长度,字段约束
我们如何来携带上面的建表所需要的信息呢?使用注解!
1.为了在JavaBean类中携带表名信息,我们创建一个@Table的注解,这个注解在类型上面使用,因为一个JavaBean类对应一个表
2.为了在JavaBean类中携带字段信息,我们创建一个@Column的注解,这个注解在类的属性中使用;因为类的属性对应着表中的字段
注解在实际开发中的作用
使用注解在类中携带信息,程序运行的时候通过反射操作获取到注解信息,然后根据获取到的信息生成数据库的建表语句
程序中携带信息的方式
1.通过注解来携带信息,然后通过反射来读取信息
2.通过文件来携带信息,然后通过IO来读取信息