Java注解与反射

注解

什么是注解?

• Annotation[ˌænəˈteɪʃn]是从JDK5.0开始引入的新技术。
• Annotation的作用
  1. 不是程序本身，但可以对程序作出解释。(这一点和注释没什么区别)
  2. 可以被其他程序读取(比如：编译器等)。
• Annotation的格式
  1. 注解是以"@注释名"在代码中存在的，还可以添加一些参数值，例如：@SupperWarnings(value=“unchecked”)
• Annotaion在哪里使用
  1. 可以附在在package、class、method、field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

内置注解

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

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供其他annotation类型作说明。
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到。
  1. @Target：用于描述注解的使用范围(即被描写的注解可以用在什么地方)。
  2. @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期。(SOURCE<CLASS<RUNTIME)
  3. @Documented：说明该注解将被包含在javadoc中。
  4. @Inherited：说明子类可以继承父类中的该注解。

自定义注解

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

》分析：

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

案例：

/**
 * 自定义注解
 */
@Target({ElementType.TYPE, ElementType.METHOD}) //可以在类、方法上使用
@Retention(RetentionPolicy.RUNTIME) //需要在运行是保存该注释信息
public @interface MyAnnotation(){
	String value();
}


/**
 * 使用自定义注解
 */
@MyAnnotation(value = "类上使用")
public class Test(){
   
  @MyAnnotation(value = "方法上使用")
  public void eat(){
    
  }
}

反射

1. 引言

静态 vs 动态语言

动态语言

​ ▶是一类在运行时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。

​ ▶主要的动态语言：Object-C、C#、JavaScript、PHP、Python等。

静态语言

​ ▶与动态语言相对应的，运行时结构不可变的语言就是静态语言。如Java、C、C++

​ ▶Java不是动态语言，但Java可以称之为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活。

2. 反射机制概述

》Reflection(反射)是Java被视为动态语言的关键，反射机制允许程序在执行期借助与Reflection API取得任何类的内部信息，并能直接操作任意对象的内部属性及方法。

Class c = Class.forName("java.lang.String");

》加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象(一个类只有一个Class对象)，这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以我们形象的称之为：反射。

3. 理解Class类并获取Class实例

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

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

3.1 Class类的常用方法

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

3.2 Java反射机制提供的功能

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

3.3 获取Class类的实例

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

Class clazz = Person.class;

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

Class clazz = Person.getClass();

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

Class clazz = Class.forName("com.test.Person");

• 内置基本数据类型可以直接用类名.Type

Class clazz = Integer.Type;

• 还可以利用ClassL oader我们之后讲解

3.4 哪些类有Class对象?

》class：外部类、内部类、局部内部类、匿名内部类。

》interface：接口

》[]：数组

》enum：枚举

》annotation：注解

》promitive type：基本数据类型

》void

// 类
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;
// void
Class c8 = void.class;

3.5 Java反射的优点和缺点

优点：

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

缺点：

• 对性能有影响。使用反射基本上是一种解释操作 ，我们可以告诉JVM，我们希望
  做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

4. 类的加载与ClassLoader

4.1 Java内存分析

4.2 类的加载过程

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

》链接：将Java类的二进制代码合并到JVM的运行状态之中的过程。

• 验证：确保加载的类信息符合JVM规范，没有安全方面的问题。
• 准备：正式为类变量(static) 分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行分配。
• 解析：虚拟机常量池内的符号引用(常量名)替换为直接引用(地址)的过程。

》初始化：

• 执行类构造器 ()方法的过程。类构造器< clinit> ()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。(类构造 器是构造类信息的，不是构造该类对象的构造器)。
• 当初始化- 个类的时候，如果发现其父类还没有进行初始化,则需要先触发其父类的初始化。
• 虚拟机会保证一-个类的 ()方法在多线程环境中被正确加锁和同步。

4.3 什么时候会发生类的初始化?

》类的主动引用(一定会发生类的初始化)

• 当虚拟机启动，先初始化main方法所在的类
• new一个类的对象
• 调用类的静态成员 (除了final常量) 和静态方法
• 使用java.lang.reflect包的方法对类进行 反射调用
• 当初始化一个类，如果其父类没有被初始化，则先会初始化它的父类

》类的被动引用(不会发生类的初始化)

