JAVA 注解与反射 笔记

注解与反射

1. 什么是注解(Annotation)

• Annotation是从JDK5.0开始引入的新技术
• Annotation的作用：
  • 可以对程序作出解释，这一点和注释comment类似
  • 对程序进行检查和约束，例如@Override
  • 可以被其他程序（比如：编译器等）读取

@Override //重写注解，若是重写的方法名写错会出现警告
@Deprecated //不推荐使用注解，可以使用但是又风险或者有更好的方式
@SuppressWarnings //取消所有警告

• Annotation的格式：
  • 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarning(value=”unchecked”)
• Annotation在哪里使用？
  • 可以附加在package、class、method、field等上面，相等于给他们添加了额外的辅助信息，然后结合反射机制实现对这些元数据的访问

2. 内置注解

• @Override：定义在java.lang包中，此注解只适用于修饰方法，表示该方法打算重写父类中的同名方法，并且具有检查作用

• @Deprecated：定义在java.lang包中，此注释可以修饰方法、属性、类，注释@Deprecated的程序元素是程序员不鼓励使用的程序元素，通常是因为它是危险的，或者因为它已经过时了，然后存在更好的替代方法，但是你使用也没有任何影响，使用案例如下：

• @SupressWarnings：定义在java.lang包中，用来抑制编译时产生的黄色警告信息，虽然这些警告信息不会影响编译结果，但是看着不舒服，然后该注释和前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，具体参数信息如下所示：
  @SuppressWarnings(“all”) // 压制所有警告，下面有例子：
  @SuppressWarnings(“unchecked”) // 压制"unchecked"警告
  @SuppressWarnings(value={“unchecked”, “deprecation”}) // 压制"unchecked", "deprecation"警告
  注意：public @interface SuppressWarnings {String[] value();}，其中value是参数名，而String[]是参数是类型，当注解只使用value这一个参数的时候，value可以省略，例如上面的@SuppressWarnings("all")和@SuppressWarnings("unchecked")就是省略了前面的value，但是仅限参数名是value，并且注解中只使用value这一个参数的情况才可以 省略value

3. 元注解

• 元注解作用：元注解是注解的注解，负责注解其他注解，Java中定义了4个标准的元注解类型，他们被用来对其他注解类型进行解释说明限制

• 元注解位置：在java.lang.annotation包中

• 元注解四大类型

  • @Target：用于描述注解的使用范围，也就是描述注解可以使用在什么地方。public @interface Target {ElementType[] value();}可以看出可以它是一个数组，可以有多个值，里面的值设置的都是定义的注解MyAnnotation的使用范围，比如在类上、方法上等等，你可以通过@Target，然后点击里面的ElementType去查看

  

  • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（SOURCE < CLASS < RUNTIME），最常用的就是RUNTIME
    • RetentionPolicy.SOURCE：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃
    • RetentionPolicy.CLASS：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期
    • RetentionPolicy.RUNTIME：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在

  

  • @Documented：说明该注解将被包含在Javadoc文档中

  • @Inherited：说明子类可以继承父类中的该注解

4. 自定义注解

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

• @interface 用来声明一个注解，格式是：

  修饰符 @interface 注解名{定义内容}
  

  • 内容中的每一个方法实际上是声明了一个配置参数，方法的名称就是参数的名称，方法的返回值类型就是参数的类型
  • 返回值类型只能是基本类型、Class、String、enum，如果返回值是String[]的时候，赋值的时候要用{“X1”, “X2”}这种形式；
  • 可以通过default来声明参数的默认值，声明默认值的可以不在自定义注解中赋值，反之必须赋值
  • 如果只有一个参数成员，一般参数名使用value字段，这是因为当参数名称是value并且自定义注解中只需要写一个参数的时候，可以省略参数名称，只有value可以这样，其他的都不行
  • 注解元素必须有值，我们定义注解元素时，经常使用空字符串、0、-1等作为默认值，当默认值为-1，代表不存在

package annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

