Java注解（Annotation）

1. 注解简介

从JDK5开始，Java增加对元数据的支持，也就是注解，注解与注释是有一定区别的，可以把注解理解为代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过注解开发人员可以在不改变原有代码和逻辑的情况下在源代码中嵌入补充信息。
————百度百科

• 注解不是程序本身，可以对程序作出解释。（这一点跟注释没有区别）
• 可以被其他程序（比如：编译器等）读取
• 注解信息处理流程，是注解和注释的重大区别。如果没有注解信息处理流程，则注解毫无意义。因此，我们需要学会怎样去解析注解。

---

Annotation的作用

1、编译检查

• 让编译器进行编译检查的作用
• 例如，若某个方法被 @Override 的标注，则意味着该方法会覆盖父类中的同名方法。如果有方法被 @Override 标示，但父类中却没有"被 @Override 标注"的同名方法，则编译器会报错

2、在反射中使用 Annotation

• 在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口。这也意味着，我们可以在反射中解析并使用 Annotation。

3、生成帮助文档

• 通过给 Annotation 注解加上 @Documented 标签，能使该 Annotation 标签出现在 javadoc 中。

Annotation的格式

• 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value="unchecked")

Annotation使用场景

• 可以附加在package， class， method， field等上面，相当于给它们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

---

2. 内置注解

@Override ： 对父类的方法重写

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

@Deprecated ： 过时的，废弃的

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

@SuppressWarnings ：镇压报警信息

• 定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。

• 与前两个注释有所不同，需要添加一个参数才能正常使用，这些参数都是已经定义好了的，我们可以选择性的使用，参数如下：

    @SuppressWarnings(“unchecked”)----------------未检查的转化，如集合没有指定类型
    @SuppressWarnings(“unused”)   ----------------未使用的变量
    @SuppressWarnings(“resource”) ----------------有泛型未指定类型
    @SuppressWarnings(“path”)  -------------------在类路径，原文件路径中有不存在的路径
    @SuppressWarnings("deprecation ")  -----------使用了某些不赞成使用的类和方法		
    @SuppressWarnings("fallthrough") -------------switch语句执行到底没有break关键字
    @SuppressWarnings("serial")-------------------当在可序列化的类上缺少serialVersionUID定义
    @SuppressWarnings("rawtypes") ----------------没有传递带有泛型的参数
    @SuppressWarnings("finally")------------------任何finally子句不能完成时的警告 
    @SuppressWarnings("all") ---------------------全部类型的警告 
  

• 抑制多个警告，@SuppressWarnings(value = {“unchecked”, “deprecation”})

示例代码

public class AnnotationDemo {
    @Override
    public String toString() {
        return "";
    }
    
    @Deprecated
    public static void test01() {
        System.out.println("不建议使用");
    }
    
    @SuppressWarnings("all")
    public static void test02() {
        List list = new ArrayList<>();
    }
}

---

3. 自定义注解

简介：

1、@interface用来声明一个注解

2、格式为：public @interface 注解名 {定义体}

3、其中的每一个方法实际上是声明了一个配置参数

• 方法的名称就是参数的名称
• 返回值类型就是参数的类型，返回值类型只能是基本类型、Class、String、enum
• 可以通过default来声明参数的默认值
• 如果只有一个参数成员，一般参数名为value

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

注意：

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

示例代码

public class AnnotationDemo {
    @myAnnotation(studentName = "张三", age = 18, id = 1001,
            schools={"牛津大学"} ) //显式定义
    public void test() {
    }
    
    @myAnnotation02("java")   // 只有一个值，可以省略"value = "
    public void test01() {
    }
}

@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface myAnnotation {

    String studentName() default "";
    int age() default 0;
    int id() default -1;

    String[] schools() default {"清华大学", "北京大学"};
}

@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface myAnnotation02 {
    String value();
}

---

4. 元注解

1、元注解的作用就是负责注解其他注解，对注解作进一步解释

2、Java定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明

3、这些类型和它们所支持的类在java.lang.annotation包中可以找到

• @Target
• @Retention
• @Documented
• @Inherited

---

@Target

• 用于描述注解的使用范围，即被描述的注解可以在什么地方使用
• @Target(value = ElementType.TYPE)
• @Target(value = {ElementType.TYPE, ElementType.METHOD})

所修饰范围	取值(Element Type)
package 包	PACKAGE
类、接口、枚举、Annotation类型	TYPE
构造方法	CONSTRUCTOR : 描述构造器
方法	METHOD
字段、枚举的常量	FIELD
局部变量	LOCAL_VARIABLE
方法参数	PARAMETER

@Retention

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

取值（RetentionPolicy)	作用
SOURCE	在源文件中有效（即源文件保留）
CLASS	在class文件中有效（即class保留）
RUNTIME	在运行时有效（即运行时保留）， 可以被反射机制读取

示例代码

@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface myAnnotation02 {
    String value();
}

@Documented

• 注解是否应当被包含在 javadoc 文档中

@Inherited

• 是否允许子类继承该注解

---

5. 反射机制读取注解

• 注解信息处理流程，是注解和注释的重大区别。如果没有注解信息处理流程，则注解毫无意义。因此，我们需要学会怎样去解析注解。

ORM简介

ORM，即Object-Relational Mapping（对象关系映射），它的作用是在关系型数据库和业务实体对象之间作一个映射，这样，我们在具体的操作业务对象的时候，就不需要再去和复杂的SQL语句打交道，只需简单的操作对象的属性和方法。

• 类和表结构对应
• 属性和字段对应
• 对象和记录对应

---

使用反射读取注解——简单实现ORM

目的：使用注解完成类和表结构的映射关系

• 将Student类信息映射成为数据表

1、Student类信息

@myTable("tb_student")
public class Student {

    @myField(columnName = "id", type = "int", length = 10)
    private int id;
    @myField(columnName = "sname", type = "varchar", length = 10)
    private String studentName;
    @myField(columnName = "age", type = "int", length = 3)
    private int age;
}

2、自定义注解 - myTable

• 记录表名信息

@Target(value = {ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface myTable {
    String value();
}

3、自定义注解 - myField

• 记录表中元素的列名、类型、长度

@Target(value = {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface myField {
    String columnName();    // 列名
    String type();          // 类型
    int length();           // 长度
}

4、测试类

• 获得指定注解
• 获得类的所有属性的注解
• 根据获得的表名、字段的信息，拼出DDL语句，使用JDBC执行这个SQL，在数据库中生成相关的表

/**
 * 使用反射读取注解信息，模拟处理注解信息的流程
 */
public class AnnotationDemo {
    public static void main(String[] args) {
        try {
            Class clazz = Class.forName("cn.sxt.annotation_03.Student");

            // 获得指定注解
            myTable st = (myTable) clazz.getAnnotation(myTable.class);
            System.out.println(st.value());

            // 获得类的所有属性的注解
            Field[] fields = clazz.getDeclaredFields();
            for (Field field : fields) {
                myField  myfield = field.getAnnotation(myField.class);
                System.out.println(myfield.columnName()+" - "+myfield.type()+" - "+myfield.length());
            }

            // 拼出DDL语句，使用JDBC执行这个SQL，在数据库中生成相关的表

        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

打印结果

---

说明：这里简单介绍了什么是注解、内置注解和自定义注解。介于初学，内容较为浅显，后续学习过程中会进行补充。如有问题欢迎指教。