Java 注解和反射

TheManba

已于 2024-05-22 23:33:49 修改

阅读量703

点赞数 17

分类专栏： Java学习笔记——基础知识文章标签： java 前端

于 2024-05-22 23:24:01 首次发布

本文链接：https://blog.csdn.net/weixin_45594025/article/details/139132115

版权

Java学习笔记——基础知识专栏收录该内容

20 篇文章 2 订阅

订阅专栏

1. 注解 - annotation

1.1 什么是注解

注解是 JDK 5.0 引入的新技术。

注解的作用：

注解不是程序本身，但可以对程序做出解释；
可以被其他程序（比如编译器）读取。

注解的格式：

注解是以 “@注解名” 在代码中存在，还可以添加一些参数，例如 @SuppressWarnings(value=“ubchecked”)。

注解在哪里使用：

可以加在 package、class、method、field 等上面，相当于给他们添加额外的信息；
我么可以通过反射机制编程实现对这些元数据的访问。

1.2 内置注解

@Override：重写注解；
@Deprecated：表示已过时的方法；
@SuppressWarnings：抑制警告。

1.3 元注解（meta-annotation）

元注解的作用是注解其他注解。Java 定义了 4 个标准元注解。

@Target：用于描述注解的使用范围；
@Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期。
@Documented：说明该注解将被包含在 javadoc 中；
@Inherited：说明子类可以继承父类中的该注解。

package com.zk.annotationtest;

import java.lang.annotation.*;

// 定义一个注解
@Target(value = {ElementType.METHOD, ElementType.TYPE}) // ElementType.METHOD：只能在方法上使用
@Retention(value = RetentionPolicy.RUNTIME) // 表示我们的注解在什么地方有效，runtime > class > source
@Documented // 表示是否将我们的注解生成在 javadoc 中
@Inherited // 子类可以继承父类的注解
public @interface MyAnnotation {
    
}

package com.zk.annotationtest;

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

    @MyAnnotation
    public void test(){

    }

}

1.4 自定义注解

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

@interface 用来声明一个注解；
其中每一个方法实际上是声明了一个配置参数；
方法名就是参数名；
返回值类型就是参数类型（返回值只能是基本类型）；
可以通过 default 声明参数的默认值；
如果只有一个参数成员，一般参数名为 Value；
注解元素必须要有值，我们定义注解元素时，经常使用空字符串、0 作为默认值。

自定义注解类（只有一个参数）：

import java.lang.annotation.*;

@Target(value = {ElementType.METHOD, ElementType.TYPE}) // ElementType.METHOD：只能在方法上使用
@Retention(value = RetentionPolicy.RUNTIME) // 表示我们的注解在什么地方有效，runtime > class > source
public @interface MyAnnotation3 {

    // 只有一个参数的话，一般参数名为 value
    String value();

}

public class Test03 {
    
    // 注解只有一个参数的时候，参数名为 value，可以省略 = 
    @MyAnnotation3("23")
    public void test2(){
        
    }

}

自定义注解类（两个参数）：

import java.lang.annotation.*;

@Target(value = {ElementType.METHOD, ElementType.TYPE}) // ElementType.METHOD：只能在方法上使用
@Retention(value = RetentionPolicy.RUNTIME) // 表示我们的注解在什么地方有效，runtime > class > source
public @interface MyAnnotation2 {

    // 注解的参数：参数类型 + 参数名()
    String name() default "";
    
    int age();

}

public class Test03 {

    // 注解可以显式的赋值，如果没有默认值，我们就必须给他赋值
    @MyAnnotation2(name = "zk", age = 9)
    public void test(){

    }

}

2. 反射

2.1 反射机制概述

动态语言：在运行时可以改变其结构的语言，如 JavaScript、Python、PHP；
静态语言：运行时结构不可改变的语言，如 Java、C++、C

Java 可以称为“准动态语言”，可以利用反射机制获得类似动态语言的特性。