//自定义注解
public class Test03 {
    @MyAnnotation02(name = "Hello") //可以显式赋值，如果没有默认值就必须赋值
    public void test() {

    }
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
@interface MyAnnotation02 {
    //注解的参数 ：参数类型 + 参数名();
    String name();
    int age() default 18;
    // 按照上面写法相当于加了默认值，在使用注解的时候可以不提供参数值
}

5. 反射

• Reflection(反射)是Java被视为动态语言的关键，反射机制允许程序在执行期间借助于Reflection API取得任何类的内部信息，并且能直接操作任意对象的内部属性以及方法
• 加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构，这个对象就像一面镜子，透过这个镜子可以看到类的结构，这就是反射

6. 获得反射对象

6.1 反射机制提供的功能

• 在运行时判断任意一个对象所属的类

• 在运行时构造任意一个类的对象

• 在运行时判断任意一个类所具有的成员变量和方法

• 在运行时获取泛型信息

• 在运行时调用任意一个对象的成员变量和方法

• 在运行时处理注解

• 生成动态代理

• ……

6.2 反射相关的主要API

• java.lang.Class：代表一个类，它就是Object类getClass()方法的返回值，它是唯一的所以类都指向它
• java.lang.reflect.Method：代表类的方法
• java.lang.reflect.Field：代表类的成员变量
• java.lang.reflect.Constructor：代表类的构造器

6.3 反射代码

package reflection;

//什么是反射
public class Test01 {
    public static void main(String[] args) throws ClassNotFoundException {
        //通过反射获取类的Class对象
        Class c1 = Class.forName("reflection.User");
        System.out.println(c1);

        Class c2 = Class.forName("reflection.User");
        System.out.println(c1.hashCode() == c2.hashCode()); //True
        // 一个类在内存中只有一个Class对象。一个类被加载后，类的整个结构都会被封装在Class对象中。
    }
}

//实体类(类中只有一些属性)
class User {
    private String name;
    private int id;
    private int age;

    public User() {
    }

    public User(String name, int id, int age) {
        this.name = name;
        this.id = id;
        this.age = age;
    }

    public String getName() {
        return name;
    }

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

    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;
    }

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

7. 获得Class类对象的几种方式

7.1 Class类

• Class本身也是一个类，不过这个类只有一个，所有的类都执行它，例如User类、Person类等
• Class对象是Class类的对象，一个加载的类(例如User.java)在JVM中只会有一个Class对象
• 一个Class对象对应的是一个加载到JVM中的对应的XXX.class文件
• 每个类(例如User.java)的实例(例如User u = new User()中的u)都会记着自己是由哪个Class对象所生成
• 通过Class对象可以完整地得到一个类(例如User.java)中所有被加载的信息
• Class类(只有一个，和Object类中getClass()方法中返回的Class是同一个)是Reflection的根源，针对任何你想动态加载、运行的类、唯有先获得类(例如User.java)对应的Class对象
• 以上说了四个部分：Class类、Class对象、类、类的实例，通过类可以创建类的实例，通过Class类可以获取某类的Class对象，通过某类的Class对象可以获取该类中的所有信息(方法、属性等等)，当然也可以创建该类的实例。另外Class对象是类具有的，类可以做的它也能做

7.2 Class类常用方法

方法名	说明
static Class forName(String name)	返回指定类名name对应的Class对象
Object newInstance()	调用缺省构造函数，返回Class对象的一个实例
String getName()	返回此Class对象所表示的实体（类、接口、数组类或者void）的名称
Class getSuperClass	返回当前Class对象的父类Class对象
Class[] getinterfaces()	获取当前Class对象的接口
ClassLoader getClassLoader()	返回该类的加载器
Constructor[] getConstructors()	返回一个包含某些Constructor对象的数组
Method getMothed(String name,Class… T)	返回一个Method对象，此对象形参类型为param Type
Field[] getDeclaredFields()	返回Field对象的一个数组

7.3 获取Class类对象

• 通过该类对象获得
• 通过forName(“全限定类名”)获得
• 通过类名.class获得

package reflection;

import java.util.Scanner;

//测试Class类的创建方式有哪些
public class Test02 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("我是" + person.name);

