注解和反射

注解和反射

1.注解（annotation）

(1).什么是注解？

1. jdk5.0引入的新技术
2. 不是程序本身，可以对程序做出解释（同comment），可以被其他程序（比如：编译器等）读取
3. 注解以：“@注释名”在代码中存在，还可以添加一些参数值，例如：@SupperWarnings(valu="unchecked").
4. 注解可以附加在package，class，method，filed上，等于给他们附加了额外的辅助信息，可以利用反射机制编程实现对这些元数据的访问。

package com.thj.annotation;

// 什么是注解
public class Test01 extends Object{

    // @Override    重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
}

(2).内置注解

1. @Override:重写注解，只适用于修辞方法
2. @Deprecated:不鼓励程序员使用该方法
3. @SupperWarnings:抑制编译时的警告信息，需要参数，定义好的参数
   • "all"
   • "unchecked"
   • (value={"unchecked","deprecation"})
   • 等等......

package com.thj.annotation;

import java.util.ArrayList;
import java.util.List;

// 什么是注解
public class Test01 extends Object{

    // @Override    重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
    // 不推荐使用的方法
    @Deprecated
    public void test(){
        System.out.println("Deprecated");
    }

    @SuppressWarnings("all")
    public void test02(){
        List list = new ArrayList();
    }
    
    public static void main(String[] args) {
        Test01 test01 = new Test01();
        test01.test();
    }
}

(3).元注解

• 元注解负责注解其它注解，java定义了四个标志的元注解类型。
• (@Target,@Retention,@Documented,@Inherited)
  • @Target:用于描述注解的使用范围
  • @Retention:表示需要在什么级别保存该注释信息，用于描述注解的生命周期。
  • @Document:说明该注解将被包含在javadoc中
  • @Inherited:说明子类可以继承父类中的该注解

package com.thj.annotation;
import java.lang.annotation.*;

// 测试元注解
@MyAnnotation
public class Test02 {

    @MyAnnotation
    public void test(){

    }
}

// 定义一个注解
// Target 表示我们的注解可以用在那些地方。
@Target(value = {ElementType.METHOD,ElementType.TYPE})
// Retention表示我们注解在哪里有效
// runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)
// Document 表示是否把注解生成到JavaDoc中
@Documented
// Inherited 子类可以继承父类的注解
@Inherited    
@interface MyAnnotation{

}

(4).自定义注解

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

分析：

• @interface用来声明一个注解，格式：public @interface注解名
• 其中的每个方法其实是声明了一个配置参数
• 方法的名称就是参数的名称
• 返回值类型就是参数的类型（只能是基本类型：Class，String，enum）
• 可以通过default来声明参数的默认值
• 如果只有一个参数成员，一般参数名为value
• 注解元素必须有值，我们定义注解，常用空字符串，0来作为默认值。

package com.thj.annotation;

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

// 自定义注解
public class Test03 {
    // 注解可以显示赋值，如果没有默认解，必须给注解赋值
    @MyAnnotation2(name = "thj")
    public void test(){}

    // value可以省略
    @MyAnnotation3("thj")
    public void test2(){}
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    // 注解的参数： 参数类型+参数名()
    String name() default "";
    int age() default 0;
    int id() default -1;    // 如果默认值为-1，代表不存在.indexof，如果找不到返回-1

    String[] school() default {"信阳学院"};
}

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

反射机制

(1).概括

静态VS动态语言：

动态语言：

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

静态语言：

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

Java Reflection

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

Java反射的优缺点：

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

缺点：对性能有影响。慢。

package com.thj.reflection;

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

        Class C2 = Class.forName("com.thj.reflection.User");
        Class C3 = Class.forName("com.thj.reflection.User");
        Class C4 = Class.forName("com.thj.reflection.User");
        // 一个类在内存中只有一个Class对象
        // 一个类被加载后，类的整个结构都会被封装在Class对象中。

        System.out.println(C2.hashCode());
        System.out.println(C3.hashCode());
        System.out.println(C4.hashCode());
    }
}

// 实体类:pojo/entity
class User{
    private String name;
    private int age;
    private int id;