• 当访问一个静态域时，只有真正声明这个域的类才会被初始化。如:当通过子类引用父类的静态变量，不会导致子类初始化。
• 通过数组定义类引用，不会触发此类的初始化。
• 引用常量不会触发此类的初始化( 常量在链接阶段就存入调用类的常量池中了)。

4.4 类加载器

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

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

5. 创建运行时类的对象

5.1 反射获取对象属性

public static void main(String[] args) throws Exception{
  			//获得class对象
        Class c1 = Class.forName("com.tyq.finance.reflection.User");

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

        //获取类的属性
        //只能获取public属性
        Field[] fields = c1.getFields();
        //可以获取全部属性
        Field[] declaredFields = c1.getDeclaredFields();
        //获取指定的字段，只能获取public属性
        Field name = c1.getField("name");
        //获取指定的字段，可以获取所有域属性
        Field declaredName = c1.getDeclaredField("name");

        //获取类的方法
        //获得本类及父类的public方法
        Method[] methods = c1.getMethods();
        //获得本类所有方法
        Method[] declaredMethods = c1.getDeclaredMethods();
        //获取指定方法
        Method getName = c1.getMethod("getName", null);
        Method setName = c1.getMethod("setName", String.class);

        //获取构造器
        //只能获取public构造器
        Constructor[] constructors = c1.getConstructors();
        //获取所有构造器
        Constructor[] declaredConstructors = c1.getDeclaredConstructors();
        //获取指定构造器
  			//无参构造
        Constructor constructor = c1.getConstructor();
  			//有参构造
        constructor = c1.getConstructor(int.class, String.class, int.class);
    }

5.2 反射操作对象属性

public static void main(String[] args) throws Exception{
  Class c1 = Class.forName("com.tyq.finance.reflection.User");

  //一、构造一个对象
  //方式1：通过newInstance()获取对象，其本质是调用了无参构造器
  User user1 = (User) c1.newInstance();
  //方式2：通过构造器获取对象
  Constructor ctr = c1.getConstructor(int.class, String.class, int.class);
  User user2 = (User) ctr.newInstance(1, "tyq", 27);
  System.out.println(user2.getAge());

  //二、通过反射调用方法
  //1.创建一个对象
  User user3 = (User) c1.newInstance();
  //2.获取对象方法
  Method setName = c1.getDeclaredMethod("setName", String.class);
  //3.执行对象方法
  setName.invoke(user3, "tyq");
  //测试值是否设置成功
  Method getName = c1.getDeclaredMethod("getName", null);
  String name = (String) getName.invoke(user3, null);
  System.out.println(name);

  //三、通过反射操作属性
  Field name1 = c1.getDeclaredField("name");
  //不能直接操作私有属性，需要关闭程序的关闭安全检查
  name1.setAccessible(true);
  name1.set(String.class, "Marquis");
  //测试是否设置成功
  User user4 = (User) c1.newInstance();
  System.out.println(user4.getName());
}

setAccessible

• Method和Field、 Constructor对象都有setAccessible()方法。

• setAccessible作用是启动和禁用访问安全检查的开关。

• 参数值为true则指示反射的对象在使用时应该取消Java语言访问检查。

  • 提高反射的效率。如果代码中必须用反射，而该句代码需要频繁的被调用，那么请设置为true。

  • 使得原本无法访问的私有成员也可以访问。

• 参数值为false则指示反射的对象应该实施Java语言访问检查。

5.3 性能对比分析

import java.lang.reflect.Method;

/**
 * @author 谭永强
 * @date 2021-03-22
 */

public class Test01 {

    public static void main(String[] args) throws Exception{
        test01();
        test02();
        test03();
    }

    private 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("普通方式:" + (endTime - startTime) + "ms");
    }

    private static void test02() throws Exception{
        //反射方式
        User user = new User();
        Class c1 = user.getClass();
        Method method = c1.getDeclaredMethod("getName", null);
        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            method.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方式:" + (endTime - startTime) + "ms");
    }

    private static void test03() throws Exception{
        //反射方式 关闭验证
        User user = new User();
        Class c1 = user.getClass();
        Method method = c1.getDeclaredMethod("getName", null);
        method.setAccessible(true);
        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            method.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方式:" + (endTime - startTime) + "ms");
    }
}


class User{

    private int id;
    private String name;
    private int age;

    public User() {
    }

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

    public int getId() {
        return id;
    }

    public void setId(int id) {
        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;
    }
}

5.4 获取泛型信息

反射操作泛型：

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

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

/**
 * @author 谭永强
 * @date 2021-03-22
 */

