Java注解和反射

1、注解

1.1、什么是注解

• Annotation是从JDK5.0开始引入的新技术
• Annotation的作用：
  1. 不是程序本身，可以对程序做出解释
  2. 可以被其他程序（比如：编译器）读取
• Anntation格式
  1. 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value=“unchecked”).
• Annotation在那里使用？
  1. 可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

1.2、内置注解

• @Override：定义在java.lang.Override中，此注释只适用于修辞方法，便是一个方法声名打算重写超类中的另一个方法声名。
• @Deprecated：定义在java.lang.Deprecated中，此注释可以用于修辞方法，属性，类，标识不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择
• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息，与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性地使用就好了，
  • @SuppressWarnings(“all”)
  • @SuppressWarnings(“aunchecked”)
  • @SuppressWarnings(value=“unchecked”,“deprecation”)
  • 等等… …

1.3、元注解

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

• 这些类型和他们所支持的类在java.lang.annotation包中可以找到。（@Target，@Retention，@Documented，@Inherited）

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

  • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（SOURCE<CLASS<RUNTIME）

  • @Documented：说明该注解将被包含在javadoc中

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

//@Target表示我们的注解可以用在什么地方，
// ElementType.METHOD  方法上
// ElementType.TYPE    类上
// ElementType.FIELD   变量上
@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.FIELD})
//@Retention表示我们的注解在什么地方有效
//RetentionPolicy.SOURCE  源码有效
//RetentionPolicy.CLASS   class有效
//RetentionPolicy.RUNTIME 程序运行有效
@Retention(value = RetentionPolicy.RUNTIME)
//@Documented表示是否将我们的注解生成在Javadoc中
@Documented
//@Inherited表示再累可以继承父类的注解
@Inherited
@interface MyAnnotation{
    
}

1.4、自定义注解

• 使用@interface自定义注解时，自动继承了java.lang.Annotation接口
• 分析：
  • @interface用来声明一个注解，格式：public @interface 注解名{定义内容}
  • 其中的每一个方法实际上时声明了一个配置参数
  • 方法的名称就是参数的名称
  • 返回值类型就是参数的类型（返回值只能是基本类型，Class，String，enum）
  • 可以通过default来声明参数的默认值
  • 如果只有一个参数成员，一般参数名为value
  • 注解元素必须要有值我们定义注解元素时，经常使用空字符串，0作为默认值。

public class Test01{
    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation1(name="张三",schools = "清华大学")
    public void test1(){

    }
    @MyAnnotation2("张三")
    public void test2(){

    }
}
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation1{
    //注解的参数：参数类型 参数名()
    String name() default "";
    int age() default 0;
    int id() default -1; //如果默认值为-1，代表不存在
    String [] schools();
}
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解只有一个值，并且定义为value引用时可以省略value，例如：@MyAnnotation2("张三")
    // 若为其他的，则不能省略 例如：@MyAnnotation2(name="张三")
    String value();
}

2、反射

2.1、静态语言和动态语言

• 动态语言：是一类在运行时可以改变其结构的语言：例如性的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据条件改变自身结构。主要的动态语言：Object-C、C#、JavaScript、PHP、Python等。

• 静态语言：与动态语言相对应的，运行时结构不可变的语言就是静态语言。如：Java、C、C++。Java不是动态语言，但Java可以称之为”准动态语言“。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活！

2.2、Java Reflection

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

2.3、Java反射机制研究及应用

Java反射机制提供的功能

• 在运行时判断任意一个对象所属的类
• 在运行时构造任意一个类的对象
• 在运行时判断任意一个类所具有的成员变量和方法
• 在运行时获取泛型信息
• 在运行时调用任意一个对象的成员变量和方法
• 在运行时处理注解
• 生成动态代理
• … …

Java反射的优点和缺点

• 优点：可以实现动态创建对象和编译，体现出很大的灵活性
• 缺点：对性能的影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

反射相关的主要API

• java.lang.Class 代表一个类
• java.lang.reflect.Method 代表类的方法
• java.lang.reflect.Field 代表类的成员变量
• java.lang.reflect.Constructor 代表类的构造器
• … …

Class类

在Object类中定义了以下方法，此方法将被所有的子类继承

public final Class getClass()