        //方式一：通过对象获得
        Class c1 = person.getClass();

        //方式二：forName
        Class c2 = Class.forName("reflection.Student");

        //方式三：通过类名.class
        Class c3 = Student.class;

        //获得父类的类型
        Class c4 = c1.getSuperclass();
    }
}
class Person{...}
class Student extends Person{...}

7.4 Class对象的作用

• 创建类的对象
• 调用类的方法
• 修改某个类对象的属性

8. 哪些类型有class对象

• class：外部类、成员（成员内部类、静态内部类），局部内部类，匿名内部类。
• interface：接口
• []：数组
• enum：枚举
• annotation：注解
• primitive type：基本数据类型
• void

public class Test {
    public static void main(String[] args) {
        Class c1= Object.class;//类
        Class c2= Runnable.class;//接口
        Class c3= String[].class;//一维数组
        Class c4= int[][].class; //二维数组
        Class c5=Override.class;//注解
        Class c6= ElementType.class;//枚举
        Class c7= Integer.class;//基本数据类型
        Class c8= void.class;//void
        Class c9= Class.class;//Class
    }
}

• 一些结论
  • 元素类型不同，Class对象不同，例如int[ ]、String[ ]
  • 元素类型相同，但是维度不同，Class对象不同，例如int[ ]和int[ ][ ]
  • 元素类型相同，维度相同，但是具体内容不同，Class对象相同，例如：int[10]和int[100]

9. 查看类加载器

package reflection;

public class Test03 {
    public static void main(String[] args) throws ClassNotFoundException {
        //获取系统类的加载器
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
        System.out.println(systemClassLoader);

        //获取系统类加载器的父类加载器-->扩展类加载器
        ClassLoader parent =systemClassLoader.getParent();
        System.out.println(parent);

        //获取扩展类加载器的父类加载器-->根加载器(c/c++)
        ClassLoader parent1=parent.getParent();
        System.out.println(parent1);

        //测试当前类是哪个类加载器加载的
        ClassLoader classLoader = Class.forName("reflection.Test03").getClassLoader();
        System.out.println(classLoader);

        //测试JDK内置的类是哪个类加载器加载的
        classLoader = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader);
    }
}

10. 获取类运行时结构(类的信息)

package reflection;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

//获得类的信息
public class Test04 {
    public static void main(String[] args) throws Exception {
        User user = new User();
        Class c1 = user.getClass();

        //获得名字
        System.out.println(c1.getName());   //获得包名 + 类名
        System.out.println(c1.getSimpleName()); //获得类名

        //获得类的属性
        Field[] fields = c1.getFields(); //只能找到public属性
        fields = c1.getDeclaredFields(); //能找到所有属性
        for(Field f : fields) System.out.println(f);

        //获得指定的属性
        Field name = c1.getDeclaredField("name");
        System.out.println(name);

        //获得指定的方法
        //获取指定方法必须说明参数，因为如果存在重载的情况，则无法判断需要获取哪一个方法
        Method getName = c1.getMethod("getName", null);
        System.out.println(getName);
        Method setName = c1.getMethod("setName", String.class);
        System.out.println(setName);

        //获得指定的构造器
        Constructor constructor = c1.getDeclaredConstructor(null); //无参构造器
        System.out.println(constructor);
    }
}

11. 通过反射创建对象

• 注意：其中setAccessible(true)方法调用后会关闭对应属性、方法的安全检查，但会改善反射调用的效率问题

package reflection;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

