Java基础：注解和反射

注解和反射

根据B站UP主 遇见狂神说 视频教程《【狂神说Java】注解和反射》进行整理记录，仅用于个人学习/交流使用。

视频地址：https://www.bilibili.com/video/BV1p4411P7V3

注解（Annotation）

基本概念

Annotation是从JDK5.0开始引入的新技术

Annotation的作用︰

• 不是程序本身(可以对程序作出解释（这一点和注释(comment）没什么区别）
• 可以被其他程序（比如:编译器等）读取

Annotation的格式：

• 注解是以"@注释名"在代码中存在的，还可以添加一些参数值，例如:@SuppressWarnings(value=“unchecked”)

Annotation在哪里使用?

• 可以附加在package , class , method , field 等上面﹐相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

内置注解

@Override：定义在java.lang.Override中,此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明

@Deprecated：定义在java.lang.Deprecated中,此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择

@suppressWarnings∶定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息，

• 与前两个注释有所不同,你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就好了

• @SuppressWarnings(“all”)

• @SuppressWarnings(“unchecked”)

• @SuppressWarnings(value={“unchecked”,“deprecation”})

• 等等…

@Target(value=METHOD)
@Retention(value=SOURCE)
public @interface Override
    表示方法声明旨在``覆盖超类型中的方法声明```。 如果使用此注释类型注释方法，则除非至少满足以下条件之一，否则需要编译器生成错误消息： 
		该方法将覆盖或实现在超类型中声明的方法。 
		该方法具有与Object中声明的任何公共方法的覆盖相同的签名 。 
从以下版本开始： 
1.5 
See The Java™ Language Specification: 
9.6.1.4 @Override 

@Documented
@Retention(value=RUNTIME)
@Target(value={CONSTRUCTOR,字段,LOCAL_VARIABLE,METHOD,PACKAGE,PARAMETER,TYPE})
public @interface 已过时的注释
    @Deprecated的程序元素是程序员不鼓励使用的程序元素，通常是因为它是危险的，或者因为存在更好的替代方法。 编译器在不被弃用的代码中使用或覆盖不推荐使用的程序元素时发出警告。 
从以下版本开始： 
1.5 
See The Java™ Language Specification: 
9.6.3.6 @已淘汰 

@Target(value={TYPE,字段,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE})
@Retention(value=SOURCE)
public @interface SuppressWarnings
    表示在注释元素（以及注释元素中包含的所有程序元素）中应该抑制命名的编译器警告。 
    请注意，给定元素中抑制的一组警告是所有包含元素中抑制的警告的超集。 例如，如果您注释一个类来抑制一个警告并注释方法来抑制另一个警告，则两个警告将在该方法中被抑制。 
	作为一种风格，程序员应该始终将这个注释用于最有效的嵌套元素。 如果要在特定方法中抑制警告，则应该注释该方法而不是其类。 

从以下版本开始： 
1.5 
See The Java™ Language Specification: 
4.8原始类型，4.12.2参考类型的变量，5.1.9未经检查的转换，5.5.2检查的角色和未被检查的角色，9.6.3.5 @SuppressWarnings 

元注解

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

这些类型和它们所支持的类在java.lang.annotation包中可以找到(@Target , @Retention ,@Documented , @Inherited )

@Target：用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

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

@Document：说明该注解将被包含在javadoc（文档注释）中

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

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration 类、接口（包括注解类型）或枚举声明*/
    TYPE,
    /** Field declaration (includes enum constants) 字段声明（包括枚举常量）*/
    FIELD,
    /** Method declaration 方法声明*/
    METHOD,
    /** Formal parameter declaration 形参声明*/
    PARAMETER,
    /** Constructor declaration 构造函数声明*/
    CONSTRUCTOR,
    /** Local variable declaration 局部变量声明*/
    LOCAL_VARIABLE,
    /** Annotation type declaration 注解类型声明*/
    ANNOTATION_TYPE,
    /** Package declaration 包装声明*/
    PACKAGE,
    /**
     * Type parameter declaration 类型参数声明
     * @since 1.8
     */
    TYPE_PARAMETER,
    /**
     * Use of a type 类型的使用
     * @since 1.8
     */
    TYPE_USE
}

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler. 编译器将丢弃注释
     */
    SOURCE,
    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior. 注释将由编译器记录在类文件中，但在运行时不需要由 VM 保留。 这是默认行为
     */
    CLASS,
    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     * 注解将被编译器记录在类文件中，并在运行时由 VM 保留，因此它们可以被反射读取
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

/**
 * Indicates that annotations with a type are to be documented by javadoc
 * and similar tools by default.  This type should be used to annotate the
 * declarations of types whose annotations affect the use of annotated
 * elements by their clients.  If a type declaration is annotated with
 * Documented, its annotations become part of the public API
 * of the annotated elements.
 * 表示默认情况下，带有类型的注释将由 javadoc 和类似工具记录。 此类型应用于注释类型声明，这些类型的注释会影响其客户端对带注释元素的使用。 如果使用 Documented 对类型声明进行注释，则其注释将成为带注释元素的公共 API 的一部分。
 * @author  Joshua Bloch
 * @since 1.5
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

/*
表示自动继承注解类型。 如果注解类型声明中存在 Inherited 元注解，并且用户在类声明上查询注解类型，而类声明没有针对该类型的注解，则将自动查询该类的超类以获取该注解类型。 将重复此过程，直到找到此类型的注释，或到达类层次结构（对象）的顶部。 如果没有超类具有此类型的注释，则查询将指示所讨论的类没有此类注释。
请注意，如果注释类型用于注释除类以外的任何内容，则此元注释类型无效。 还要注意，这个元注释只会导致从超类继承注释； 已实现接口上的注释无效。
自从：
1.5
作者：
约书亚·布洛赫
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface 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 MyAnnotation1 {
    //注解的参数: 参数类型 + 参数名 + （）  【这里的()不是方法】
    //指定了默认值
    String name() default "张三";
    //没有指定默认值，在使用自定义注解时必须 指定值
    int age();
    //可以定义一个数组
    String[] schools() default {"清华大学","北京大学"};
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation2 {
    //只有参数时，推荐使用value，这样再使用该注解时，可以直接 @MyAnnotation2("李四")
    //如果设置参数为name，而不是value，则使用该注解时，必须 @MyAnnotation2(name="李四")
    String value();
}

public class Demo01 {

    //使用了自定义的注解，因为age没有指定默认值，必须赋值
    @MyAnnotation1(age =18)
    public void test01(){

    }
    
    //使用了自定义的注解，只有一个参数，且为value，可以不用再指定 value=" "
    @MyAnnotation2("李四")
    public static void main(String[] args) {

    }
}

反射（Reflection）

Java反射机制概述

静态语言与动态语言

动态语言

是一类在运行时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。

通俗点说就是在运行时代码可以根据某些条件改变自身结构。

主要动态语言: Object-C、c#、JavaScript、PHP、Python等。

静态语言

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

Java不是动态语言，但Java可以称之为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。

Java的动态性让编程的时候更加灵活!

JavaReflection

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

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

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

//反射
public class Test01 {

    public static void main(String[] args) throws ClassNotFoundException {

        //通过反射获取类的对象
        Class<?> c1= Class.forName("com.example.reflectiondemo.Student");
        System.out.println(c1);

        Class<?> c2= Class.forName("com.example.reflectiondemo.Student");
        Class<?> c3= Class.forName("com.example.reflectiondemo.Student");

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

}

/**
 * class com.example.reflectiondemo.Student
 * 918221580
 * 918221580
 * true
 */

Java反射机制提供的功能

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

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

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

在运行时获取泛型信息

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

在运行时处理注解

生成动态代理

…

反射相关的主要API

java.lang.Class:代表一个类

java.lang.reflect.Method:代表类的方法

java.lang.reflect.Field:代表类的成员变量

java.lang.reflect.Constructor:代表类的构造器

…

优点和缺点

优点:

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

缺点:

对性能有影响。

使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。

这类操作总是慢于直接执行相同的操作。

理解Class类并获取Class实例

Class类

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

public final Class getClass()

以上的方法返回值的类型是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解，

即:可以通过对象反射求出类的名称。

对象照镜子后可以得到的信息：某个类的属性、方法和构造器、某个类到底实现了哪些接口。

对于每个类而言，JRE 都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构(class/interfacelenum/annotation/primitive type/void/)的有关信息。

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

Class类常用方法

获取Class对象

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

Class clazz= Person.class;

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

Class clazz = person.getClass();

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

Class clazz= Class.forName("demo01.Student");

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

e)还可以利用ClassLoader我们之后讲解

//反射
public class Test01 {

    public static void main(String[] args) throws ClassNotFoundException {

        Person person=new Student();

        //方式一：通过对象获取
        Class<? extends Person> c1 = person.getClass();
        System.out.println(c1.hashCode());

        //方式二：forname获取
        Class<?> c2 = Class.forName("com.example.reflectiondemo.Student");
        System.out.println(c2.hashCode());

        //方式三：通过 类名.class 获取
        Class<Student> c3 = Student.class;
        System.out.println(c3.hashCode());

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

        //获取父类类型
        Class<?> c5 = c1.getSuperclass();
        System.out.println(c5);

    }

}


class Person{
    String name;
    Integer age;
}

class Student extends Person{
    Integer sid;
}

/**
 * 918221580
 * 918221580
 * 918221580
 * int
 * class com.example.reflectiondemo.Person
 */

哪些类型可以有Class对象?

class:外部类，成员(成员内部类，静态内部类)，局部内部类，匿名内部类。

interface:接口

[]:数组

enum:枚举

annotation:注解@interface

primitive type:基本数据类型

void

类的加载与ClassLoader

Java内存分析

类的加载过程

当程序主动使用某个类时，如果该类还未被加载到内存中，则系统会通过如下三个步骤来对该类进行初始化。

类的加载与ClassLoader的理解

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

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

• 验证：确保加载的类信息符合JVM规范，没有安全方面的问题

• 准备︰正式为类变量(static)分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行分配。

• 解析∶虚拟机常量池内的符号引用（常量名）替换为直接引用(地址)的过程。

初始化:

执行类构造器()方法的过程。类构造器()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。(类构造器是构造类信息的，不是构造该类对象的构造器)。

当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化

虚拟机会保证一个类的()方法在多线程环境中被正确加锁和同步。

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

类加载的作用

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

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

类加载器的作用

获取运行时类的完整结构

运行时类的指定结构

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

Field、Method、Constructor、Superclass、Interface、Annotation

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

小结

在实际的操作中，取得类的信息的操作代码，并不会经常开发。

一定要熟悉java.lang.reflect包的作用，反射机制。

如何取得属性、方法、构造器的名称，修饰符等。

有了Class对象能做什么?

创建类的对象；调用Class对象的newlnstance()方法

1)类必须有一个无参数的构造器。

2)类的构造器的访问权限需要足够

思考?

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

步骤如下:

1）通过Class类的getDeclaredConstructor(Class … parameterTypes)取得本类的指定形参类型的构造器

2）向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数。

3）通过Constructor实例化对象

调用指定的方法

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

通过Class类的getMethod(String name,Class…parameterTypes)方法取得一个Method对象，并设置此方法操作时所需要的参数类型。

②之后使用Object invoke(Object obj, Object[] args)进行调用，并向方法中传递要设置的obj对象的参数信息。

暴力反射setAccessible

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

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

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

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

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

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

性能对比分析

反射操作泛型

反射操作注解

getAnnotations

getAnnotation