注解与反射学习记录

7 阅读11分钟

内置注解

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

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

➢ @SuppressWarnings:定义在 java.lang.SuppressWarnings 中,用来抑制编译时的警告信息。

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

✓ @SuppressWarnings("all")

✓ @SuppressWarnings("unchecked")

✓ @SuppressWarnings(value={"unchecked","deprecation"})

✓ 等等……

元注解

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

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

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

➢ @Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期

➢ (SOURCE < CLASS < RUNTIME)

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

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

image.png

image.png

自定义注解

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

➢ 分析:

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

✓ 其中的每一个方法实际上是声明了一个配置参数.

✓ 方法的名称就是参数的名称.

✓ 返回值类型就是参数的类型(返回值只能是基本类型,Class,String,enum).

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

✓ 如果只有一个参数成员,一般参数名为value

✓ 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值.

public class Test03 {
    @A(age=10)//无默认值的参数必须传值
    public void test(){

    }
    @B("zhanglei")//不用加任何value=“”
    public void test2(){

    }
}
@Target({ElementType.TYPE,ElementType.METHOD})//注解的适用位置,类,方法
@Retention(RetentionPolicy.RUNTIME)//注解的使用时机 运行
@interface A {//自定义注解
    String name() default "";//注解的参数,default 表示默认值,设置了default那就可以不传参数
    int age();
}

@Target({ElementType.TYPE,ElementType.METHOD})//注解的适用位置,类,方法
@Retention(RetentionPolicy.RUNTIME)//注解的使用时机 运行
@interface B {
    String value();//一个参数时命名为value可以在定义时不加value =
}
```
```

反射机制

动态语言

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

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

静态语言

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

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

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

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

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

正常方式:引入需要的"包类"名称 → 通过new实例化 → 取得实例化对象

反射方式:实例化对象 → getClass()方法 → 得到完整的"包类"名称

package com.zhang.注解与反射;

public class TestReflection {
    public static void main(String[] args) throws ClassNotFoundException {
        //通过反射得到类的class对象
        Class<?> aClass = Class.forName("com.zhang.注解与反射.User");
        Class<?> aClass2 = Class.forName("com.zhang.注解与反射.User");
        Class<?> aClass3 = Class.forName("com.zhang.注解与反射.User");
        Class<?> aClass4 = Class.forName("com.zhang.注解与反射.User");

        //一个类只有一种Class对象
        //一个类加载后,类的整个结构都在Class对象中
        System.out.println(aClass);
        System.out.println(aClass2);
        System.out.println(aClass2.hashCode());
        System.out.println(aClass3.hashCode());
        System.out.println(aClass4.hashCode());
    }
}

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

    public User() {
    }

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

    /**
     * 获取
     * @return name
     */
    public String getName() {
        return name;
    }

    /**
     * 设置
     * @param name
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 获取
     * @return age
     */
    public int getAge() {
        return age;
    }

    /**
     * &#x8BBE;&#x7F6E;
     * @param age
     */
    public void setAge(int age) {
        this.age = age;
    }

    public String toString() {
        return "User{name = " + name + ", age = " + age + "}";
    }
}
```
```
D:\develop-tools\JDK\jdk-17.0.2\bin\java.exe "-javaagent:D:\develop-tools\IDEA\IntelliJ IDEA 2025.1.1.1\lib\idea_rt.jar=54804" -Dfile.encoding=UTF-8 -classpath D:\code\JAVA\IDEA\study1\out\production\study1;D:\code\JAVA\IDEA\study1\src\com\lib\commons-io-2.21.0.jar com.zhang.注解与反射.TestReflection
class com.zhang.注解与反射.User
class com.zhang.注解与反射.User
1096979270
1096979270
1096979270

Process finished with exit code 0

Class类

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

  • Class 本身也是一个类
  • Class 对象只能由系统建立对象
  • 一个加载的类在 JVM 中只会有一个 Class 实例
  • 一个 Class 对象对应的是加载到 JVM 中的一个 .class 文件
  • 每个类的实例都会记住自己是由哪个 Class 实例所生成
  • 通过 Class 可以完整地得到一个类中所有被加载的结构
  • Class 类是 Reflection 的根源,针对任何你想动态加载、运行的类,唯有先获得相应的 Class 对象
  1. static Class forName(String name):通过指定类名获取其对应的Class对象。
  2. Object newInstance():通过调用默认构造函数,创建此Class对象所表示类的一个实例。
  3. getName():返回此Class对象所表示的实体(如类、接口、数组或void)的名称。
  4. Class getSuperClass():返回当前Class对象所表示类的父类对应的Class对象。
  5. Class[] getInterfaces():获取当前Class对象所表示类实现的所有接口对应的Class对象数组。
  6. ClassLoader getClassLoader():返回加载此类的类加载器。
  7. Constructor[] getConstructors():返回一个包含此类所有公共构造方法的Constructor对象数组。
  8. Method getMethod(String name,Class... T):根据方法名和参数类型,返回指定的公共方法的Method对象。
  9. Field[] getDeclaredFields():返回一个包含此类声明的所有字段(不论访问权限)的Field对象数组。
package com.zhang.注解与反射;