//通过反射动态创建对象
public class Test05 {
    public static void main(String[] args) throws Exception {
        //获得class对象
        Class c1 = Class.forName("reflection.User");

        //构造一个对象
        User user = (User) c1.getDeclaredConstructor().newInstance();
        System.out.println(user);

        //通过构造器创建对象
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        User user2 = (User) constructor.newInstance("Hello", 1, 18);
        System.out.println(user2);

        //通过反射获取并使用方法
        User user3 = (User) c1.getDeclaredConstructor().newInstance();
        Method setName = c1.getDeclaredMethod("setName", String.class);
        // invoke : (对象，"方法的值")
        setName.invoke(user3, "狂神");
        System.out.println(user3.getName());

        //通过反射操作属性
        User user4 = (User) c1.getDeclaredConstructor().newInstance();
        Field name = c1.getDeclaredField("name");
        name.setAccessible(true); //不能直接操作私有属性，需要先关闭private的访问权限
        name.set(user4, "狂神2");
        System.out.println(user4.getName());
    }
}

12. 获取泛型信息

• Java采用泛型擦除的机制来引入泛型，Java中的泛型仅仅是给编译器javac使用的，确保数据的安全性和免去强制类型转换的问题，但是，一旦编译完成，所有和泛型有关的类型全部擦除。
• 为了通过反射操作这些类型，Java新增了ParameterizedType，GenericArrayType，TypeVariable和WildcardType几种类型来代表不能被归一到Class类中的类型但是又和原始类型齐名的类型。

类型	说明
ParameterizedType	表示一种参数化类型，比如Collection< String >
GenericArrayType	表示一种元素类型是参数化类型或者类型变量的数组类型
TypeVariable	是各种类型变量的公共父接口
WildcardType	代表一种通配符类型表达式

package reflection;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.*;

//通过反射获取泛型
public class Test07 {
    public void test01(Map<String,Integer> map,List<Integer> list) {
        System.out.println("test01");
    }

    public Map<String,Integer> test02() {
        System.out.println("test02");
        return null;
    }

    public static void main(String[] args) throws Exception {
        Method method = Test07.class.getMethod("test01", Map.class, List.class);
        Type[] genericParameterTypes = method.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println("# " + genericParameterType);
            if(genericParameterType instanceof ParameterizedType) {
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }

        System.out.println("\n===========================\n");
        method = Test07.class.getMethod("test02");
        Type genericReturnType = method.getGenericReturnType();
        if(genericReturnType instanceof ParameterizedType) {
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}

13. 通过反射读取注解

• 注解和反射完成的是类和表结构的映射关系

package reflection;

import java.lang.annotation.*;
import java.lang.reflect.Field;

// 通过反射读取注解
public class Test08 {
    public static void main(String[] args) throws Exception {
        Class c1 = Class.forName("reflection.Person2");

        // 获取类注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        // 获得指定注解的value的值
        Tablekuang tk = (Tablekuang) c1.getAnnotation(Tablekuang.class);
        System.out.println(tk.value());

        //获得类属性指定的注解
        Field f = c1.getDeclaredField("name");
        Fieldkuang annotation = f.getAnnotation(Fieldkuang.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}


@Tablekuang(value = "db_person")
class Person2 {

    @Fieldkuang(columnName = "db_id", type = "int", length = 10)
    private int id;
    @Fieldkuang(columnName = "db_age", type = "int", length = 10)
    private int age;
    @Fieldkuang(columnName = "db_name", type = "varchar", length = 10)
    private String name;

    public Person2() {
    }

    public Person2(int id, int age, String name) {
        this.id = id;
        this.age = age;
        this.name = name;
    }

    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 "Person2{" +
                "id=" + id +
                ", age=" + age +
                ", name='" + name + '\'' +
                '}';
    }
}

//类名的注解
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface Tablekuang {
    String value();
}

//属性的注解
@Target({ElementType.FIELD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface Fieldkuang {
    String columnName();
    String type();
    int length();
}

14 总结

​ 学了这节课，主要就是对底层原理的了解，以及熟悉对注解、反射相应API的使用。学了该课程就知道，在后面的框架中，为啥只需要创建实体类就可以在Mysql数据库中创建相应的表格及数据，底层就是通过反射和注解来实现的。剩下的就是对API的使用了。总的来说，反射使得JAVA程序更加灵活了。