Java 注解和反射

-Kk

于 2020-11-20 18:30:42 发布

阅读量135

点赞数

文章标签： java

本文链接：https://blog.youkuaiyun.com/weixin_44694641/article/details/109856653

版权

Java注解专栏收录该内容

1 篇文章

订阅专栏

1. 注解（Annotation）

一、作用

可以被其他程序(比如：编译器等)读写
不是程序本身，可以对程序做出解释。（这一点和注释没有区别）

二、格式

注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value="unchecked).

三、例子

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

四、内置注解

（1）Override

适用于修饰方法，表示一个方法声明da’suan重写超类中的另一个方法声明。

（2）Deprecated

此注释可以用于修饰方法、属性、类、表示不鼓励程序员使用这样的元素。

（3）SuppressWarning

与前两个不同，你需要添加一个参数才可以使用，这些参数都定义好了我们选择性使用就好了。

@SuppressWarning(“all”)
@SuppressWarning(“unchecked”)
@SuppressWarning(value={“unchecked”,“deprecation”})
…

五、元注解

元注解的作用就是负责注解其他注释，Java定义了四个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明
这些类型和它们所支持的类在java.lang.annotation包中可以找到（@Target，@Retention，@Documented，@Inherited)

@Target：表示描述注解的使用范围（即：被描述的注解可以用在什么地方)
@Retention：表示需要在什么级别保存该信息，用于描述注解的生命周期(SOURCE<CLASS<RUNTIME)
@Document：说明该注解将被包含在javadoc中
@Inherited：说明子类可以继承父类中的该注解

// Target 表示注解可以用在什么地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})

// Retention 表示我们的注解还有效
// RUNTIME>CLASS>SOURCE
@Retention(value= RetentionPolicy.RUNTIME)

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

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

六、自定义注解

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

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

注解的参数：参数类型+参数名();

当参数名称为value时，使用的的时候可以省略value=

package com.mango;

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

// 自定义注解
public class Demo03 {

    // 注解可以显示赋值，如果没有默认值，就必须给注解赋值
    @MyAnnotation2(name = "张梓康",school = {"西北大学"})
    public void test(){}

    @MyAnnotation3("QWE")
    public void test2(){

    }
}

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{

    // 注解的参数：参数类型+参数名();
    String name() default "";
    int age() default 0;
    int id() default -1; // 如果默认值为-1 代表不存在
    String[] school() default {"西部开源"};
}

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

2.反射

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

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

在这里插入图片描述

一、优点

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

二、缺点

对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且他满足我们的要求。这类操作总是慢于直接执行相同的操作。

三、使用

一个类在内存中只有一个Class对象
一个类被加载后，类的整个都会被封装在Class对象中

package com.mango.refection;

// 什么是反射
public class Test01 extends Object{
    public static void main(String[] args) throws ClassNotFoundException {
        // 通过反射获取类的Class对象
        Class c1 = Class.forName("com.mango.refection.User");

        System.out.println(c1);

    }
}

// 实体类：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 +
                '}';
    }
}

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

四、Class类

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

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

常用方法

在这里插入图片描述

五、获得类的实例

		Person person = new Student();
        System.out.println("这个人是："+person.getName());
        
        // 方式1：通过对象获得
        Class c1 = person.getClass();
        System.out.println(c1.hashCode());

        // 方式2：forname获得
        Class c2 = Class.forName("com.mango.refection.Student");
        System.out.println(c2.hashCode());

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

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

获取父类的实例

		Class c5 = c1.getSuperclass();
        System.out.println(c5.hashCode());

六、哪些类型可以有Class对象？

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

package com.mango.refection;

import java.lang.annotation.ElementType;

// 所有类型的Class对象
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; // void类型
        Class<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);

        int[] a = new int[10];
        int[] b =new int[100];
        System.out.println(a.getClass().hashCode());
        System.out.println(b.getClass().hashCode());
    }
}

只要元素类型与维度一样，就是同一个Class。

七、类的初始化

加载：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区运行时数据结构，然后生成一个代表这个类的Class对象。

链接：将Java的二进制代码合并到JVM的运行状态之中的过程。

  - 验证：确保加载的类信息符合JVM规范，没有安全方面的问题。
  - 准备：正式为类变量（static）分配内存并设置类默认初始值的阶段，这些内存都将在方法区中进行分配。
  - 解析：虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程。

