Java注解和反射

Java注解

什么是注解

Annotation是从JDK5.0开始引入的新技术
Annotation作用：
- 不是程序本身，可以对程序做出解释
- 可以被其他程序（比如编译器）读取
Annotation格式：
- 注解是以@注解名在代码中存在的，还可以添加一些参数值，例如：@Service(value=””)
Annotation在哪些地方使用？
- package、class、method、field等上面，相当于给他们添加了额外的辅助信息，可以通过反射机制编程实现对这些元数据的访问

Java中内置注解

@Override:表示一个方法重写另一个方法的声明

@Deprecated:表示不鼓励程序员使用，通常表示才操作被废弃，但实际可以使用，也存在更好的方式

@SuppressWarnings:抑制编译时的警告信息

元注解

元注解的作用是负责注解其他注解，Java定义了4个标准的元注解，它们被用来提供对其他注解类型做说明。这些类型和他们支持的类所在java.lang.annotation包中可以找到：@Target, @Retention, @Docemented, @Inherited

@Target:用于描述注解的使用范围（被描述的注解可以用在什么地方）
@Retention:表示需要在什么级别保存该注解信息，用于描述注解的生命周期(SSOURCE < CLASS < RUNTIME)，一般都是RUNTIME
@Documented:说明该注解被包含在javadoc文档中
@Inherited:说明子类可以继承父类中的该注解

自定义一个简单注解

@Target(value = {ElementType.METHOD, ElementType.TYPE}) //该注解作用在方法和类上使用
@Retention(value = RetentionPolicy.RUNTIME)  //生命周期一般默认为运行时
@Documented
@Inherited
public @interface MyAnnotation{

}

定义一个比较复杂的注解

package com.lily.demo2;

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

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation2 {
    //定义一个注解参数：参数类型 + 参数名()，可以设置默认值
    String name() default "";
    int age() default 0;
    int id() default -1;//默认值为-1代表不存在
    String[] schools();
}

//只有一个值的注解,默认为value，在使用该注解时可以省略value名字
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value() default "";
}

具体使用：

package com.lily.demo2;

public class Test2 {
    @MyAnnotation2(name = "hello",age=24,id=10086, schools={"aaa","bbb","ccc"})  //如果没有默认值就必须给注解赋值
    public void fun1(){ }

    @MyAnnotation3("这是默认值，无需带value")
    public void fun2(){ }
}

反射机制

Java反射机制概述

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

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

正常方式：引入需要的包类名称->通过new实例化->获取实例化对象
反射方式：实例化对象->getClass()方法->得到完整的包类名称

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

缺点：对性能有影响。使用反射基本上是一种解释操作，因此速度比较慢

理解Class类并获取Class实例

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

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

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 getMethod(String name,Class.. T)	返回一个Method对象，此对象的形参类型为paramType
Field[] getDeclareFields()	返回Field对象的一个数组

获取Class对象的三种方式：

package com.lily.demo3;

public class Test1 {
    public static void main(String[] args) throws ClassNotFoundException {
        //第一种方式:通过对象获取
        Person person = new Person();
        Class c1 = person.getClass();

        //第二种方式: 使用Class.forName()
        Class c2 = Class.forName("com.lily.demo3.Person");

        //第三种方式: 通过类名.class
        Class c3 = Person.class;

        System.out.println(c1.hashCode());
        System.out.println(c2.hashCode());
        System.out.println(c3.hashCode());
    }
}

class Person {
    private int id;
    private String name;
}

189568618
189568618
189568618

Process finished with exit code 0

所有类型的Class

package com.lily.demo3;

import java.lang.annotation.ElementType;

// 所有类型的class
public class Test2 {
    public static void main(String[] args) {
        //1. 类class
        Class c1 = Object.class;
        //2. 接口class
        Class c2 = Comparable.class;
        //3. 数组class
        Class c3 = String[].class;
        Class c4 = String[][].class;
        //4. 注解class
        Class c5 = Deprecated.class;
        //5. 枚举class
        Class c6 = ElementType.class;
        //6. Integer class
        Class c7 = Integer.class;
        //7. void class
        Class c8 = void.class;
        //8. Class class
        Class c9 = Class.class;
    }
}

