Java学习—注解和反射

最新推荐文章于 2025-02-14 15:07:34 发布

qq_53302267

最新推荐文章于 2025-02-14 15:07:34 发布

阅读量1.3k

点赞数 29

文章标签： java 学习开发语言 intellij-idea 笔记

本文链接：https://blog.youkuaiyun.com/qq_53302267/article/details/143819316

版权

Java学习—注解和反射

1、注解

1.1、注解的定义和作用

注解（Annotation）是从JDK5.0开始引入，以“@注解名”在代码中存在。还可以添加一些参数值，这些信息被保存在 Annotation 的 “name=value” 对中。
不是程序本身，可以对程序作出解释
可以被其他程序（比如：编译器等）读取

@author 标明开发该类模块的作者，多个作者之间使用,分割
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明，如果没有参数就不能写
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写

@Override: 限定重写父类方法，该注解只能用于方法

@Deprecated: 用于表示所修饰的元素(类，方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

@SuppressWarnings: 抑制编译器警告

@SuppressWarnings("all")
public class Test01 {
    //@Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    // @Deprecated  已过时的，不推荐使用
    @Deprecated
    public static void test01(){
        System.out.println(" Deprecated");
    }

    //@SuppressWarnings

    public void test02(){
        ArrayList<Integer> list = new ArrayList<>();
    }
    public static void main(String[] args) {
        test01();
    }
}

1.2、元注解

元注解的作用就是负责注解其他注解。JDK1.5在java.lang.annotation包定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。

（1）**@Target：**用于描述注解的使用范围

可以通过枚举类型ElementType的10个常量对象来指定
TYPE，METHOD，CONSTRUCTOR，PACKAGE…

（2）**@Retention：**用于描述注解的生命周期

可以通过枚举类型RetentionPolicy的3个常量对象来指定
SOURCE（源代码）、CLASS（字节码）、RUNTIME（运行时）
唯有RUNTIME阶段才能被反射读取到。

（3）@Documented：表明这个注解应该被 javadoc工具记录。

（4）**@Inherited：**允许子类继承父类中的注解

//Target  表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//Retention   表示我们的注解在什么地方还有效
//runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)
//Documented    表示是否将我们的注解生成在Javadoc中
@Documented
//Inherited  子类可以继承父类的注解
@Inherited
@interface MyAnnotation{

}

1.3、自定义注解

【元注解】
【修饰符】 @interface 注解名{
    【成员列表】
}

自定义注解可以通过四个元注解@Retention,@Target，@Inherited,@Documented，分别说明它的声明周期，使用位置，是否被继承，是否被生成到API文档中。
Annotation 的成员在 Annotation 定义中以无参数有返回值的抽象方法的形式来声明，我们又称为配置参数。返回值类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组
可以使用 default 关键字为抽象方法指定默认返回值
如果定义的注解含有抽象方法，那么使用时必须指定返回值，除非它有默认值。格式是“方法名 = 返回值”，如果只有一个抽象方法需要赋值，且方法名为value，可以省略“value=”，所以如果注解只有一个抽象方法成员，建议使用方法名value。

public class Test03 {
    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation01(age =19,name = "gcy")
    public void show1(){
        
    }
    @MyAnnotation02("gcy")
    public void show2(){
        
    }
}

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

2、反射机制

2.1、反射机制概述

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

加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。

2.2、反射的优缺点

优点：

提高了Java程序的灵活性和扩展性，降低了耦合性，提高自适应能力
允许程序创建和控制任何类的对象，无需提前硬编码目标类

缺点：

反射的性能较低。
- 反射机制主要应用在对灵活性和扩展性要求很高的系统框架上
反射会模糊程序内部逻辑，可读性较差。

2.3、Class类

要想解剖一个类，必须先要获取到该类的Class对象。而剖析一个类或用反射解决具体的问题就是使用相关API:

java.lang.Class
java.lang.reflect.*

所以，Class对象是反射的根源。

在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对象

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

获取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.gcy.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{
    String name;

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

    public Person() {
    }

    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="学生";
    }
}
class Teacher extends Person{
    public Teacher() {
        this.name="老师";
    }
}

2.4、哪些类型可以有Class对象

简言之，所有Java类型！

（1）class：外部类，成员(成员内部类，静态内部类)，局部内部类，匿名内部类
（2）interface：接口
（3）[]：数组
（4）enum：枚举
（5）annotation：注解@interface
（6）primitive type：基本数据类型
（7）void

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

        //只要元素类型和维度一样，就是同一个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);

    }
}

2.5、类的加载

当程序主动使用某个类时，如果该类还未被加载到内存中，系统会通过加载、链接、初始化三个步骤来对该类进行初始化。如果没有意外，JVM将会连续完成这三个步骤，所以有时也把这三个步骤统称为类加载。

类的加载又分为三个阶段：

（1）装载（Loading）

将类的class文件读入内存，并为之创建一个java.lang.Class对象。此过程由类加载器完成

