注解与反射

本文最后更新于:1 年前

注解与反射

注解入门

什么是注解

Annotation 是JDK5.0开始引入的技术

Annotation的作用

  • 不是程序本身,可以对程序作出解释
  • 可以被其他程序(比如编译器)读取

Annotation的格式

  • 注解可以以@注释名在代码中存在,还可以添加一些参数值,例如
  • @SuppressWarnings(value=”unchecked”).

Annotation在哪里使用

  • 可以附加在packages,class, method,field等上面,相当于给他们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package annotation;

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

//什么是注解
public class Test01 {
//@Override 重写的注解
@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();
}
}

内置注解

@Override:

定义在java.lang.Override中,此注解只适用于修辞方法,表示一个方法声明打算重写超类的另一个方法声明,如果方法利用此注释类型进行注解但没有重写超类方法,则编译器会生成一条错误消息。

@Deprecated:

定义在java.lang.Deprecated中,此注解只适用于修辞方法,属性、类,表示不鼓励程序员使用这样的元素,通常因为它很危险或者有更好的选择。

@SuppressWarnings:

定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。

  • @SupressWarnings(“all”)
  • @SupressWarnings(“unchecked”)
  • @SupressWarnings(“value = {“unchecked”, “deprection”})
  • …….

自定义注解,元注解

元注解

元注解的作用是负责注解其他的注解,Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明

这些类型和它们所支持的类在java.lang.annotation包中可以找到

  • @Target:用于描述注解的使用范围
  • @Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期
    • (SOURCE<CLASS<RUNTIME)
  • @Document:说明该注解将被包含在javadoc中
  • @Inherited:说明子类可以继承父类中的该注解
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package annotation;

import java.lang.annotation.*;

//测试元注解
@MyAnnotation
public class Test02 {
@MyAnnotation
public void test() {}
}
//定义一个注解
//@Target表示我们的注解可以用在那些地方
@Target(value = {ElementType.METHOD, ElementType.TYPE})

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

//@Document:说明该注解将被包含在javadoc中
@Documented

//@Inherited:说明子类可以继承父类中的该注解
@Inherited
@interface MyAnnotation {

}

自定义注解

  • 使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口
  • 分析
    • @interface用来声明一个注解,格式public @interface 注解名 {内容}
    • 其中的每一个方法实际上时声明了一个配置参数
    • 方法的名称就是参数的名称
    • 返回值类型就是参数的类型(返回值类型只能是基本类型,Class, String,enum)
    • 可以通过default来声明参数的默认值
    • 如果只有一个参数成员,一般参数名为value
    • 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package annotation;

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

//自定义个注解
public class Test03 {
//注解可以显示赋值,如果没有默认值,必须给注释赋值, 参数没有顺序
@MyAnnotation02(name = "lin",schools = {"AAA", "BBB"} )
public void test() {}

//参数名value可以省略 @MyAnnotation03(value = "XXX") ==> @MyAnnotation03("XXX")
@MyAnnotation03("lin")
public void test2() {}
}

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

@interface MyAnnotation02 {
//注解的参数:参数类型 + 参数名();
//后面的default是默认值,可以定义也可以不定义
String name() default "";
int age() default 0;
int ad() default -1;//default位-1 表示默认不存在

String[] schools();
}


@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation03 {
//如果只有一个参数成员,一般参数名为value
String value();
}

反射

java反射机制概述

动态语言VS静态语言

动态语言

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

静态语言

  • 与动态语言相对应的,运行时结构不可改变的就是静态语言。如Java、C、C++
  • Java不是动态语言,但Java可以被称为”准动态语言“。即java具有一定的动态性,我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活
1
2
3
4
function f() {
var x = "var a = 3; var b = 5; alert(a+b)";
eval(x)
}

