Java注解和反射

最新推荐文章于 2024-07-23 21:45:09 发布

漂泊老猫

最新推荐文章于 2024-07-23 21:45:09 发布

阅读量53

点赞数

分类专栏： Java后端文章标签： java 开发语言

本文链接：https://blog.csdn.net/qq_44799103/article/details/128505921

版权

Java后端专栏收录该内容

24 篇文章 0 订阅

订阅专栏

注解Java.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中，用来抑制编译时的警告信息。
- 与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好的，选择性使用就好
- @SupressWarnings(“all”)
- @SupressWarnings(“unchecked”)
- @SupressWarnings(value={“unchecked”,“deprecation”})
- 等等

package com.laomao.annotation;

import java.util.ArrayList;
import java.util.List;

// 什么是注解
public class Test01 extends Object {

    // 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    // 不推荐使用
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    @SuppressWarnings("all")
    public void test02(){
        List list = new ArrayList<>();

    }

    public static void main(String[] args) {
        test();
    }
}

元注解

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

package com.laomao.annotation;

import java.lang.annotation.*;

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


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

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

// 表示是否将我们的注解生成在Javadoc中
@Documented

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

自定义注解

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

package com.laomao.annotation;

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

public class Test03 {
    // 注解可以显示赋值，如果没有默认值，我们就必须给注解
    @MyAnnotation2(name = "老猫")
    public void test(){}
    
    @MyAnnotation3("laomao")
    public void test2(){}
    
    
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    // 注解的参数： 参数类型 + 参数名（）；
    String name() default "";
    int age() default 0;
    int id() default -1;    // 如果默认值为-1，代表不存在
    
    String[] schools() default "";
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
}

反射Java.Reflection

Java反射机制概述

静态VS动态语言

动态语言

是一类在运行是可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。
主要动态语言：Object-C、C#、JavaScript、PHP、Python等。

静态语言

与动态语言相对应的，运行时结构不可变的语言就是静态语言。如Java、C、C++。
Java不是动态语言，但Java可以称为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活。

Java Reflection

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

Java反射机制研究及应用

Java反射机制提供的功能

在运行时判断任意一个对象所属的类
在运行时构造任意一个类的对象
在运行时判断任意一个类所具有的成员变量和方法
在运行时获取泛型信息
在运行时调用任意一个对象的成员变量和方法
在运行时处理注解
生成动态代理
。。。

Java反射的优缺点

优点：可以实现动态创建对象和编译，体现出很大的灵活性
缺点：对性能有影响，使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

package com.laomao.reflection;

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

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

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

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

    public User() {
    }

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

理解Class类并获取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类的实例

若已知具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高。
Class clazz = Person.class;
已知某个类的实例，调用该实例的getClass()方法获取Class对象
Class clazz = person.getClass();
已知一个类的全类名，且该类在类路径下，可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException
Class clazz = Class.forName(“demo01.Student”);
内置基本数据类型可以直接用类名.Type
还可以利用ClassLoader

package com.laomao.reflection;

public class Test03 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("这个人是："+person.name);

        // 方式一：通过对象获得
        Class c1 = person.getClass();

        // 方式二：forName获得
        Class<?> c2 = Class.forName("com.laomao.reflection.Student");

        System.out.println(c1.hashCode());
        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;

    public Person(){

    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

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

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

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

哪些类型可以有Class对象

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

package com.laomao.reflection;

import java.lang.annotation.ElementType;

public class Test04 {
    public static void main(String[] args) {
        Class<Object> c1 = Object.class;
        Class<Comparable> c2 = Comparable.class;
        Class<String[]> c3 = String[].class;
        Class<int[][]> c4 = int[][].class;
        Class<Override> c5 = Override.class;
        Class<ElementType> c6 = ElementType.class;
        Class<Integer> c7 = Integer.class;
        Class<Void> c8 = void.class;
        Class<Class> c9 = 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());
    }
}

类的加载与ClassLoader

类加载内存分析

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