（2）链接（Linking）

①验证Verify：确保加载的类信息符合JVM规范，例如：以cafebabe开头，没有安全方面的问题。

②准备Prepare：正式为类变量（static）分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行分配。

③解析Resolve：虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程。

（3）初始化（Initialization）

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

虚拟机会保证一个类的<clinit>()方法在多线程环境中被正确加锁和同步。

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;
         *       }
         */
    }
}
class A{
    static {
        System.out.println("A类静态代码块初始化");
        m=300;
    }
    static int m=100;

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

类的加载器:

Bootstrap ClassLoader:引导类加载器、启动类加载器
使用C/C++语言编写的，不能通过Java代码获取其实例
负责加载Java的核心库（JAVA_HOME/jre/lib/rt.jar或sun.boot.class.path路径下的内容）

继承于ClassLoader的类加载器

Extension ClassLoader:扩展类加载器
负责加载从java.ext.dirs系统属性所指定的目录中加载类库，或从JDK的安装目录的jre/lib/ext子目录下加载类库

SystemClassLoader/ApplicationClassLoader：系统类加载器、应用程序类加载器

我们自定义的类，默认使用的类的加载器

用户自定义类的加载器

实现应用的隔离（同一个类在一个应用程序中可以加载多份）；数据的加密

@Test
public void test1() {
    //获取系统类加载器
    ClassLoader classLoader1 = ClassLoader.getSystemClassLoader();
    System.out.println(classLoader1);//jdk.internal.loader.ClassLoaders$AppClassLoader@63947c6b

    //获取拓展类加载器
    ClassLoader classLoader2 = classLoader1.getParent();
    System.out.println(classLoader2);//jdk.internal.loader.ClassLoaders$PlatformClassLoader@256216b3

    //获取引导类加载器：失败
    ClassLoader classLoader3 = classLoader2.getParent();
    System.out.println(classLoader3);//null
}

@Test
public void test2() throws ClassNotFoundException {
    //用户自定义的类使用的是系统类加载器加载的
    Class<Person> clazz1 = Person.class;
    ClassLoader classLoader = clazz1.getClassLoader();
    System.out.println(classLoader);

    //对于Java的核心api使用引导类加载器加载
    Class clazz2 = Class.forName("java.lang.String");
    ClassLoader classLoader1 = clazz2.getClassLoader();
    System.out.println(classLoader1);
}

2.6、动态创建对象执行方法

调用指定的结构：指定的属性、方法、构造器
1 调用指定的属性（步骤）
步骤1.通过Class实例调用getDeclaredField(String fieldName)，获取运行时类指定名的属性
步骤2. setAccessible(true)：确保此属性是可以访问的
步骤3. 通过Filed类的实例调用get(Object obj) （获取的操作）
或 set(Object obj,Object value) （设置的操作）进行操作。

2 调用指定的方法（步骤）
步骤1.通过Class的实例调用getDeclaredMethod(String methodName,Class … args),获取指定的方法
步骤2. setAccessible(true)：确保此方法是可访问的
步骤3.通过Method实例调用invoke(Object obj,Object … objs),即为对Method对应的方法的调用。
invoke()的返回值即为Method对应的方法的返回值
特别的：如果Method对应的方法的返回值类型为void，则invoke()返回值为null

3 调用指定的构造器（步骤）
步骤1.通过Class的实例调用getDeclaredConstructor(Class … args)，获取指定参数类型的构造器
步骤2.setAccessible(true)：确保此构造器是可以访问的
步骤3.通过Constructor实例调用newInstance(Object … objs),返回一个运行时类的实例。

public class ReflectTest {
    /**
     * 反射的应用3-1：调用指定的属性
     */
    @Test
    public void test1() throws InstantiationException, IllegalAccessException, NoSuchFieldException {
        Class<Person> clazz = Person.class;

        Person per = clazz.newInstance();

        //1.获取运行时类指定名的属性
        Field ageField = clazz.getField("age");
        System.out.println(ageField.get(per));
        //2.获取并设置此属性的值
        ageField.set(per, 2);
        System.out.println(ageField.get(per));

    }

    @Test
    public void test2() throws Exception {
        Class<Person> clazz = Person.class;

        Person per = clazz.newInstance();

        //1.通过Class实例调用getDeclaredField（String name），获取运行时类指定名的属性
        Field nameField = clazz.getDeclaredField("name");
        //2.setAccessible(true):确保此属性是可以访问的
        nameField.setAccessible(true);

        //2.通过Filed类的实例调用get（Object obj）（获取的操作）
        //或 set(Object obj,Object value)（设置的操作）进行操作
        nameField.set(per, "Tom");
        System.out.println(nameField.get(per));

    }