    public User() {
    }

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

    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 getId() {
        return id;
    }

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

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

(2).Class类

可以得到：某个类的属性，方法和构造器，某个类到底实现了那个接口。

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

获取Class类的实例：

• 若已知具体的类，通过class属性获取：Class clazz = Person.class;
• 已知某个类的实例，调用该实例的getClass()方法获取：Class clazz = person.getClass();
• 已知一个类的全类名，且该类在类路径下，可以通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException：Class clazz = Class.forName("path");
• 内置基本数据类型可以直接用类名.Type
• 还可以利用ClassLoader我们之后讲解

package com.thj.reflection;

// 测试类的创建方式有那些
public class Test03 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("这个人是："+person.name);

        // 方式一：通过对象获得
        Class c1 = person.getClass();
        System.out.println(c1.hashCode());
        // 方式二：通过路径获得
        Class c2 = Class.forName("com.thj.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 Person{
    public String name;

    public Person(){

    }
    public Person(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}

class Student extends Person{
    public Student(){
        this.name = "学生";
    }
}

class Teacher extends Person {
    public Teacher() {
        this.name = "老师";
    }
}

(3).那些类型可以有Class对象

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

package com.thj.reflection;

import java.lang.annotation.ElementType;

// 所有类型的Class
public class Test04 {
    public static void main(String[] args) {
        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。
    }
}

(4).类内存分析

package com.thj.reflection;

public class Test05 {
    public static void main(String[] args) {
        A a = new A();
        System.out.println(a.m);
        /*
        1.加载到内存，产生一个类对应Class对象
        2.链接，链接结束后 m=0
        3.初始化：
            <clinit>(){
                sout;
                m=300;
                m=100;
            }
         */
    }
}

class A{

    static {
        System.out.println("A类静态代码块初始化");
        m = 300;
    }
    static int m = 100;

    public A(){
        System.out.println("A类的无参构造器初始化");
    }
}

(5).什么时候会发生类的初始化

• 类的主动引用（一定会发生类的初始化）
  • 当虚拟机启动，先初始化main方法在的类
  • new一个类的对象
  • 调用类的静态成员和静态方法
  • 使用java.lang.reflect方法进行反射调用
• 类的被动引用(不会发生类的初始化)
  • 引用常量
  • 不声明，如：子类引用父类的静态变量等
  • 通过数组定义类引用

package com.thj.reflection;

// 测试类什么时候会初始化
public class Test06 {
    static {
        System.out.println("main类被加载");
    }

    public static void main(String[] args) throws ClassNotFoundException {
        // 主动引用
        // Son son = new Son();

        // 反射也会产生主动引用
        // Class.forName("com.thj.reflection.Son");

        // 不会产生类的引用的方法
        // System.out.println(Son.b);

        // Son[] array = new Son[5];
        System.out.println(Son.M);
    }
}

class Father{
    static int b = 2;
    static {
        System.out.println("父类被加载");
    }
}

class Son extends Father{
    static {
        System.out.println("子类被加载");
        m = 300;
    }
    static int m = 100;
    static final int M = 1;
}

(6).类加载器的作用

• 类加载的作用：将class字节码内容加载到内存中，把静态数据换成方法区的运行时数据结构，然后在堆中生成Class对象，作为类数据的访问入口
• 类缓存：一个类被加载到类加载器中，会维持一段时间。不过JVM可以回收这些Class对象。

package com.thj.reflection;

public class Test07 {
    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("com.thj.reflection.Test07").getClassLoader();
        System.out.println(classLoader);

        // 测试jdk内置的类由那个加载器加载
        ClassLoader classLoader1 = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader1);

        // 如何获取系统类加载器可以加载的路径

        System.out.println(System.getProperty("java.class.path"));

        // 双亲委派机制
            // 保证安全性，层层检测
    }
}

(7).创建运行时类的对象

package com.thj.reflection;

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

// 获得类的信息
public class Test08 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c1 = Class.forName("com.thj.reflection.User");


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

        // 2.获得类的属性
        // getFileds()  只能获得public属性
        Field[] field = c1.getDeclaredFields(); // 找到全部的属性
        for (Field field1 : field) {
            System.out.println(field1);
        }

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

        System.out.println("===============================");
        // 4.获得类的方法
        Method[] methods = c1.getMethods(); // 获得本类和父类的所有public方法
        for (Method method : methods) {
            System.out.println(method);
        }
        Method[] declaredMethods = c1.getDeclaredMethods(); // 获得本类的所有方法
        for (Method declaredMethod : declaredMethods) {
            System.out.println(declaredMethod);
        }

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

        // 6.获得指定构造器
        Constructor[] constructors = c1.getConstructors(); // public
        Constructor[] constructors1 = c1.getDeclaredConstructors(); // 全部
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
        for (Constructor constructor : constructors1) {
            System.out.println(constructor);
        }

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