Java Reflection

  • Reflection(反射)是Java被视为动态语言的关键,反射机制允许程序在执行其借助Reflection API取得任何类的内部信息,并能直接操作任意对象的内部属性以及方法。
    • Class c = Calss.forName(“java.lang.String”)
  • 加载完主类后,在堆内存的方法区中就产生了一个Class类型的对象(一个类只有一个Class对象), 这个对象就包含了完整的类的结构信息。我们可以通过对这个对象看到这个类的结构。这个对象就像是一面镜子,通过这个镜子看到类的结构,所以,我们形象的称之为:反射
    • 正常方式:引入需要的“包类”名称–>通过new实例化–>取得实例化对象
    • 反射方式:实例化对象–>getClass()方法–>得到完整的“包类”名称

反射机制提供的功能

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

反射的优点缺点

优点

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

缺点

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

反射的主要API

  • java.lang.Class:代表一个类
  • java.lang.reflect.Method:代表类的方法
  • java.lang.reflect.Field:代表类的成员变量
  • java.lang.reflect.Constructor:代表类的构造器
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package reflection;
//什么叫反射
public class Test02 {
public static void main(String[] args) throws ClassNotFoundException {

Class c1 = Class.forName("reflection.User");

System.out.println(c1);//class reflection.User

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

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

}
}

//实体类: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类

在Object类中定义了以下的方法,此方法将被所有子类继承

public final Class getClass()

以上的方法返回值类型是一个class类,此类是Java反射的源头,实际上所谓的反射从程序运行结果来看也很好理解,即:可以通过对象反射求出类的名称

描述类的类

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

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

Class类的常用方法

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

获取Class类的实例

  • 若已知具体的类,通过类的class属性获取,该方法最为安全可靠,程序性能最高
    • Class calzz = Person.class;
  • 已知某个类的实例,调用该实例的getClass()方法来获取Class对象
    • Class clazz = person.getclass
  • 已知一个类的全类名,并且该类在类路径下,可以通过Class类的静态方法forName获取,可能抛出ClassNotFoundException
    • Class clazz = C;ass.forName("demo01.Student")
  • 内置基本数据类型可以直接用类名.Type
  • 还可以利用ClassLoader
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package reflection;
//测试Class类的创建方式
public class Test03 {
public static void main(String[] args) throws ClassNotFoundException {
Person p1 = new Student();
System.out.println("这个人是:" + p1.name);

//方式一 通过对象获得
Class c1 = p1.getClass();
System.out.println(c1.hashCode());//2129789493
//方式二 forName
Class c2 = Class.forName("reflection.Student");
System.out.println(c2.hashCode());//2129789493
//方式三 通过类名.class
Class c3 = Student.class;
System.out.println(c3.hashCode());//2129789493
//方式四 基本内置类型的包装类都有一个Type属性
Class c4 = Integer.TYPE;
System.out.println(c4.hashCode());//2101973421
System.out.println(c4);//int

//获得父类的类型
Class c5 = c1.getSuperclass();
System.out.println(c5);//class reflection.Person

}
}

class Person {
String name;

public Person() {
}

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

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

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

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

}
}

有哪些类型可以由class对象

  • class:类
  • interface:接口
  • []:数组
  • enum:枚举
  • annotation:注解@interface
  • primitive type:基本数据类型
  • void
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package reflection;

import java.lang.annotation.ElementType;

//所有类型的class
public class Test04 {
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);//class java.lang.Object
System.out.println(c2);//interface java.lang.Comparable
System.out.println(c3);//class [Ljava.lang.String;
System.out.println(c4);//class [[I
System.out.println(c5);//interface java.lang.Override
System.out.println(c6);//class java.lang.annotation.ElementType
System.out.println(c7);//class java.lang.Integer
System.out.println(c8);//class java.lang.Void
System.out.println(c9);//class java.lang.Class

//只要元素类型与维度一样,就是同一个class
int[] a = new int[10];
int[] b = new int[100];
System.out.println(a.getClass().hashCode());//381259350
System.out.println(a.getClass().hashCode());//381259350
}
}

类的加载与ClassLoader

image-20210521124322349

image-20210521125918078

image-20210521125953577

image-20210521130005734

image-20210521130237723

创建运行时类的对象

image-20210521132217105

获取运行时类的完整结构

调用运行时类的指定结构


博主码字不易,本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!