注解与反射学习笔记

注解与反射

注解

什么是注解

Annotation是JDK5开始引入的技术

注解是对程序作出解释

注解和注释有什么不一样

注解是解释给程序的，注释是解释给人的

注解的格式：

注解是以“@注解名”在代码中存在，还可以添加参数值，例如@SuppressWarning（value=“unchecked”）

注解可以在哪使用

可以在package、class、method、field等，相当于起辅助功能，我们可以通过反射机制编程实现对这些元数据的访问

内置注解

内置注解是程序自带的注解

常用的三个内置注解：

• @Override

  表示重写超类中的方法声明

• @Deprecated

  表示废弃，不建议使用

• @SuppressWarnings

  表示忽略警告信息

参数	说明
depreciation	使用了过时的类或方法的警告
unchecked	执行了未检查的转换时的警告 如：使用集合时未指定泛型
fallthrough	当在switch语句使用时发生case穿透
path	在类路径、源文件路径中有不存在路径的警告
serial	当在序列化的类上缺少serialVersionUID定义时的警告
finally	任何finally子句不能完成时的警告
all	关于以上所有的警告

上表中就是@suppressWarnings注解的一些参数，按需使用即可

@suppressWarnings(“finally”)

@suppressWarnings(value={“unchecked”,“path”})

元注解

元注解的作用：

元注解的作用就是负责注解其他注解，java中定义了四个标准的meta-annotation类型，他们是被用来提供对其他annotion的类型作说明

这些类型在java.lang.annotation中：

• @Target：用于描述注解的使用范围，例如：类、方法
• @Retention：表示需要在什么级别保存该注解信息，用于描述注解的生命周期，一般在Runtime中
• @Document：说明该注解将被包含在javadoc中
• @Inherited：说明子类可以继承父类中的该注解

package com.annotation.Demo;
import com.sun.istack.internal.Interned;
import java.lang.annotation.*;
/**
 * 元注解,自定义注解
 */