    @Test
    public void test3() throws Exception {
        Class<Person> clazz = Person.class;


        //1.通过Class实例调用getDeclaredField（String name），获取运行时类指定名的属性
        Field infoField = clazz.getDeclaredField("info");
        //2.setAccessible(true):确保此属性是可以访问的
        infoField.setAccessible(true);

        //2.通过Filed类的实例调用get（Object obj）（获取的操作）
        //或 set(Object obj,Object value)（设置的操作）进行操作
//        infoField.set(Person.class, "Tom");
//        System.out.println(infoField.get(Person.class));
        //或 （仅限于类变量可以如下的方式调用）
        infoField.set(null, "Tom");
        System.out.println(infoField.get(null));
    }

    /**
     * 反射的应用3-2：调用指定的方法
     */
    @Test
    public void test4() throws Exception {
        Class<Person> clazz = Person.class;
        Person per = clazz.newInstance();

        //1.通过Class实例调用getDeclaredMethod（String methodName,Class ... args）,获取指定的方法
        Method showNationMethod = clazz.getDeclaredMethod("showNation", String.class, int.class);

        //2.setAccessible(true):确保此方法是可以访问的
        showNationMethod.setAccessible(true);

        //3.通过Method实例调用invoke(Object obj,Object ... objs),即为对Method对应的方法的调用
        //invoke()的返回值即为Method对应的方法的返回值
        Object returnValue = showNationMethod.invoke(per, "CHN", 10);
        System.out.println(returnValue);

    }

    @Test
    public void test5() throws Exception {
        Class<Person> clazz = Person.class;

        //1.通过Class实例调用getDeclaredMethod（String methodName,Class ... args）,获取指定的方法
        Method showInfoNationMethod = clazz.getDeclaredMethod("showInfo");

        //2.setAccessible(true):确保此方法是可以访问的
        showInfoNationMethod.setAccessible(true);

        //3.通过Method实例调用invoke(Object obj,Object ... objs),即为对Method对应的方法的调用
        //invoke()的返回值即为Method对应的方法的返回值
        Object returnValue = showInfoNationMethod.invoke(null);
        System.out.println(returnValue);
    }

    /**
     * 反射的应用3-3：调用指定的构造器
     */
    @Test
    public void test6() throws Exception {
        Class<Person> clazz = Person.class;

        //1.通过Class实例调用getDeclaredConstructor（Class ... args）,获取指定参数类型的构造器
        Constructor<Person> constructor = clazz.getDeclaredConstructor(String.class, int.class);
        //2.setAccessible(true):确保此构造器是可以访问的
        constructor.setAccessible(true);
        //3.通过Constructor实例调用newInstance(Object ... objs),返回一个运行时类的实例
        Person tom = constructor.newInstance("Tom", 10);
        System.out.println(tom);
    }

    //使用Contructor替换原有的使用Class调用newInstance()的方式创建对象
    @Test
    public void test7() throws Exception {
        Class<Person> clazz = Person.class;

        //1.通过Class实例调用getDeclaredConstructor（Class ... args）,获取指定参数类型的构造器
        Constructor<Person> constructor = clazz.getDeclaredConstructor();
        //2.setAccessible(true):确保此构造器是可以访问的
        constructor.setAccessible(true);
        //3.通过Constructor实例调用newInstance(Object ... objs),返回一个运行时类的实例
        Person tom = constructor.newInstance();
        System.out.println(tom);
    }
}

2.7、通过反射获得泛型

public class Test05 {
    public void method01(Map<String,User> map, List<User> list){
        System.out.println("test01");
    }
    public Map<String,User> method02(){
        System.out.println("test02");
        return null;
    }

    public static void main(String[] args) throws NoSuchMethodException {
        Method method01 = Test05.class.getMethod("method01", Map.class, List.class);
        Type[] genericParameterTypes = method01.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);
                }
            }
        }

        method01=Test05.class.getMethod("method02",null);
        Type genericReturnType = method01.getGenericReturnType();
        if (genericReturnType instanceof ParameterizedType){
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println();
                System.out.println(actualTypeArgument);
            }
        }
    }
}

2.8、反射操作注解

getAnnotations
getAnnotation

练习：ORM

ORM-------Object relationship Mapping :对象关系映射

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

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

public class Test06 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.gcy.reflection.Student2");
        //通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        //获得注解的value的值
        Tablegcy tablegcy = (Tablegcy) c1.getAnnotation(Tablegcy.class);
        System.out.println(tablegcy.value());

        //获得类指定的注解
        Field name = c1.getDeclaredField("name");
        Fieldgcy fieldgcy = name.getAnnotation(Fieldgcy.class);
        System.out.println(fieldgcy.columnName());
        System.out.println(fieldgcy.type());
        System.out.println(fieldgcy.length());
    }
}
@Tablegcy("db_student")
class Student2{
    @Fieldgcy(columnName = "db_id",type = "int",length = 10)
    private int id;
    @Fieldgcy(columnName = "db_age",type = "int",length = 10)
    private int age;
    @Fieldgcy(columnName = "db_name",type = "varchar",length = 10)
    private String 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;
    }

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

    public Student2() {
    }
}

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

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