注解与反射

姜伯約

已于 2023-03-31 10:25:01 修改

阅读量50

点赞数

文章标签： java

于 2023-03-31 10:20:28 首次发布

本文链接：https://blog.csdn.net/clover_page/article/details/129873515

版权

注解与反射

一、注解

1-1、概念

Annotation是从JDK5.0开始引入的新技术
Annotation的作用
- 不是程序本身，可以对程序作出解释（这一点和注释(comment)没什么区别）
- $\textcolor{red}{可以被其他程序（比如：编辑器等）读取}$
Annotation的格式
- 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarinings(value=“unchecked”)
Annotation在哪里使用？
- 可以附加在package，class，method，filed等上面，相当于给它们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

package com.Jiang.annotation;
//什么是注解
public class Test01 extends Object {
    //@Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
}

1-2、内置注解

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

1-3、元注解

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

package com.Jiang.annotation;

import java.lang.annotation.*;

//测试元注解
public class Test02 {
    @MyAnnotation
    public void test(){

    }
}

//定义一个注解
//Target 表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})

//Retention 表示我们的注解在什么地方还有效
//runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)

//Docemented 表示将我们的注解生成javaDoc
@Documented

//Inferited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation{
}

1-4、自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口
分析
- @interface用来声明一个注解，格式：public @interface 注解名｛定义内容｝
- 其中每一个方法实际上是声明一个配置参数
- 方法的名称就是参数的名称
- 返回值的类型就是参数的类型（返回值只能是基本类型，Class，String，enum）
- 可以通过default来声明参数的默认值
- 如果只有一个参数成员，一般参数名为value
- 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值

二、反射机制

2-1、Java反射机制概述

Reflection（反射）是Java被视为动态语言的关键，反射机制允许程序在执行期间借助于Reflection API取得任何类的内部信息，并能直接操作任意对象的内部属性及方法。 $\textcolor{blue}{(Class c = Class.forName("java.lang.String"))}$
加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以，我们形象的称之为：反射。

package com.Jiang.reflection;
//何为反射
public

class Test01 {
    public static void main(String[] args) throws ClassNotFoundException {
        //通过反射获取类的Class对象
        Class c1 = Class.forName("com.Jiang.reflection.User");
        System.out.println(c1);

        Class c2 = Class.forName("com.Jiang.reflection.User");
        Class c3 = Class.forName("com.Jiang.reflection.User");
        Class c4 = Class.forName("com.Jiang.reflection.User");

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

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

    public User() {
    }

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

    public String getName() {
        return Name;
    }

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

2-2、理解Class类并获取Class实例

2-2-1、Classe类

在Object类中定义了以下方法，此方法将被所有子类继承==( public final Class getClass() )==
以上方法返回值的类型就是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解，即：可以通过反射求出类的名称。

在这里插入图片描述

对象照镜子之后可以得到的信息：某个类的属性、方法和构造器、某个类到底实现了哪些接口。对于每个类而言，JRE都为其保留了一个不变的Class类型的对象。一个Class对象包含了特定某个结构（class/interface/enum/annotation/primitive type/void/[]）的有关信息。
- Class本身也是一个类
- Class对象只能由系统建立对象
- 一个加载的类在JVM中只会有一个Class实例
- 一个Class对象对应的是一个加载到JVM中的一个.Class文件
- 每个类的实例都会记得自己是由哪个Class实例所生成
- 通过Class可以完整地得到一个类中的所有被加载的结构
- Class类是Reflection的根源，针对任何想加载、运行的类，唯有先获得相应的Class对象

2-2-2、Class类的常用方法

在这里插入图片描述

2-2-3、获取Class类的实例

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

Class clazz = Person.class;
已知某个类的实例，调用该实例的getClass()方法获取Class对象

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

Class clazz = Class.forName(“demo01.Person”)
内置基本数据类型可以直接用类名.Type
利用ClassLoader

package com.Jiang.reflection;
//测试class类的创建方式
public class Test02 {
    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.Jiang.reflection.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);

        //获得父类类型
        Class c5 = c1.getSuperclass();
        System.out.println(c5);
    }
}

class Person{
    public String name;

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

    public Person() {
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}

class Student extends Person{
    public Student() {
        this.name = "学生";
    }
}

class Teacher extends Person{
    public Teacher() {
        this.name = "老师";
    }
}

2-2-4、可以有Class对象的类型

class：外部类，成员（成员内部类，静态内部类），局部内部类，匿名内部类。
interface：接口
[]：数组
enum：枚举
an’notation：注解@interface
primitive type：基本数据类型
void

package com.Jiang.reflection;

import java.lang.annotation.ElementType;

//所有类型的class
public class Test03 {
    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.hashCode());
        System.out.println(b.hashCode());
    }
}

2-3、类的加载与ClassLoader

2-3-1、类的加载

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

在这里插入图片描述

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

package com.Jiang.reflection;

public class Test04 {
    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;
            }
            m = 100
         */
    }
}

class A{

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

    static int m = 100;

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

2-3-2、类初始化

类的主动引用（一定会发生初始化）
- 当虚拟机启动，先初始化main方法所在的类
- new一个类的对象
- 调用类的静态成员（除了final常量）和静态方法
- 使用java.lang,reflect包的方法对类进行反射调用
- 当初始化一个类，如果其父类没有被初始化，则先会初始化它的父类
类的被动引用（不会发生类的初始化）
- 当访问一个静态域时，只有真正声明这个域的类才会被初始化。如：当通过子类引用父类的静态变量，不会导致子类初始化
- 通过数组定义类引用，不会触发此类的初始化
- 引用常量不会触发此类的初始化（常量在链接阶段就存入调用类的常量池中）

package com.Jiang.reflection;
//测试类什么时候会初始化
public class Test06 {
    static {
        System.out.println("Main类被加载");
    }

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