public class AnnotationDemo1 {
    //    注解可以显示赋值，没有默认值，我们就必须给注解赋值
//    例如下面的annotation2中
    //    不赋值就会报红
    @annotation2(age = 22)
    public void test2() {
    }
    //    注解中有默认值，不赋值也不影响程序运行编译
    @annotation3(age = 11)
    public void test3() {
    }
    //当只有一个参数的时候可以直接用value来代替，只能用value不能用其他名字代替
    @annotation1(value = "11", age = 11,cource = 11.1)
    public void test() {
    }
    @annotation
    public void test4(){
    }
}
@Target({ElementType.TYPE, ElementType.METHOD})
@interface annotation2 {
    int age();
}
//注解的参数：can'shu'lei'can'shu'lei'xt({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@interface annotation1 {
    String value();
    int age();
    double cource();
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@interface annotation3 {
    //    String name() default  "小明";   默认值在括号后面加上 default 再加默认值
    String name() default "小红";
    int age();
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@interface annotation{
    //默认值为"" 0
    String name() default "";
    int age() default 0;
}

分析：

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

反射

反射机制

java Reflection

• Reflection 反射：是java被视为准动态语言的关键，反射机制是指程序在执行期间借助于Reflection API取得任何类的内部信息，并且能直接操作任意对象的内部属性及方法

获取class

//第一种方式 通过Class类的静态方法——forName()来实现
class1 = Class.forName("com.xxxx.User");
//第二种方式 通过类的class属性
class1 = Object.class;
//第三种方式 通过对象getClass方法
Object obj = new Object();
Class<?> class1 = obj.getClass();

• 当类加载完后，在堆内存的方法区中就会产生一个Class类型的对象，一个类只有一个Class对象，这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一潭清澈如镜的湖水，透过湖面我们可以看到类的内部结构，所以我们称之为”反射“。

用游戏中外挂来理解就是：在游戏进行中，启动外挂，就是在运行的过程中创建类的对象。

正常方式：需要引入”包类“名称 >>> 通过new方法来实例化 >>> 取得实例化对象

反射方式：实例化对象 >>> getClass() >>> 得到完整的”包类"名称

反射的基本操作

Class aClass = Class.forName("com.xxxx.User");
//获取全类名
String name = aClass.getName();
//获取简单的类名
String simpleName = aClass.getSimpleName();
//根据字段名获取该类的public字段
Field field = aClass.getField("age");
//根据方法名获取该类的方法
Method declaredMethod = aClass.getDeclaredMethod("getName");

类的实例化

Class aClass = Class.forName("com.xxxx.User");
//通过class类直接实例化，使用的是User类的无参构造器
User user = (User) aClass.newInstance();

调用类的方法

//首先需要获得与该方法对应的Method对象
Method method = class1.getDeclaredMethod("setAge", int.class);
//调用指定的函数并传递参数
method.invoke(obj, 28);

Java反射机制研究及应用

Java反射机制提供的功能：

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

Class类

Class对于反射而言是极为重要的，对象在反射后得到的信息：某个类的属性、方法和构造器、某个类到底实现了哪些接口、继承了哪些类。对于每个类而言，JRE都为它保留了一个不变的Class类型的对象，一个Class对象包含了特定某个结构的class、interface、enum、annotation、primitive type、void、[]等有关信息

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

方法名	功能说明
static ClassforName(String name)	返回指定类名name的Class对象
Object newInstance()	调用缺省构造函数，返回Class对象的一个实例
getName()	返回此Class对象所表示的实体（类，接口，数组类或void）的名称
Class getSuperClass()	返回当前Class对象的父类的Class对象
Class[] getInterfaces()	获取当前Class对象的接口
ClassLoader getClassLoader()	返回该类的类加载器
Constructor[] getConstructors()	返回一个包含某些构造器对象的数组
Method getMethod(String name,Class… T)	返回一个Method对象，此对象的形参类型为paramType
Field[] getDeclaredFields()	返回Field对象的一个数组

Java内存分析

Java内存

• 堆：
  • 存放new的对象和数组
  • 可以被所有的线程共享，不会存放别的对象引用
• 栈：
  • 存放基本变量类型（包含这个基本类型的具体数值）
  • 引用对象的变量（会存放这个引用在堆里面的具体地址）
• 方法区：
  • 可以被所有的线程共享
  • 包含了所有的class和static变量

类加载的过程

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

• 类的加载（Load）：将类的class文件读入内存中，并为之创建一个java.lang.Class对象，这个过程由类加载器完成
• 类的链接（Link）：将类的二进制数据合并到JRE中
• 类的初始化（Initialize）：JVM负责对类进行初始化

类的主动引用：

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

类的被动引用：

• 当访问一个静态代码块的时候，只有真正声明这个代码块的类才会被初始化，例如：当通过子类引用父类的静态变量，不会导致子类初始化
• 通过数组定义类引用，不会触发此类的初始化
• 引用常量也不会触发初始化

public class Demo5 {
    static {
        System.out.println("main类被加载");
    }
    public static void main(String[] args) throws ClassNotFoundException {
//        主动引用，先加载父类再加载子类
//        Son son=new Son();
//        反射会产生主动引用
//        Class.forName("com.reflection.Demo.Demo5");
//        引用常量不会触发类的引用的方法,通过子类调用父类常量不会触发初始化
//          System.out.println(Son.b);
            System.out.println(Son.m);
    }
}
class Father{
    static int b=2;
    static{
        System.out.println("父类被加载");
    }
}
class Son extends Father{
    static int c=3;
    static {
        System.out.println("子类被加载");
    }
        static final int m=1;
}

类加载器的作用

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

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

public class Demo1 {
    public Demo1() throws ClassNotFoundException {
    }
    public static void main(String[] args) throws ClassNotFoundException {
        //    获取系统类加载器
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
        System.out.println(systemClassLoader);
        //sun.misc.Launcher$AppClassLoader@14dad5dc
//        获取系统类加载器的父类加载器>>扩展加载器
        ClassLoader sysParent = systemClassLoader.getParent();
        System.out.println(sysParent);
//        sun.misc.Launcher$ExtClassLoader@677327b6
//        获取扩展类加载器的父类加载器>>根加载器
        ClassLoader extParent = sysParent.getParent();
        System.out.println("ext:" + extParent);
//        null
//        测试当前的类是哪个加载器加载的
        ClassLoader classParent = Class.forName("com.ClassLoader.Demo.Demo1").getClassLoader();
        System.out.println("class:" + classParent);
//        class:sun.misc.Launcher$AppClassLoader@14dad5dc
//        测试JDK内置类是谁加载的
        ClassLoader jdkParent = Class.forName("java.lang.Object").getClassLoader();
        System.out.println("jdk:" + jdkParent);
//        jdk:null
//        获得系统类加载器加载路径
        System.out.println(System.getProperty("java.class.path"));
//         。。。
    }
}

获得类的信息

package com.ClassLoader.Demo;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class Demo2 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
//        Class c1=Class.forName("com.ClassLoader.Demo.User");
        User user=new User();
        Class c1=user.getClass();
        System.out.println(c1.getSimpleName());
        System.out.println("*************************");
//        获取类的名字 +详细路径
        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);
        System.out.println("*************************");