Reflection（反射机制）允许程序在执行期间借助 Reflection API 取得任何类的内部消息，并能直接操作任意对象的内部属性及方法。
加载完类之后，在堆内存的方法区就产生了一个 Class 类型的对象（一个雷只有一个 Class 对象），这个对象包含了类的完整结构信息。我们可以通过这个对象看到类的结构。

2.2 Class 类

Object 类中定义了一个 public final Class getClass() 的方法，该方法将被所有子类继承。

对于每个类而言，JRE 都为其保留一个不变的 Class 类型的对象。

Class 本身也是一个类；
Class 对象只能由系统建立对象；
一个加载的类在 JVM 只有一个 Class 实例；
一个 Class 对象对应的是一个加载到 JVM 中的 .class 文件；
每个类的实例都会记得自己是哪个 Class 实例所生成的；
通过 Class 可以完整地得到一个雷中的所有被加载的结构。

2.3 获取 Class 类的实例

（1）若已知具体的类，通过类的 class 属性获取，该方法最为安全可靠，程序性能极高；

Class clazz = Person.class;

（2）若已知某个类的实例，调用该实例的 getClass() 方法获取 Class 对象；

Class clazz = person.getClass();

（3）已知一个类的全类名和路径，可通过 Class 类的静态方法 forName() 获取；

Class clazz = Class.forName(“com.zk.Person”);

（4）内置基本数据类型可以直接用类名.Type 获取。

package com.zk.reflectiontest;

// Class 类的创建方式有哪些
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());

        // 方式二：通过forname获得
        Class c2 = Class.forName("com.zk.reflectiontest.Student");
        System.out.println(c2.hashCode());

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

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

        // 获得父类类型
        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 = "学生";
    }
}

2.4 所有类型的 Class 对象

package com.zk.reflectiontest;

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
        int[] a = new int[10];
        int[] b = new int[100];
        System.out.println(a.getClass().hashCode());
        System.out.println(b.getClass().hashCode());
    }
}

2.5 类的加载与 ClassLoader 的理解

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

加载：将 class 文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表这个类的 java.lang.Class 对象。
链接：将 Java 的二进制代码合并到 JVM 的运行状态之中的过程。
- 验证：确保加载的类信息符合 JVM 规范，没有安全方面的问题；
- 准备：正式为 static 变量（类变量）分配内存并设置类变量默认初始值，这些内存都将在方法区中进行分配；
- 解析：虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程。
初始化：执行类构造器 <clinit>() 方法的过程。
- 类构造器 <clinit>() 方法是由编译期自动收集所有类变量的赋值动作和静态代码块中的语句合并产生的。（类构造器是构造类信息的，不是构造该类对象的构造器）；
- 当初始化一个类的时候，如果发现其父类还没有初始化，则要先出触发其父类的初始化；
- 虚拟机会保证一个类的 <clinit>() 方法在多线程环境中被正确加锁和同步。

package com.zk.reflectiontest;

// 类是怎么加载的
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>(){
                System.out.println("A类静态代码块初始化");
                m = 300;
                m = 100;
            }
         */
    }
}

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

    static int m = 100;

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

输出：

A类静态代码块初始化
A类无参构造器初始化
100

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

类的主动引用（一定会发生类的初始化）

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

定义两个继承关系的类：

class Father{

    static int b = 2;

    static {
        System.out.println("父类被加载");
    }

}

class Son extends Father{

    static {
        System.out.println("父类被加载");
    }

    static int m = 100;

    static final int M = 1;

}

测试主动引用：

public class Test06 {

    static {
        System.out.println("Main类被加载");
    }

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

        // 2. 反射也会产生主动引用
        Class.forName("com.zk.reflectiontest.Son");
    }

}

输出：

Main类被加载
父类被加载
父类被加载

类的被动引用（不会发生类的初始化）

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

测试被动引用：

public class Test06 {

    static {
        System.out.println("Main类被加载");
    }

