Java注解和反射

注解

概述

不是程序本身，可以对程序作出解释，可以被其他程序（如编译器等）读取

可以附加在package、class、method、field等上面，可以通过反射机制编程实现对这些元数据对访问

内置注解

@Override

只用修饰方法，表示一个方法声明打算重写超类中的另一个方法声明

@Deprecated

可以用于修饰方法，属性，类，表示不鼓励程序猿使用，但是还是可以使用的，只是使用它可能有危险或者存在更好的选择。

@SuppressWarnings

用来抑制编译时的警告信息，需要添加一个参数

元注解

@Target

用于描述注解的使用范围

@Target(value = {ElementType.METHOD, ElementType.TYPE})

@Retention

表示需要在什么级别保存该注释信息（SOURCE > CLASS > RUNTIME）

@Retention(value = RetentionPolicy.RUNTIME)

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

@Inherited

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

自定义注解

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

@interface用来声明一个注解，格式: public @interface 注解名 { 定义内容 }

其中的每一个方法实际上是声明了一个配置参数，方法的名称就是参数的名称返回值类型就是参数的类型(返回值只能是基本类型, Class, String, enum)

可以通过 default来声明参数的默认值

如果只有一个参数成员,一般参数名为 value 注解元素必须要有值，我们定义注解元素时，经常使用空字符串和0作为默认值

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    // 方法名为参数名
    String name() default "";
    int age() default 0;
    int id() default -1; // 如果默认值为-1, 代表不存在
    String[] schools() default {"西部开源", "东部闭源"};
}

反射

概述

Java不是动态语言，但是可以通过反射机制获得类似动态语言的特性。

Reflection（反射）允许程序在执行期间借助 Reflection API 取得任何类的内部信息，并能直接操作任意对象的内部属性及方法。

加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。

Java反射机制提供的功能

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

优点：可以实现动态创建对象和编译，体现出很大的灵活性

缺点：对性能有影响。使用反射是让JVM执行我们命令的操作，这类操作总是慢于直接执行相同的操作。

Class类

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

得到Class的几种办法

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

// 方式二：通过forName获得
Class c2 = Class.forName("com.ccqstark.reflection.Person");
System.out.println(c2.hashCode());

// 方法三：通过类名.class获得
Class c3 = Student.class;
System.out.println(c3.hashCode());

// 方法四：基本内置类型的包装类都有一个Type属性
Class c4 = Integer.TYPE;
System.out.println(c4);

// 获得父类类型
Class c5 =  c1.getSuperclass();
System.out.println(c5);

有Class对象的类型

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

类加载器的作用

类加载的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。

类缓存：标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，它将维持加载（缓存）一段时间。不过JVM垃圾回收机制可以回收这些Class对象。

三种类加载器：

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

示例代码：

// 获取系统的类加载器
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("com.ccqstark.reflection.Test07").getClassLoader();
System.out.println(classLoader);

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

// 获得系统类加载器可以加载的路径
System.out.println(System.getProperty("java.class.path"));

获得运行时类的完整结构

上代码：

Class c1 = Class.forName("com.ccqstark.reflection.User");

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

// 获得类的属性
System.out.println("========================");
Field[] fields = c1.getFields(); // 只能找到public属性

fields = c1.getDeclaredFields(); // 找到全部的属性
for (Field field : fields) {
    System.out.println(field);
}

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

// 获得方法
System.out.println("=========================");
Method[] methods = c1.getMethods(); // 获得本类及其父类的全部public方法
for (Method method : methods) {
    System.out.println("父类以及公有的：" + method);
}
methods = c1.getDeclaredMethods(); // 获得本类的所有方法
for (Method method : methods) {
    System.out.println("本类所有的方法：" + method);
}

// 获得指定的方法
Method getName = c1.getMethod("getName", null);
Method setName = c1.getMethod("setName", String.class);
System.out.println(getName);
System.out.println(setName);

// 获得指定的构造器
System.out.println("==========================");
Constructor[] constructors = c1.getConstructors(); // 获得公有的
for (Constructor constructor : constructors) {
    System.out.println(constructor);
}
constructors =  c1.getDeclaredConstructors(); // 获取全部
for (Constructor constructor : constructors) {
    System.out.println("#" + constructor);
}

// 获得指定的构造器
Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
System.out.println("指定：" + declaredConstructor);

通过反射动态创建对象

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

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

也可以通过调用有参构造器：

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

示例代码：

// 获得Class对象
Class c1 = Class.forName("com.ccqstark.reflection.User");

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

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

通过反射调用指定的方法

通过反射，调用类中的方法，通过Method类完成

通过Class类的getMethod(String name, Class...parameterTypes)方法取得一个Method对象，并设置此方法操作时所需的参类型。
之后使用Object invoke(Object obj, Object[] args)进行调用，并向方法中传递要调用此方法的obj对象以及方法的参数

示例代码：

// 通过反射调用普通方法
User user3 = (User) c1.newInstance();
// 通过反射获取一个方法
Method setName = c1.getDeclaredMethod("setName", String.class);

// invoke(对象, "方法的参数")
setName.invoke(user3, "ccq");
System.out.println(user3.getName());

Object invoke(Object obj, Object… args)

Object对应原方法的返回值，若原方法无返回值，此时返回null
若原方法若为静态方法，此时形参Object obj可为null
若原方法的形参列表为空，则Object[] args为null
若原方法声明为private，则需要在调用此invoke()方法前，显示调用方法对象的setAccessible(true)方法，将可访问private的方法。

setAccessible

Method和 Field、 Constructor 对象都有 setaccessible()方法
setAccessible作用是启动和禁用访问安全检查的开关。
参数值为true则指示反射的对象在使用时应该取消Java语言访问检查。
- 提高反射的效率。如果代码中必须用反射，而该句代码需要频繁的被调用，最好设置为true
- 使得原本无法访问的私有成员也可以访问
参数值为false则指示反射的对象应该实施Java语言访问检查

反射操作泛型

public void test01(Map<String, User> map, List<User> list) {
    System.out.println("test01");
}

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

public static void main(String[] args) throws NoSuchMethodException {
    Method method = Test11.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);
            }
        }
    }

    method = Test11.class.getMethod("test02", null);
    // 获得泛型返回类型
    Type genericReturnType = method.getGenericReturnType();

    if (genericReturnType instanceof ParameterizedType) {
        Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
        for (Type actualTypeArgument : actualTypeArguments) {
            System.out.println(actualTypeArgument);
        }
    }

}

通过反射操作注解

通过反射操作注解来实现一些功能就是很多框架的原理了，像Spring、MyBatis中的注解底层就是通过反射来获得一些信息并进行一些操作来达成某些功能的。

例如下面的实现ORM的示例，通过自定义注解让用户使用，让用户定义类名对应的表名，属性名对应的字段名，然后通过反射获取这些信息，就可以生成对应的SQL了。

// 反射操作注解
public class Test12 {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.ccqstark.reflection.Student2");

        // 通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        // 获得注解的value值，这里通过反射获得了映射表名的注解的值，也就是获得了表名
        TableCcq tableCcq = (TableCcq) c1.getAnnotation(TableCcq.class);
        String value = tableCcq.value();
        System.out.println(value);

        // 通过反射操作field的注解，获得了属性映射的表字段的信息，如字段名、类型、长度
        Field f = c1.getDeclaredField("name");
        FieldCcq annotation = f.getAnnotation(FieldCcq.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());

    }
}

@TableCcq("db_ccq")
class Student2 {

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

}

// 类名->表名 的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableCcq {
    String value();
}

// 属性->字段 的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldCcq {
    String columnName();

    String type();

    int length();
}