public class Test01 {

    public static void main(String[] args) throws Exception{
        //通过反射获取泛型
        Class c1 = Class.forName("com.tyq.finance.reflection.Test01");
        //获取方法
        Method method = c1.getDeclaredMethod("test02", Map.class, List.class);
        //获取参数泛型
        Type[] genericParameterTypes = method.getGenericParameterTypes();
        for (Type type : genericParameterTypes) {
            System.out.println(type);
            //判断该泛型的参数类型是否是一个参数化类型
            if(type instanceof ParameterizedType){
                Type[] types = ((ParameterizedType) type).getActualTypeArguments();
                for (Type type1 : types) {
                    System.out.println(type1);
                }
            }
        }
    }

    public Map<String, Object> test02(Map<String, Long> map, List<Integer> list){
        return null;
    }

}

5.5 获取注解信息

package com.tyq.finance.reflection;

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

/**
 * @author 谭永强
 * @date 2021-03-22
 */

public class Test01 {

    public static void main(String[] args) throws Exception{
        Class c1 = Class.forName("com.tyq.finance.reflection.Student");
        //通过反射获取注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }
        //获取注解的value值
        Table table = (Table)c1.getAnnotation(Table.class);
        System.out.println(table.value());

        Field field = c1.getDeclaredField("userName");
        TableField tableField = field.getAnnotation(TableField.class);
        System.out.println(tableField.name());
        System.out.println(tableField.type());
        System.out.println(tableField.length());
    }
}

@Table("db_student")
class Student {

    @TableField(name = "id", type = "varchar", length = 32)
    private int id;

    @TableField(name = "user_name", type = "number", length = 10)
    private String userName;

    @TableField(name = "age", type = "number", length = 3)
    private int age;

    public int getId() {
        return id;
    }

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

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public int getAge() {
        return age;
    }

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

/**
 * 自定义注解
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Table {
    String value();
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface TableField{
    //字段名称
    String name();
    //字段类型
    String type() default "varchar";
    //长度
    int length();
}

6. SpringBoot自定义注解解析器

6.1 创建自定义注解

package com.tyq.finance.reflection.ann;

import java.lang.annotation.*;

/**
 * 自定义注解，获取当前用户
 * @author 谭永强
 * @date 2021-03-23
 */
@Target(ElementType.PARAMETER) //该注解只能用于参数列表
@Retention(RetentionPolicy.RUNTIME) //在运行时生效
@Documented
public @interface RequestUser {
}

6.2 创建实体类

package com.tyq.finance.reflection.entity;

import java.io.Serializable;

/**
 * @author 谭永强
 * @date 2021-03-23
 */
public class MyUserInfo implements Serializable {

    private Integer id;
    private String name;
    private Integer age;

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

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

6.3 创建自定义注解解析器

package com.tyq.finance.reflection;

import com.tyq.finance.reflection.ann.RequestUser;
import com.tyq.finance.reflection.entity.MyUserInfo;
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

/**
 * 自定义参数解析器
 * @author 谭永强
 * @date 2021-03-23
 */
public class RequestUserHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        //绑定注解标签
        return  methodParameter.hasParameterAnnotation(RequestUser.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer container, NativeWebRequest request, WebDataBinderFactory factory) throws Exception {
        //此处用于实现注解的业务代码，比如调用接口或数据库获取用户信息
        MyUserInfo userInfo = new MyUserInfo();
        userInfo.setId(1);
        userInfo.setName("tyq");
        userInfo.setAge(20);
        return userInfo;
    }
}

6.4 添加自定义注解解析器

package com.tyq.finance.reflection;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

/**
 * @author 谭永强
 * @date 2021-03-23
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(new RequestUserHandlerMethodArgumentResolver());
    }
}

6.5 使用实例

package com.tyq.finance.controller;

import com.tyq.finance.reflection.ann.RequestUser;
import com.tyq.finance.reflection.entity.MyUserInfo;
import org.springframework.stereotype.Controller;
import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;

/**
 * @author 谭永强
 * @date 2021-03-20
 */
@Controller
@RequestMapping("/report/")
public class TestController {


    @GetMapping(value = "/test")
    public ModelAndView test(@RequestUser MyUserInfo user) {
        System.out.println(user.getName());
        ModelAndView mv = new ModelAndView();
        mv.addObject("user", user);
        mv.setViewName("/report/test.html");
        return mv;
    }
}