    public static void main(String[] args) throws ClassNotFoundException {
//        Son[] sons = new Son[4]; // 通过数组声明类的引用，不会发生初始化
//        System.out.println(Son.b); // 通过子类访问父类的静态属性，子类不会被加载
        System.out.println(Son.M); // 访问Son类的常量，Son类不会被加载
    }

}

2.7 类加载器的作用

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

package com.zk.reflectiontest;

// 所有类型的Class
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++写的，Java获取不到，所以打印为null
        ClassLoader parent1 = parent.getParent();
        System.out.println(parent1);

        // 当前类是哪个类加载器加载的
        ClassLoader current = Class.forName("com.zk.reflectiontest.Test07").getClassLoader();
        System.out.println(current);

        ClassLoader jdkClass = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(jdkClass);

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

}

输出：

sun.misc.Launcher$AppClassLoader@18b4aac2
sun.misc.Launcher$ExtClassLoader@22a71081
null
sun.misc.Launcher$AppClassLoader@18b4aac2
null

2.8 获取类的运行时结构

2.8.1 获取运行时类的完整结构

通过反射获取运行时类的完整结构，包括 Field、Method、Constructor、Superclass、interface、Annotation。

package com.zk.reflectiontest;

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.zk.reflectiontest.User");

        // 获得类的名字
        System.out.println(c1);
        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' is not public
//        Field f = c1.getField("name");
//        System.out.println(f);
        Field f = c1.getDeclaredField("name");
        System.out.println(f);

        System.out.println("======================");

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

        System.out.println("getDeclaredMethods():");
        methods = c1.getDeclaredMethods(); // 获取的本类的所有方法
        for (Method method : methods) {
            System.out.println(method);
        }

        System.out.println("======================");

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

        // 获得指定的构造器
        Constructor[] constructors = c1.getConstructors();
        constructors = c1.getDeclaredConstructors();
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
    }

}

2.9 动态创建对象执行方法

有了 CLass 对象能做什么

2.9.1 创建类的对象

调用 Class 对象的 newInstance() 方法。要求：

类必须有一个无参构造器（否则执行 newInstance() 时会报错）；
类的构造器的访问权限要足够。

如果类没有无参构造器，操作的时候明确调用类中的构造器，并将参数传递之后，才可以执行实例化操作。步骤如下：

通过 Class 对象的 getDeclaredConstructor() 取得本类的指定形参类型的构造器；
使用 constructor 的 newInstance() 方法创建类对象。

package com.zk.reflectiontest;

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 对象
        Class c1 = Class.forName("com.zk.reflectiontest.User");

        // 构造一个对象
//        User user = (User) c1.newInstance(); // 本质是调用类的无参构造器，如果把无参构造器删掉，就会报错
//        System.out.println(user);

        // 通过构造器创建对象
//        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
//        User user2 = (User) constructor.newInstance("kk", 8, 8);
//        System.out.println(user2);
    }

}

2.9.2 调用指定的方法

通过反射，调用类中的方法，通过 Method 类实现。

通过 Class 对象的 getMethod() 方法取得一个 Method 对象，并设置要获取的方法所需要的参数类型；
使用 Object invoke() 方法进行调用，并向方法中传递要设置的参数信息。

package com.zk.reflectiontest;

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 对象
        Class c1 = Class.forName("com.zk.reflectiontest.User");

        // 通过反射调用普通方法
        User user3 = (User) c1.newInstance();
        // 通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(user3, "kobe"); // 激活这个函数
        System.out.println(user3.getName());
    }

}

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

返回类型对应指定方法的返回值，若指定方法没有返回值，则返回 null；
若指定方法为静态方法，此时形参 Object obj 为 null；
若指定方法形参为空，则 Object … args 为 null；
若指定方法声明为 private，则在 invoke() 之前，需要调用 setAccessible(true) 方法，才可访问私有方法。

2.9.3 通过反射操作属性

setAccessible() 方法：