//        得到类的方法
        Method[] methods=c1.getDeclaredMethods();
        for (Method method : methods) {     //获得本类及其父类的所有方法
            System.out.println("getDeclaredMethods:"+method);
        }
        System.out.println("*************************");
        Method[] methods1=c1.getMethods();
        for (Method method : methods1) {        //获得本类的的所有方法
            System.out.println("getMethods:"+method);
        }
        System.out.println("*************************");
//        获得指定的方法
//        重载
        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);
        }
        Constructor[] constructors1=c1.getDeclaredConstructors();//获得全部方法
        for (Constructor constructor : constructors1) {
            System.out.println(constructor);
        }
        System.out.println("*************************");
        //获得指定构造器
        Constructor declareConstructor=c1.getDeclaredConstructor(String.class,int.class,double.class);
        System.out.println(declareConstructor);
    }
}

类的加载与ClassLoader的理解

有了Class对象能够做什么？

创建类的对象：调用Class对象的newInstance（）方法

• 类必须有一个无参构造器
• 类的构造器的访问权限需要足够

   //获取Class对象
        Class aClass=Class.forName("com.ClassLoader.Demo.User");
//        构造一个对象
        本质上调用了无参构造器
        User user1=(User) aClass.newInstance();
        System.out.println(user1);
//结果：y name isnull,my id is 0i got 0.0points
//        并非只能用无参构造器创建对象，用有参构造器也可以
        Constructor constructor=aClass.getDeclaredConstructor(String.class,int.class,double.class);
        User user2=(User) constructor.newInstance("zhangsan",1,99.9);//参数数量要一致否则出现异常
        System.out.println(user2);
//运行结果：my name is杜,my id is 1i got 99.9points

在不知道Class对象的参数数量和类型的情况下可以通过Field来获取信息

        //注：不知道Class对象有多少个变量的情况下可以通过Field来获取信息
        Field[] fields=aClass.getDeclaredFields();
        for (Field field : fields) {
            System.out.println(field);
        }

通过反射来调用普通方法

//        通过反射调用普通方法
        User user= (User) aClass.newInstance();
//        通过反射获取一个方法
        Method setName=aClass.getDeclaredMethod("setName", String.class);
//        inoke是激活的意思
        setName.invoke(user,"zhangsan");
        System.out.println(user.getName());

通过反射操作属性

//        通过反射操作属性，不能直接操作私有属性，可以通过关闭程序的安全检测关掉
        User user4=(User) aClass.newInstance();
        Field name=aClass.getDeclaredField("name");
        name.setAccessible(true);       //可通过的意思。private修饰的变量有安全保护机制，
        name.set(user4,"zhangsan");
        System.out.println(user4.getName());
    }

调用指定的方法

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

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

• 若Object对象方法的返回值或原方法没有返回值，运行结果返回null
• 若原方法为静态方法，此时形参Object可为null
• 若原方法形参列表为空，则Object args为null
• 若原方法声明为private私有，则需要调用在invoke()前,调用方法对象的setAccessible(true)，这样就可以进行暴力反射了