小结：

• 在实际操作中，获得类的信息的操作代码，并不会经常开发。
• 一定要熟悉java.lang.reflect包的作用，反射机制
• 如何获取属性，方法，构造器的名称，修饰符等等

(8).有了Class对象

• 创建类的对象：通过Class对象的newInstance()方法
  • 类必须有一个无参构造器
  • 类的构造器的访问权限需要足够
• 可以通过构造器

package com.thj.reflection;

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

// 动态的创建对象，通过反射
public class Test09 {
    public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        Class c1 = Class.forName("com.thj.reflection.User");    // 获得Class对象

        // 构造一个对象
        // User user = (User)c1.newInstance(); // 本质上时调用了类的无参构造器
        // System.out.println(user);

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

        // 通过反射调用方法
        User user = (User)c1.newInstance();
        // 通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        // invoke ：激活
        // (对象， “方法的值”)
        setName.invoke(user,"狂神");
        System.out.println(user.getName());

        // 通过反射操作属性
        User user1 = (User) c1.newInstance();
        Field name = c1.getDeclaredField("name");

        // 不能直接操作私有属性，必须关闭程序的安全检测，通过属性或者方法的setAccessible(true)。
        name.setAccessible(true);
        name.set(user1,"狂神2");
        System.out.println(user1.getName());
        /*
        每个method，Filed，Constructor对象都有setAccessible()方法
        作用是启动或禁用访问安全检测的开关
         */
    }
}

(9).性能问题分析

package com.thj.reflection;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

// 分析性能问题
public class Test10 {

    // 普通方式调用
    public static void test01(){
        User user = new User();

        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {
            user.getName();
        }

        long endTime = System.currentTimeMillis();

        System.out.println("普通方式执行10亿次："+(endTime-startTime)+"ms");

    }

    // 反射方式调用
    public static void test02() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();

        Method getName = c1.getDeclaredMethod("getName", null);
        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }

        long endTime = System.currentTimeMillis();

        System.out.println("反射方式执行10亿次："+(endTime-startTime)+"ms");

    }

    // 反射方式调用，关闭检测
    public static void test03() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();

        Method getName = c1.getDeclaredMethod("getName", null);
        getName.setAccessible(true);
        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }

        long endTime = System.currentTimeMillis();

        System.out.println("关闭检测，反射方式执行10亿次："+(endTime-startTime)+"ms");

    }

    public static void main(String[] args) throws InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        test01();
        test02();
        test03();
    }
}

通过程序运行时间可以看到，普通方法执行之快，通过反射执行方法将速度变慢了许多，但是，关闭安全检测可以提高一些运行速度。

(10).反射操作泛型

• java采用泛型擦除的机制来引入泛型，一旦编译完成，就会把和泛型有关的内容全部擦除。
• 为了通过反射操作这些泛型，Java新增了几个类，ParameterizedType，GenericArrayType，TypeVariable和WildcardType这几个类。
• ParameterrizedType：表示一种参数化类型，比如Collection<string>
• GenericArrayType:表示一种元素类型是参数类型或者类型变量的数组类型
• TypeVariable：是各类型变量给公共父接口
• WildcardType：代表一种通配符类型表达式

package com.thj.reflection;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Map;
import java.util.List;

// 通过反射获取泛型
public class Test11 {

    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 test01 = Test11.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 = Test11.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);
            }
        }
    }

}

(11).反射操作注解

• getAnnotations
• getAnnotation

注解挺重要的，尤其在框架的运用上。

package com.thj.reflection;

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

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

        // 通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }
        // 获得注解指定的值（value）
         Tablethj annotation = (Tablethj)c1.getAnnotation(Tablethj.class);
        String value = annotation.value();
        System.out.println(value);

        // 获得类指定的注解
        Field name = c1.getDeclaredField("id");
        Fieldthj annotation1 = name.getAnnotation(Fieldthj.class);
        System.out.println(annotation1.columnName());
        System.out.println(annotation1.type());
        System.out.println(annotation1.length());
    }
}
@Tablethj("db_student")
class Student2{
    @Fieldthj(columnName = "db_id",type = "int",length = 10)
    private int id;
    @Fieldthj(columnName = "db_age",type = "int",length = 10)
    private int age;
    @Fieldthj(columnName = "db_name",type = "varchar",length = 3)
    private String name;

    public Student2(){

    }

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

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

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