分析类初始化

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

类加载器的作用

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

创建运行时类的对象

package com.laomao.reflection;

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

// 获取类的信息
public class Test06 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class<?> c1 = Class.forName("com.laomao.reflection.User");

        // 获得类的名字
        System.out.println(c1.getName());   // 获得包名+类名
        System.out.println(c1.getSimpleName()); // 获得类名

        // 获得类的属性
        Field[] fields = c1.getFields();       // 只能找到public属性
        fields = c1.getDeclaredFields();    //找到全部的属性
        for (Field field : fields){
            System.out.println(field);
        }

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

        // 获得类的方法
        Method[] methods = c1.getMethods();
        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);
        
        // 获得指定的构造器
        Constructor[] constructors = c1.getConstructors();
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
        constructors = c1.getDeclaredConstructors();
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
    }
}

在实际的操作中，取得类的信息的操作代码，并不会经常开发
一定要熟悉java.lang.reflect包的作用，反射机制
如何取得属性、方法、构造器的名称，修饰符等。

有了Class对象，能做什么？

创建类的对象：调用Class对象的newInstance()方法
- 类必须有一个无参构造器
- 类的构造器的访问权限需要足够

package com.laomao.reflection;

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

// 动态的创建对象，通过反射
public class Test07 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        // 获得Class对象
        Class<?> c1 = Class.forName("com.laomao.reflection.User");

//        // 构造一个对象
//        User user = (User)c1.newInstance();
//        System.out.println(user);
//
//        // 通过构造器创建对象
//        Constructor<?> constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
//        Object user2 = constructor.newInstance("老猫", 001, 18);
//        System.out.println(user2);
//
        // 通过反射调用普通方法
        User user3 = (User)c1.newInstance();
        // 通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);

        // invoke : 激活的意思
        // (对象，"方法的值")
        setName.invoke(user3, "laomao");
        System.out.println(user3.getName());

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

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

性能对比分析

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

package com.laomao.reflection;

import com.laomao.annotation.Test01;

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

// 分析性能问题
public class Test08 {

    // 普通方式调用
    public static void test01(){
        User user = new User();

        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 10_0000_0000; i++) {
            user.getName();
        }
        long endTime = System.currentTimeMillis();
        System.out.println("time:"+(endTime-startTime));
    }

    //反射方式调用
    public static void test02() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();

        Method getName = c1.getDeclaredMethod("getName", null);

        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 10_0000_0000; i++) {
            getName.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("time:"+(endTime-startTime));
    }
    // 反射方式调用，关闭检测
    public static void test03() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();

        Method getName = c1.getDeclaredMethod("getName", null);
        getName.setAccessible(true);

        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 10_0000_0000; i++) {
            getName.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("time:"+(endTime-startTime));
    }

    public static void main(String[] args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {
        test01();
        test02();
        test03();
    }
}

反射操作泛型

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

package com.laomao.reflection;

import com.sun.javafx.collections.MappingChange;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;

// 通过反射获取泛型
public class Test09 {

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

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

    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Test09.class.getMethod("test01", MappingChange.Map.class, List.class);

        Type[] genericParameterTypes = method.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println(genericParameterTypes);
            if (genericParameterType instanceof ParameterizedType){
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }
    }

}

反射操作注解

getAnnotations
getAnnotation

练习ORM

Object relationship Mapping --> 对象关系映射
class Student{
int id;
String name;
int age;
}

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

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

package com.laomao.reflection;

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

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

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

        // 获得注解value的值
        Tablemao tablemao = (Tablemao)c1.getAnnotation(Tablemao.class);
        String value = tablemao.value();
        System.out.println(value);

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

@Tablemao("db_student")
class Student2{

    @FiledMao(columnName = "db_id",type="int",length=10)
    private int id;
    @FiledMao(columnName = "db_age",type="int",length=10)
    private int age;
    @FiledMao(columnName = "db_name",type="varchar",length=3)
    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 Tablemao{
    String value();
}

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