Method、Field 和 Constructor 对象都有 setAccessible() 方法；
setAccessible() 的作用是启动或者禁用访问安全检查的开关；
true：表示取消 Java 语言访问检查。这时候才可以访问类的私有属性和方法。

package com.zk.reflectiontest;

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 对象
        Class c1 = Class.forName("com.zk.reflectiontest.User");

        // 通过反射操作属性
        User user4 = (User) c1.newInstance();
        Field nameField = c1.getDeclaredField("name");
        nameField.setAccessible(true); // 不能操作私有属性，需要关闭程序的安全检测，setAccessible设为true（私有方法同样）
        nameField.set(user4, "curry");
        System.out.println(user4.getName());
    }

}

2.10 通过反射操作泛型

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

package com.zk.reflectiontest;

import java.lang.reflect.*;
import java.util.Map;

// 通过反射获取泛型对象
public class Test10 {

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

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

    public static void main(String[] args) throws NoSuchMethodException {
        Class clazz = Test10.class;

        Method method = clazz.getDeclaredMethod("test01", Map.class, String.class);

        Type[] types = method.getGenericParameterTypes();
        for (Type type : types) {
            System.out.println("----------");
            System.out.println(type);
            if(type instanceof ParameterizedType) {
                Type[] actualTypeArguments = ((ParameterizedType) type).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }

        System.out.println("===================");
        method = clazz.getDeclaredMethod("test02", null);
        Type returnType = method.getGenericReturnType();
        System.out.println(returnType);
        if(returnType instanceof ParameterizedType) {
            Type[] actualReturnTypes = ((ParameterizedType) returnType).getActualTypeArguments();
            for (Type actualReturnType : actualReturnTypes) {
                System.out.println(actualReturnType);
            }
        }
    }

}

输出：

----------
java.util.Map<java.lang.String, com.zk.reflectiontest.User>
class java.lang.String
class com.zk.reflectiontest.User
----------
class java.lang.String
===================
java.util.Map<java.lang.String, com.zk.reflectiontest.User>
class java.lang.String
class com.zk.reflectiontest.User

2.11 通过反射操作注解

了解 ORM
ORM：Object Relationship Mapping，对象关系映射

类和表结构对应；
类属性和表字段对应；
对象和记录对应。

要求：利用注解和反射完成类和表结构的关系映射。

package com.zk.reflectiontest;

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

// 通过反射操作注解
public class Test11 {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class clazz = Class.forName("com.zk.reflectiontest.Stu");

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

        // 获得注解的value的值
        TableZhou tableZhou = (TableZhou) clazz.getAnnotation(TableZhou.class);
        System.out.println(tableZhou.value());

        // 获得类指定的注解（属性的注解）
        Field field = clazz.getDeclaredField("name");
        FieldZhou fieldZhou = field.getAnnotation(FieldZhou.class);
        System.out.println(fieldZhou.columnName());
        System.out.println(fieldZhou.type());
        System.out.println(fieldZhou.length());
    }

}

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

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

@TableZhou("db_student")
class Stu {

    @FieldZhou(columnName = "db_name", type = "varchar", length = 10)
    private String name;

    @FieldZhou(columnName = "db_id", type = "int", length = 10)
    private int id;

    @FieldZhou(columnName = "db_age", type = "int", length = 10)
    private int age;

    public Stu() {}

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        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;
    }

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

TheManba

关注

17
点赞
踩
24

收藏

觉得还不错? 一键收藏
1
评论
Java 注解和反射

注解是 JDK 5.0 引入的新技术。注解是不是程序本身，但可以对程序做出解释；可以被其他程序（比如编译器）读取。注解是以 “@注解名” 在代码中存在，还可以添加一些参数，例如 @SuppressWarnings(value=“ubchecked”)。可以加在 package、class、method、field 等上面，相当于给他们添加额外的信息；我么可以通过反射机制编程实现对这些元数据的访问。使用@interface自定义注解时，自动继承了接口。@interface用来声明一个注解；
复制链接

扫一扫