public class TestReflection2 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        //方式1:通过对象获得
        Class aClass = person.getClass();
        System.out.println(aClass);
        //方式2:通过包名forName获得
        Class<?> aClass1 = Class.forName("com.zhang.注解与反射.Student");
        System.out.println(aClass1);
        //方式3:通过类名.Class获得
        Class aClass2 = Student.class;
        System.out.println(aClass2);
        //基本内置类都有一个TYPE属性直接得到类
        Class type = Integer.TYPE;
        System.out.println(type);
        //得到父类类型
        Class<?> superclass = aClass1.getSuperclass();
        System.out.println(superclass);
    }
}
class Person {
     String name;


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

    }
}
class Student extends Person {
    public Student() {
        super("学生");
    }
}


D:\develop-tools\JDK\jdk-17.0.2\bin\java.exe "-javaagent:D:\develop-tools\IDEA\IntelliJ IDEA 2025.1.1.1\lib\idea_rt.jar=54402" -Dfile.encoding=UTF-8 -classpath D:\code\JAVA\IDEA\study1\out\production\study1;D:\code\JAVA\IDEA\study1\src\com\lib\commons-io-2.21.0.jar com.zhang.注解与反射.TestReflection2
class com.zhang.注解与反射.Student
class com.zhang.注解与反射.Student
class com.zhang.注解与反射.Student
int
class com.zhang.注解与反射.Person

Process finished with exit code 0

```
```

哪些类型可以有Class对象?

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

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

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

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

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

有了Class对象,能做什么?

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

    • 1)类必须有一个无参数的构造器。
    • 2)类的构造器的访问权限需要足够
  • 思考? ​ 难道没有无参的构造器就不能创建对象了吗?只要在操作的时候明确的调用类中的构造器,并将参数传递进去之后,才可以实例化操作。

  • 步骤如下

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

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

    3)通过Constructor实例化对象

调用指定的方法

Object invoke(Object obj, Object ... args)

  • Object 对应原方法的返回值,若原方法无返回值,此时返回null
  • 若原方法若为静态方法,此时形参Object obj可为null
  • 若原方法形参列表为空,则Object[] args为null
  • 若原方法声明为private,则需要在调用此invoke()方法前,显式调用方法对象的setAccessible(true)方法,将可访问private的方法。
public class TestReflection3 {
    public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //获取class对象
        Class<?> aClass = Class.forName("com.zhang.注解与反射.User");
        //构造一个对象
        User user = (User) aClass.newInstance();
        //本质调用的是无参构造方法
        System.out.println("本质调用的是无参构造方法");
        System.out.println(user);
        System.out.println();

        //通过构造器创建对象
        Field[] fields = aClass.getDeclaredFields();//这个方法可以得到类的所有属性,无论是否public  declared:已声明
        for (Field field : fields) {
            System.out.println("属性有:"+field.getName());
        }
        System.out.println();
        Constructor<?> constructor = aClass.getDeclaredConstructor(String.class, int.class);
        //构造器创建对象
        User zhanglei = (User) constructor.newInstance("zhanglei", 22);
        System.out.println("构造器创建对象");
        System.out.println(zhanglei);
        System.out.println();

        Method[] methods = aClass.getDeclaredMethods();//这个方法可以得到类的所有方法,无论是否public
        for (Method method : methods) {
            System.out.println("方法有:"+method.getName());
        }
        Method setName = aClass.getDeclaredMethod("setName", String.class);//通过反射获取方法
        setName.invoke(user, "zhang");//invoke:激活  (对象,“方法的值”)
        System.out.println();
        System.out.println("操作方法后:"+user);
        System.out.println();
        //通过反射操作属性
        Field age = aClass.getDeclaredField("age");
        age.setAccessible(true);//关闭权限检测,否则会因为私有权限问题报错
        age.set(user, 22);
        System.out.println("操作属性后:"+user);


    }
}


D:\develop-tools\JDK\jdk-17.0.2\bin\java.exe "-javaagent:D:\develop-tools\IDEA\IntelliJ IDEA 2025.1.1.1\lib\idea_rt.jar=63366" -Dfile.encoding=UTF-8 -classpath D:\code\JAVA\IDEA\study1\out\production\study1;D:\code\JAVA\IDEA\study1\src\com\lib\commons-io-2.21.0.jar com.zhang.注解与反射.TestReflection3
本质调用的是无参构造方法
User{name = null, age = 0}

属性有:name
属性有:age

构造器创建对象
User{name = zhanglei, age = 22}

方法有:getAge
方法有:setAge
方法有:getName
方法有:toString
方法有:setName

操作方法后:User{name = zhang, age = 0}

操作属性后:User{name = zhang, age = 22}

Process finished with exit code 0

```
```

setAccessible

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

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

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

    • 提高反射的效率。如果代码中必须用反射,而该句代码需要频繁的被调用,那么请设置为true。
    • 使得原本无法访问的私有成员也可以访问
  • 参数值为false则指示反射的对象应该实施Java语言访问检查

image.png

反射操作泛型

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

image.png

反射操作注解

  • getAnnotations
  • getAnnotation

image.png

image.png

注释文档生成

image.png image.png

image.png