        //反射也会产生主动引用
        //Class.forName("com.Jiang.reflection.Son");

        //不会产生类的引用方法
        //System.out.println(Son.b);

        //Son[] sons = new Son[5];

        System.out.println(Son.M);
    }
}

class Father{
    static int b = 2;

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

class Son extends Father{
    static {
        System.out.println("子类被加载");
        m = 300;
    }

    static int m = 100;
    static final int M = 1;
}

2-3-3、类加载器的作用

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

在这里插入图片描述

2-4、创建运行类的对象

2-4-1、获取运行时类的完整结构

通过反射获取运行时类的完整结构：Field、Method、Construc’to’r、Superclass、Interface、Annoation

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

package com.Jiang.reflection;

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.Jiang.reflection.User");

        //获得类的名字
        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);
        }

        //获得指定属性的值
        System.out.println("==================");
        Field name = c1.getDeclaredField("Name");
        System.out.println(name);

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

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

        //获得指定的构造器
        System.out.println("==============");
        Constructor[] constructors = c1.getConstructors();  //获得public
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
        constructors = c1.getDeclaredConstructors();    //获得全部
        System.out.println("$"+constructors);

        //获得指定的构造器
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        System.out.println(constructor);
    }
}

2-4-2、创建类的对象

创建类的对象：调用Class对象的newInstance()方法
- 类必须有一个无参构造器
- 类的构造器的访问权限需要足够
步骤如下
1. 通过Class类的getDeclaredConstructor(Class…parameterTypes)取得本类的指定形参类型的构造器
2. 向构造器的形参中传递一个对象组进去，里面包含了构造器中所需的各个参数
3. 通过Constructor实例化对象

2-4-3、调用指定的方法

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

通过Class类的getMethod(String name,Class…parameterTypes)方法取得一个Method对象，并设置此方法操作时所需要的参数类型
之后使用Object invoke(Object obj, Object[] args)进行调用，并向方法中传递有设置的obj对象的参数信息。

在这里插入图片描述

2-4-4、setAccessible

Method和Field、Constructor对象都有setAccessible()方法。
setAccessible作用是启动和禁用访问安全检查的开关。
参数值为true则指示反射的对象在使用时应该取消Java语言访问检查。
- 提高反射的效率。如果代码中必须用反射，而该句代码需要频繁的被调用，那么设置为true。
- 使得原本无法访问的私有成员也可以访问
参数值为false则指示反射的对象应该实施Java语言访问检查

package com.Jiang.reflection;

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, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //获得class对象
        Class c1 = Class.forName("com.Jiang.reflection.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("姜伯约", 001, 26);
        //System.out.println(user2);

        //通过反射调用普通方法
        User user3 = (User)c1.newInstance();
        //通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        //invoke:激活
        //（对象，"方法的值"）
        setName.invoke(user3,"姜维");
        System.out.println(user3.getName());

        //通过反射操作属性
        User user4 = (User)c1.newInstance();
        Field name = c1.getDeclaredField("Name");

        //不能直接操作私有属性，我们需要关闭程序的安全检查，属性或方法的setAccessible(true)
        name.setAccessible(true);   
        name.set(user4,"姜伯约");
        System.out.println(user4.getName());
    }
}

2-5、反射操作注解

getAnnotations
getAnnotation

package com.Jiang.reflection;
import java.lang.annotation.*;

//练习反射操作注解
public class Test10 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.Jiang.reflection.Student2");

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

        //获得注解value的值
        Table table = (Table) c1.getDeclaredAnnotation(Table.class);
        String value = table.value();
        System.out.println(value);

        //获得类指定的注解
        java.lang.reflect.Field f = c1.getDeclaredField("name");
        Field annotation = f.getAnnotation(Field.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}

@Table("db_student")
class Student2{
    @Field(columnName = "db_id",type = "int",length = 10)
    private int id;
    @Field(columnName = "db_age",type = "int",length = 10)
    private int age;
    @Field(columnName = "db_name",type = "varchar",length = 10)
    private String name;

    public Student2() {
    }

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

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

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

}

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

}

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

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

package com.Jiang.reflection;
import java.lang.annotation.*;

//练习反射操作注解
public class Test10 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.Jiang.reflection.Student2");

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

        //获得注解value的值
        Table table = (Table) c1.getDeclaredAnnotation(Table.class);
        String value = table.value();
        System.out.println(value);

        //获得类指定的注解
        java.lang.reflect.Field f = c1.getDeclaredField("name");
        Field annotation = f.getAnnotation(Field.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}

@Table("db_student")
class Student2{
    @Field(columnName = "db_id",type = "int",length = 10)
    private int id;
    @Field(columnName = "db_age",type = "int",length = 10)
    private int age;
    @Field(columnName = "db_name",type = "varchar",length = 10)
    private String name;

    public Student2() {
    }

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

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

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

姜伯約

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
注解与反射

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口分析@interface用来声明一个注解，格式：public @interface 注解名｛定义内容｝其中每一个方法实际上是声明一个配置参数方法的名称就是参数的名称返回值的类型就是参数的类型（返回值只能是基本类型，Class，String，enum）可以通过default来声明参数的默认值如果只有一个参数成员，一般参数名为value。
复制链接

扫一扫