初始化：

  - 执行类构造器<clinit>()方法的过程。类构造器<clinit>()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。（类构造器是构造类信息的，不是构造该类对象的构造器）
  - 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发父类的初始化。
  - 虚拟机会保证一个类的<clinit>()方法在多线程环境中被正确加锁和同步。

7.1 主动初始化

package com.mango.refection;

// 测试类什么时候会初始化
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.mango.refection.Son");
    }
}
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;
}

7.2 不会被初始化

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

         Son[] array = new Son[5];

        System.out.println(Son.M);

八、获得类的信息

package com.mango.refection;

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.mango.refection.User");

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

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

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

        // 获得类的方法
        System.out.println("=============");


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

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

        // 获得本类的所有方法
        Method[] declaredMethods = c1.getDeclaredMethods();
        for (Method declaredMethod : declaredMethods) {
            System.out.println(declaredMethod);
        }
        System.out.println("=============");

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

        // 获得指定构造器
        Constructor[] constructors = c1.getConstructors();
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
        Constructor[] declaredConstructors = c1.getDeclaredConstructors();
        for (Constructor declaredConstructor : declaredConstructors) {
            System.out.println(declaredConstructor);
        }

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

    }
}

九、小结

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

十、创建一个新的类

通过newInstance()方法可以获得一个新的类。

package com.mango.refection;

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.mango.refection.User");

        // 构造一个对象
        User user =(User) c1.newInstance(); // 本质是调用了类的无参构造
        System.out.println(user);

        // 通过构造器创建对象
        Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        User user1 =(User) declaredConstructor.newInstance("张梓康", 12, 123);
        System.out.println(user1);

        // 通过反射调用普通方法
        User user3 = (User) c1.newInstance();

        // 通过反射获取方法
        Method setName = c1.getDeclaredMethod("setName", String.class);

        // invoke：激活的意思
        // （对象，“方法值”）
        setName.invoke(user3,"zzk");
        System.out.println(user3.getName());

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

        // 不能操作私有属性，我们需要关闭程序的安全检测
        // 通过setAccessible关闭一个权限 true为关掉 false为打开
        name.setAccessible(true);
        name.set(user4,"gyx");
        System.out.println(user4.getName());
    }
}

10.1 setAccessible

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

10.2 性能检测

package com.mango.refection;


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

// 分析性能
public class Test10 {

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

        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {
            user.getName();
        }

        long endTime = System.currentTimeMillis();

        System.out.println("普通方式执行："+(endTime-startTime)+"ms");
    }

    // 反射方式
    public static void test02() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();
        Method getName = c1.getMethod("getName", null);
        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }

        long endTime = System.currentTimeMillis();

        System.out.println("反射方式执行："+(endTime-startTime)+"ms");
    }

    // 反射方式，关闭检测
    public static void test03() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();
        Method getName = c1.getMethod("getName", null);
        getName.setAccessible(true);
        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }

        long endTime = System.currentTimeMillis();

        System.out.println("反射方式，关闭检测执行："+(endTime-startTime)+"ms");
    }

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

十一、操作泛型

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

package com.mango.refection;

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 Test11 {
    public static void test01(Map<String,User> map , List<User> list){
        System.out.println("test01");
    }

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

    public static void main(String[] args) throws NoSuchMethodException {
        Method m1 = Test11.class.getMethod("test01", Map.class, List.class);
        Type[] genericParameterTypes = m1.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println(genericParameterType);
            if(genericParameterType instanceof ParameterizedType){
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }
        Method m2 = Test11.class.getMethod("test02", null);
        Type genericReturnType = m2.getGenericReturnType();
        if(genericReturnType instanceof ParameterizedType){
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}

3. 练习：ORM

Object relationship Mapping --> 对象关系映射

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

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

package com.mango.refection;

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

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

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

        // 获得注解value的值
        TableMango annotation =(TableMango) aClass.getAnnotation(TableMango.class);
        System.out.println(annotation.value());

        // 获得类指定的注解
        Field name = aClass.getDeclaredField("id");
        FieldMango annotation1 = name.getAnnotation(FieldMango.class);
        System.out.println(annotation1.columnName());
        System.out.println(annotation1.type());
        System.out.println(annotation1.length());
    }
}

@TableMango("db_student")
class Student2{
    @FieldMango(columnName = "db_id",type = "int",length = 10)
    private int id;
    @FieldMango(columnName = "db_age",type = "int",length = 10)
    private int age;
    @FieldMango(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;
    }

    @Override
    public String toString() {
        return "Student2{" +
                "id=" + id +
                ", age=" + age +
                ", 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;
    }
}

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

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