类的加载与ClassLoader

加载：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表该类的java.lang.Class对象
链接：将Java类的二进制代码合并到JVM的运行状态之中的过程
类的初始化

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

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

package com.lily.demo3;

public class Test3 {
    public static void main(String[] args) {
        //获取系统类加载器-->用户自定义编写的类
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
        System.out.println(systemClassLoader);
        //获取系统类加载器的父类加载器-->扩展类加载器-->Java内置的类
        ClassLoader parent = systemClassLoader.getParent();
        System.out.println(parent);
        //获取扩展类加载器的父类加载器-->引导类加载器-->Java核心类库
        ClassLoader superParent = parent.getParent();
        System.out.println(superParent);    //C/C++编写
    }
}

jdk.internal.loader.ClassLoaders$AppClassLoader@36baf30c
jdk.internal.loader.ClassLoaders$PlatformClassLoader@b4c966a
null

Process finished with exit code 0

获取运行时类的完整结构

package com.lily.demo3;

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

//获得类的信息
public class Test5 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c = Class.forName("com.lily.demo3.User");
        //获取类的名字
        String className = c.getName();//获取包名+类名
        System.out.println(className);//com.lily.demo3.User
        String classSimpleName = c.getSimpleName(); //获取类的简单名字
        System.out.println(classSimpleName);//User
        System.out.println("=====================");
        //获得类的属性
        //c.getFields();//只能找到public定义的额属性
        Field[] fields = c.getDeclaredFields(); //找到全部的属性
        for (Field field : fields) {
            System.out.println(field);
        }
        System.out.println("=====================");
        //获得指定属性的值
        Field name = c.getDeclaredField("name");
        System.out.println(name);
        System.out.println("=====================");
        //获得类的方法:可以获得本类的全部方法
        Method[] declaredMethods = c.getDeclaredMethods();
        for (Method method : declaredMethods) {
            System.out.println(method);
        }
        System.out.println("=====================");
        //获得指定方法
        Method method = c.getDeclaredMethod("getName");
        System.out.println(method);
        Method method2 = c.getDeclaredMethod("setName", String.class);
        System.out.println(method2);
        System.out.println("=====================");
        //获得指定的构造器
        Constructor[] constructors = c.getConstructors();
        Constructor[] declaredConstructor = c.getDeclaredConstructors();
        for (Constructor constructor : declaredConstructor) {
            System.out.println(constructor);
        }
        //获得指定的构造器
        Constructor declaredConstructor1 = c.getDeclaredConstructor(String.class, int.class, int.class);
        System.out.println("指定构造器" + declaredConstructor1);
    }
}

class User {
    private String name;
    private int id;
    private int age;

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

    public User() {
    }

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

D:\develop_tools\jdk21\jdk-21.0.1+12\bin\java.exe "-javaagent:D:\Program Files\JetBrains\IntelliJ IDEA 2023.2.3\lib\idea_rt.jar=52734:D:\Program Files\JetBrains\IntelliJ IDEA 2023.2.3\bin" -Dfile.encoding=UTF-8 -Dsun.stdout.encoding=UTF-8 -Dsun.stderr.encoding=UTF-8 -classpath C:\Users\Yihao\IdeaProjects\JVMDemo\out\production\anno com.lily.demo3.Test5
com.lily.demo3.User
User
=====================
private java.lang.String com.lily.demo3.User.name
private int com.lily.demo3.User.id
private int com.lily.demo3.User.age
=====================
private java.lang.String com.lily.demo3.User.name
=====================
public java.lang.String com.lily.demo3.User.getName()
public java.lang.String com.lily.demo3.User.toString()
public void com.lily.demo3.User.setName(java.lang.String)
public int com.lily.demo3.User.getId()
public void com.lily.demo3.User.setId(int)
public int com.lily.demo3.User.getAge()
public void com.lily.demo3.User.setAge(int)
=====================
public java.lang.String com.lily.demo3.User.getName()
public void com.lily.demo3.User.setName(java.lang.String)
=====================
public com.lily.demo3.User(java.lang.String,int,int)
public com.lily.demo3.User()
指定构造器public com.lily.demo3.User(java.lang.String,int,int)

Process finished with exit code 0

调用运行时类的指定结构

package com.lily.demo3;

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

// 通过你反射动态的创建对象
public class Test6 {
    public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        Class<?> c = Class.forName("com.lily.demo3.People");
        //构造一个对象
//        People p = (People) c.getDeclaredConstructor().newInstance();//默认调用无参构造器,如果没有无参构造器，则会实例化失败
//        System.out.println(p);