以上的方法返回值的类型是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解，即：可以通过对象反射求出类的名称。

对象镜子后可以得到的信息：某个类的属性、方法和构造器、某个类到底实现了哪些接口。对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构(这些类型有Class对象：class/interface/enum/annotation/primitive typ/void/[])的有关信息

• Class本身也是一个类
• Class对象只能由系统建立对象
• 一个加载的类在JVM中只会有一个Class实例
• 一个Class对象对应的是一个加载到JVM中的一个.class文件
• 每个类的实例都会记得自己是有哪一个Class实例所生成
• 通过Class可以完整的得到一个类中的所有被加载的结构
• Class类是Reflection的根源，针对任何你想动态加载、运行的类，唯有先获得相应的Class对象
  Class类的常用方法

​ 1getName()：返回String形式的该类的名称。
　　2 newInstance()：根据某个Class对象产生其对应类的实例，它调用的是此类的默认构造方法(没有默认无参构造器会报错)
　　3 getClassLoader()：返回该Class对象对应的类的类加载器。
　　4 getSuperClass()：返回某子类所对应的直接父类所对应的Class对象
　　5 isArray()：判定此Class对象所对应的是否是一个数组对象
　　6 getComponentType() ：如果当前类表示一个数组，则返回表示该数组组件的 Class 对象，否则返回 null。
　　7 getConstructor(Class[]) :返回当前 Class 对象表示的类的指定的公有构造子对象。
　　8 getConstructors() :返回当前 Class 对象表示的类的所有公有构造子对象数组。
　　9 getDeclaredConstructor(Class[]) :返回当前 Class 对象表示的类的指定已说明的一个构造子对象。
　　10 getDeclaredConstructors() :返回当前 Class 对象表示的类的所有已说明的构造子对象数组。
　　11 getDeclaredField(String) :返回当前 Class 对象表示的类或接口的指定已说明的一个域对象。
　　12 getDeclaredFields() :返回当前 Class 对象表示的类或接口的所有已说明的域对象数组。
　　13 getDeclaredMethod(String, Class[]) :返回当前 Class 对象表示的类或接口的指定已说明的一个方法对象。
　　14 getDeclaredMethods() :返回 Class 对象表示的类或接口的所有已说明的方法数组。
　　15 getField(String) :返回当前 Class 对象表示的类或接口的指定的公有成员域对象。
　　16 getFields() :返回当前 Class 对象表示的类或接口的所有可访问的公有域对象数组。
　　17 getInterfaces() :返回当前对象表示的类或接口实现的接口。
　　18 getMethod(String, Class[]) :返回当前 Class 对象表示的类或接口的指定的公有成员方法对象。
　　19 getMethods() :返回当前 Class 对象表示的类或接口的所有公有成员方法对象数组，包括已声明的和从父类继承的方法。
　　20 isInstance(Object) :此方法是 Java 语言 instanceof 操作的动态等价方法。
　　21 isInterface() :判定指定的 Class 对象是否表示一个接口类型
　　22 isPrimitive() :判定指定的 Class 对象是否表示一个 Java 的基类型。
　　23 newInstance() ：创建类的新实例

获取Class类的实例

• 若已知具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高

Class c =Person.class;

• 已知某个类的实例，调用该实例的getClass()方法获取Class对象

Class c=person.getClass();

• 已知一个类的全类名，且该类在类路径下可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException

Class c= Class.forName("com.zhang.User");

• 内置基本数据类型可以直接使用类名.Type
• 还可以利用ClassLoader之后讲

哪些类型可以有Class对象？

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

public static void main(String[] args) throws ClassNotFoundException {
        Class c1=Object.class; //类
        Class c2=Comparable.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
        System.out.println(c1);
        System.out.println(c2);
        System.out.println(c3);
        System.out.println(c4);
        System.out.println(c5);
        System.out.println(c6);
        System.out.println(c7);
        System.out.println(c8);
        System.out.println(c9);

    }

静态代码块输出与顺序有关

class A{
    static int m=100;
    static{
        System.out.println("1");
        m=300;
    }
    public A(){
        System.out.println("2");
    }
}
//输出
1
2
300
    class A{
    static int m=100;
    static{
        System.out.println("1");
        m=300;
    }
    public A(){
        System.out.println("2");
    }
}
//输出：
1
2
100