关于setAccessible()，它的作用时启动和禁用安全检查的开关，当布尔值为true时，java程序取消访问检查，false时，启动访问检查。

• 提高了反射的效率，如果代码中必须使用反射进行工作，那么该方法时必不可少的
• 可以使得无法访问的私有成员被强行访问

完整的Demo

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

public class Demo3 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //获取Class对象
        Class aClass=Class.forName("com.ClassLoader.Demo.User");
//        构造一个对象
//        本质上调用了无参构造器
        User user1=(User) aClass.newInstance();
        System.out.println(user1);
//结果：y name isnull,my id is 0i got 0.0points
//        并非只能用无参构造器创建对象，用有参构造器也可以
        Constructor constructor=aClass.getDeclaredConstructor(String.class,int.class,double.class);
        User user2=(User) constructor.newInstance("zhangsan",1,99.9);//参数数量一定要对齐getDeclaredConstructor（）的
        System.out.println(user2);
//运行结果：my name iszhangsan,my id is 1i got 99.9points
        //注：不知道Class对象有多少个变量的情况下可以通过Field来获取信息
//        Field[] fields=aClass.getDeclaredFields();
//        for (Field field : fields) {
//            System.out.println(field);
//        }
//        通过反射调用普通方法
        User user= (User) aClass.newInstance();
//        通过反射获取一个方法
        Method setName=aClass.getDeclaredMethod("setName", String.class);
//        inoke是激活的意思
        setName.invoke(user,"zhangsan");
        System.out.println(user.getName());
//        通过反射操作属性，不能直接操作私有属性，可以通过关闭程序的安全检测关掉
        User user4=(User) aClass.newInstance();
        Field name=aClass.getDeclaredField("name");
        name.setAccessible(true);       //可通过的意思。private修饰的变量有安全保护机制，
        name.set(user4,"zhangsan");
        System.out.println(user4.getName());
    }
}

性能对比

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

public class Demo4 {
    //    普通方式执行
    public static void test1(){
        User user=new User();
        long startTime=System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            user.getName();
        }
        long endTime=System.currentTimeMillis();
        System.out.println("普通方式执行10亿次"+(endTime-startTime)+"ms");
    }
    //    反射方式执行
    public static void test2() 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 < 1000000000; i++) {
            getName.invoke(user,null);
        }
        long endTime=System.currentTimeMillis();
        System.out.println("反射方式执行10亿次"+(endTime-startTime)+"ms");
    }
//        关闭检测反射方式执行
    public static void test3() 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 < 1000000000; i++) {
            getName.invoke(user,null);
        }
        long endTime=System.currentTimeMillis();
        System.out.println("关闭检测反射方式执行10亿次"+(endTime-startTime)+"ms");
    }
    public static void main(String[] args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {
        test1();
        test2();
        test3();
    }
}

通过反射获取注解信息

package com.AnnotationReflect.Demo;
import java.lang.annotation.*;
import java.lang.reflect.Field;

public class Demo1 {
public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
    Class c1=Class.forName("com.AnnotationReflect.Demo.Student1");
//    通过反射获得注解
    Annotation[] annotations=c1.getAnnotations();
    for (Annotation annotation : annotations) {
        System.out.println(annotation);
    }
//    获得注解value的值
    TableLong tableLong=(TableLong)c1.getAnnotation(TableLong.class);
    String value=tableLong.value();
    System.out.println(value);
//    获得类指定的注解
    Field field=c1.getDeclaredField("name");
    FiledStudent annotation=field.getAnnotation(FiledStudent.class);
    System.out.println(annotation.columName());
    System.out.println(annotation.type());
    System.out.println(annotation.length());
}
}
@TableLong("studentinfo")
class Student1{
    @FiledStudent(columName = "Sno",type="int",length = 10)
    private int id;
    @FiledStudent(columName = "Sname",type="int",length = 10)
    private String  name;
    @FiledStudent(columName = "Sex",type="int",length = 10)
    private String sex;
    public Student1(int id, String name, String sex) {
        this.id = id;
        this.name = name;
        this.sex = sex;
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
}
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FiledStudent{
    String columName();
    String type();
    int length();
}
//类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableLong{
    String value();
}