1. 概述

  • Annotation是从JDK1.5开始引入的新技术
  • Annotation的作用
    • 不是程序本身,可以对程序作出解释(这一点与与注释没有什么区别)
    • 可以被其他程序(编译器)读取。
  • Annotation的格式
    • 注解是以“@注释名”在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value="unchecked")
  • Annotation在哪里使用
    • 可以附加在package,class,method,field等上边,相当于给他们添加了额外的辅助信息,可以通过反射机制编程实现对这些元数据的访问

2. 内置注解

2.1 @Override

定义在java.lang.Override中,此注解只适用于修饰方法,表示一个方法声明打算重写父类中的另一个方法声明。

2.2 @Deprecated

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

2.3 @SuppressWarnings

定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息,与前两个注释有所不同,该注释需要添加一个参数才能正常使用,如@SuppressWarnings("all"), @SuppressWarnings("unchecked")等等。

3. 元注解

元注解的作用就是负责注解其他注解,Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明。

这些类的和它们所支持的类在java.lang.annotation包中可以找到,即**@Target,@Retention,@Documented,@Inherited**

3.1 @Target

用于描述注解的使用范围,即被描述的注解可以用在什么地方。

3.2 @Retention

表示需要在什么级别保存该注释信息,用于描述注解的生命周期(RUNTIME > CLASS > SOURCE)

3.3 @Document

说明该注解将被包含在javadoc中

3.4 @Inherited

说明子类可以继承父类中的该注解

4. 自定义注解

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

4.1 注意事项

  • @interface用来声明一个注解,格式:public @interface 注解名 {定义内容}
  • 其中的每一个方法实际上是声明了一个配置参数
  • 方法的名称就是参数的名称
  • 返回值的类型就是参数的类型(返回值只能是基本类型,Class,String,enum)
  • 可以通过default来声明参数的默认值
  • 如果只有一个参数成员,一般参数名为value
  • 注解元素必须要有值,定义注解元素时,经常使用空字符串,0作为默认值

5. ORM练习

对象关系映射「Object relationship Mapping」

  • 利用注解和反射完成类和表结构的映射关系,要求如下
    • 类与表结构对应
    • 属性和字段对应
    • 对象和记录对应

5.1 实现代码

@Table

1
2
3
4
5
6
// 类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Table {
String value();
}

@Field

1
2
3
4
5
6
7
8
// 属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface Field {
String columnName();
String type();
int length();
}

Student

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@Table("db_student")
class Student {
@Field(columnName = "id", type = "int", length = 10)
private int id;
@Field(columnName = "age", type = "int", length = 10)
private int age;
@Field(columnName = "name", type = "varchar", length = 16)
private String name;

public Student() {
}

public int getId() {
return id;
}

public void setId(int id) {
this.id = id;
}

public int getAge() {
return age;
}

public void setAge(int age) {
this.age = age;
}

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

@Override
public String toString() {
return "Student{" +
"id=" + id +
", age=" + age +
", name='" + name + '\'' +
'}'
}
}

获取结果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public static void main(String[] args) throws NoSuchFieldException {
Class<Student> studentClass = Student.class;
// 获得@Table注解的value值
System.out.println("@Table注解中的值:" + studentClass.getAnnotation(Table.class).value());
// 获得类指定的注解
java.lang.reflect.Field[] declaredFields = studentClass.getDeclaredFields();
for (java.lang.reflect.Field field : declaredFields) {
Field fieldAnnotation = field.getAnnotation(Field.class);
System.out.println(field.getName() + "属性中的注解colunmName值:" + fieldAnnotation.columnName());
System.out.println(field.getName() + "属性中的注解type值" + fieldAnnotation.type());
System.out.println(field.getName() + "属性中的注解length值" + fieldAnnotation.length());
}
}

// 运行结果
// @Table注解中的值:db_student
// id属性中的注解colunmName值:id
// id属性中的注解type值int
// id属性中的注解length值10
// age属性中的注解colunmName值:age
// age属性中的注解type值int
// age属性中的注解length值10
// name属性中的注解colunmName值:name
// name属性中的注解type值varchar
// name属性中的注解length值16