什么时候会发生类初始化？

• 类的主动引用
  • 当虚拟机启动时，先初始化main方法所在的类
  • new一个类的对象
  • 调用类的静态成员（除final常量）和静态方法
  • 使用java.lang.reflect报的方法对类进行反射调用
  • 当初始化一个类，如果其父类没有被初始化，则会先初始化它的父类
• 类的被动引用（不会发生类的初始化）
  • 当访问一个静态域时，只有真正声名这个域的类才会被初始化。如，当通过子类引用父类的静态变量，不会导致子类初始化
  • 通过数组定义类引用，不会触发此类的初始化
  • 引用常量不会触发此类的初始化（常量在链接阶段就存入调用类的常量池中了）

类加载器的作用

• 类加载的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中数据的访问入口
• 类缓存：标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，他将维持加载（缓存）一段时间。不过，JVM垃圾回收机制了一会受这些Class对象。

类加载器作用是用来把类（class）装载进内存的。JVM规范定义了如下类型的类加载器：

• 引导类加载器（根加载器）：用C++编写，是JVM自带的类加载器，负责java平台核心库，用来装载核心库。该加载器无法直接获取
• 扩展类加载器：负责jre/lib/ext目录下的jar包或-D java.ext.dirs 指定目录下的jar包装入工作库
• 系统类加载器：负责java -classpath或-D java.class.path所指的目录下的类与jar包装入工作，是最常用的加载器。
  

获取运行时类的完整结构

通过反射获取运行时类的完整结构

Field、Method、Constructor、Superclass、Interface、Annotation

• 实现的全部接口
• 所继承的父类
• 全部的构造器
• 全部的方法
• 全部的Field
• 注解
• … …

package com.zhang.annotation;

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

public class Test01{
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c = Class.forName("com.zhang.annotation.User");
        //获得类的名字
        System.out.println(c.getName());  //获得包名+类名
        System.out.println(c.getSimpleName()); //获得类名

        //获得类的属性
        System.out.println("===================");
        Field[] fields = c.getFields();  //只能找到public属性
        for (Field field:fields) {
            System.out.println(field);
        }
        System.out.println("===================");
        Field[] declaredFields = c.getDeclaredFields();  //能找到全部的属性
        for (Field field:declaredFields) {
            System.out.println(field);
        }
        System.out.println("===================");
        //获得指定属性的值
        System.out.println(c.getDeclaredField("name"));
        System.out.println("===================");
        //获得类的方法
        Method[] methods = c.getMethods();  //获得本类及其父类的全部方法，不能获取私有的
        for (Method method : methods) {
            System.out.println(method);
        }
        System.out.println("===================");
        Method[] declaredMethods = c.getDeclaredMethods(); //获得本类的全部方法
        for (Method declaredMethod : declaredMethods) {
            System.out.println(declaredMethod);
        }
        System.out.println("===================");
        //获得指定的方法
        Method getName = c.getMethod("getName", null);
        Method setName = c.getMethod("setName", String.class);
        System.out.println(getName);
        System.out.println(setName);
        System.out.println("===================");
        //获得全部的构造器
        Constructor[] constructors = c.getConstructors(); //获得public
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
        System.out.println("===================");
        Constructor[] declaredConstructors = c.getDeclaredConstructors(); //获得所有
        for (Constructor declaredConstructor : declaredConstructors) {
            System.out.println(declaredConstructor);
        }
        System.out.println("===================");
        //获取指定的构造器啊
        Constructor declaredConstructor = c.getDeclaredConstructor(String.class, int.class, int.class);
        System.out.println(declaredConstructor);
    }
}
class User{
    private String name;
    private int age;
    public int sex;
    public User(){

    }

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

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

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

    public int getSex() {
        return sex;
    }

    public void setSex(int sex) {
        this.sex = sex;
    }

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

2.4、有了Class对象能做什么？

• 创建类的对象：调用Class对象的newInstance()方法

  • 类必须有一个无参数的构造器
  • 类的构造器的访问权限需要足够

• 思考？难道没有无参构造器就不能创建对象了吗》只要在操作的时候明确的调用类中的构造器，并肩那个参数传递进去之后，才可以实例化操作

• 步骤如下：