        //通过构造器创建对象(有参构建对象)
        People p1 = (People) c.getDeclaredConstructor(String.class, int.class, int.class).newInstance("lily", 1, 20);
        System.out.println(p1);

        //通过反射获取方法
        Method method = c.getDeclaredMethod("setName", String.class);
        method.invoke(p1, "update_string");//invoke(对象,"参数值");--->执行方法
        System.out.println(p1);

        //通过反射操作属性
        People p3 = (People) c.getDeclaredConstructor().newInstance();
        Field name = c.getDeclaredField("name");
        //不能直接操作私有属性，我们需要关闭程序安全检测: 属性.setAccessible(true);
        name.setAccessible(true);
        name.set(p3, "hello");
        System.out.println(p3);
    }
}

class People {
    private String name;
    private int id;
    private int age;

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

    public People() {
    }

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

获取注解信息

package com.lily.demo4;

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

// 练习反射操作注解
public class Test9 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        //根据反射获取类对象
        Class<?> studentClass = Class.forName("com.lily.demo4.Student");
        //通过反射获取注解
        Annotation[] annotations = studentClass.getDeclaredAnnotations();
        for (Annotation a : annotations) {
            System.out.println(a);
        }

        System.out.println("================");
        //获取类上的注解值
        //根据Class对象获取其类上的注解对象
        Table table = (Table) studentClass.getDeclaredAnnotation(Table.class);
        //获取其注解对象上的值
        System.out.println(table.value());
        System.out.println("******************");

        //根据Class对象获取其所有字段
        Field[] fieldArray = studentClass.getDeclaredFields();
        for (Field f1 : fieldArray) {
            System.out.println(f1.getName());	//获取字段名
            Field f = studentClass.getDeclaredField(f1.getName());//根据字段名获取指定的字段对象
            //根据字段对象获取其上自定义的注解对象
            MyField myFieldAnnotation = f.getDeclaredAnnotation(MyField.class);
            //根据注解对象获取器注解上对应的值
            System.out.println(myFieldAnnotation.columnName());
            System.out.println(myFieldAnnotation.length());
            System.out.println(myFieldAnnotation.type());
        }
        System.out.println("******************");


        System.out.println("================");
        //获取类字段上的注解值
        Field f = studentClass.getDeclaredField("name");
        MyField myFieldAnnotation = f.getDeclaredAnnotation(MyField.class);
        System.out.println(myFieldAnnotation.columnName());
        System.out.println(myFieldAnnotation.length());
        System.out.println(myFieldAnnotation.type());
    }
}

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

//属性注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface MyField {
    String columnName();

    String type();

    int length();
}

@Table(value = "db_student")
class Student {
    @MyField(columnName = "db_id", type = "int", length = 10)
    private int id;
    @MyField(columnName = "db_age", type = "int", length = 5)
    private int age;
    @MyField(columnName = "db_name", type = "varchar", length = 3)
    private String name;

    public Student() {
    }

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

D:\develop_tools\jdk21\jdk-21.0.1+12\bin\java.exe "-javaagent:D:\Program Files\JetBrains\IntelliJ IDEA 2023.2.3\lib\idea_rt.jar=53190:D:\Program Files\JetBrains\IntelliJ IDEA 2023.2.3\bin" -Dfile.encoding=UTF-8 -Dsun.stdout.encoding=UTF-8 -Dsun.stderr.encoding=UTF-8 -classpath C:\Users\Yihao\IdeaProjects\JVMDemo\out\production\anno com.lily.demo4.Test9
@com.lily.demo4.Table("db_student")
================
db_student
******************
id
db_id
10
int
age
db_age
5
int
name
db_name
3
varchar
******************
================
db_name
3
varchar

Process finished with exit code 0

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。

Java反射和注解基本用法