  • 通过Class类的getDeclaredConstructor(Class … parameterTypes)取得本类的指定形参类型的构造器
  • 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数
  • 通过Constructor实例化对象

public class Test01{
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InstantiationException, InvocationTargetException, NoSuchFieldException {
        Class c=Class.forName("com.zhang.annotation.User");
        User user=(User)c.newInstance(); //本质是调用了类的无参构造器
        System.out.println(user);
        //通过构造器传递对象
        Constructor declaredConstructor = c.getDeclaredConstructor(String.class, int.class, int.class);
        User user1 = (User) declaredConstructor.newInstance("张三", 18, 1);
        System.out.println(user1);

        //通过反射调用普通方法
        User user2=(User)c.newInstance(); //本质是调用了类的无参构造器
        //通过反射获取一个方法
        Method setName = c.getDeclaredMethod("setName", String.class);
        //invoke 激活
        //（对象，“”方法的值）
        setName.invoke(user2,"李四");
        System.out.println(user2.getName());

        //通过反射操作属性
        User user3=(User)c.newInstance(); //本质是调用了类的无参构造器
        Field name = c.getDeclaredField("name");
        //不能直接操作私有属性，我们需要关闭程序的安全检测 属性或者方法.setAccessible(true);
        name.setAccessible(true);
        name.set(user3,"王五");
        System.out.println(user3.getName());
    }
}
class User{
    private String name;
    private int age;
    public int sex;
    public User(){

    }

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

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

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

    public int getSex() {
        return sex;
    }

    public void setSex(int sex) {
        this.sex = sex;
    }

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

2.5、反射操作泛型

• Java采用泛型擦除的机制来引入泛型，Java中的泛型仅仅是给编译器javac使用的，确保数据的安全性和免去强制类型转换问题，但是，一旦编译完成，所有和泛型有关的类型全部擦除
• 为了通过反射操作这些类型，Java新增了ParameterizedType，GenericArrayType，TypeVariable和WildcardType几种类型来代表不能被归一到Class类中的类型但是又和原始类型齐名的类型
• ParameterizedType：表示一种参数化类型：比如：Collection
• GenericArrayType：表示一种元素化类型是参数化类型或者类型变量的数组类型
• TypeVariable：是各种类型变量的公共父接口
• WildcardType：代表一种通配符类型表达式

package com.zhang.annotation;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.*;
public class Test01{
    public void test01(Map<String,User>map,List<User> list){
        System.out.println("test01");
    }
    public Map<String,User> test02(){
        return null;
    }
    public static void main(String[] args) throws NoSuchMethodException {
        Method test01 = Test01.class.getMethod("test01", Map.class, List.class);
        Type[] genericParameterTypes = test01.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);
                }
            }
        }
         Method test02 = Test01.class.getMethod("test02", null);
        Type genericReturnType = test02.getGenericReturnType();
        if(genericReturnType instanceof ParameterizedType){
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}
class User{
    private String name;
    private int age;
    public int sex;
    public User(){

    }

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

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

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

    public int getSex() {
        return sex;
    }

    public void setSex(int sex) {
        this.sex = sex;
    }

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

public class Test02 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c = Class.forName("com.zhang.annotation.Student");
        //通过反射或的注解
        Annotation[] annotations = c.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }
        //获得注解的Value的值
        TableZhang tableZhang = (TableZhang)c.getAnnotation(TableZhang.class);
        System.out.println(tableZhang.value());

        //获得类指定的注解
        Field name = c.getDeclaredField("name");
        FieldZhang annotation = name.getAnnotation(FieldZhang.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}
@TableZhang("db_student")
class Student{
    @FieldZhang(columnName = "db_id",type = "int",length = 10)
    int id;
    @FieldZhang(columnName = "db_age",type = "int",length = 10)
    int age;
    @FieldZhang(columnName = "db_name",type = "varchar",length = 10)
    String name;
    public Student(){

    }

    public Student(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 "Student{" +
                "id=" + id +
                ", age=" + age +
                ", name='" + name + '\'' +
                '}';
    }
}
//类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableZhang{
    String value();
}
//属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldZhang{
    String columnName();
    String type();
    int length();
}