Java107班三阶段课程学习
1、什么是反射:
1)Java反射机制的核心是在程序运行时动态加载类并获取类的详细信息,从而操作类或对象的属性和方法。本质是JVM得到class对象之后,再通过class对象进行反编译,从而获取对象的各种信息。
(2)Java属于先编译再运行的语言,程序中对象的类型在编译期就确定下来了,而当程序在运行时可能需要动态加载某些类,这些类因为之前用不到,所以没有被加载到JVM。通过反射,可以在运行时动态地创建对象并调用其属性,不需要提前在编译期知道运行的对象是谁。
2、反射的原理
下图是类的正常加载过程、反射原理与class对象:
Class对象的由来是将class文件读入内存,并为之创建一个Class对象。
3、反射的优缺点:
1、优点:在运行时获得类的各种内容,进行反编译,对于Java这种先编译再运行的语言,能够让我们很方便的创建灵活的代码,这些代码可以在运行时装配,无需在组件之间进行源代码的链接,更加容易实现面向对象。
2、缺点:(1)反射会消耗一定的系统资源,因此,如果不需要动态地创建一个对象,那么就不需要用反射;
(2)反射调用方法时可以忽略权限检查,因此可能会破坏封装性而导致安全问题。
4、反射的用途:
1、反编译:.class–>.java
2、通过反射机制访问java对象的属性,方法,构造方法等
3、当我们在使用IDE,比如Ecplise时,当我们输入一个对象或者类,并想调用他的属性和方法是,一按点号,编译器就会自动列出他的属性或者方法,这里就是用到反射。
4、反射最重要的用途就是开发各种通用框架。比如很多框架(Spring)都是配置化的(比如通过XML文件配置Bean),为了保证框架的通用性,他们可能需要根据配置文件加载不同的类或者对象,调用不同的方法,这个时候就必须使用到反射了,运行时动态加载需要的加载的对象。
5、反射机制常用的类:
Java.lang.Class;
Java.lang.reflect.Constructor;
Java.lang.reflect.Field;
Java.lang.reflect.Method;
Java.lang.reflect.Modifier;
1、获得Class:主要有三种方法:
(1)Object–>getClass
(2)任何数据类型(包括基本的数据类型)都有一个“静态”的class属性
(3)通过class类的静态方法:forName(String className)(最常用)
@Test //获取Class --范围:所有的字节码文件 public void test1() throws ClassNotFoundException { //方式一,通过类名 Class c = Dog.class; //Dog.java 编译后的字节码 Class c1 = Book.class; //Book.java编译后的字节码文件 // 方式二--通过对象 Class c3 = new Dog().getClass(); // 方式三--通过类路径 Class c4 = Class.forName("demo.Book"); System.out.println(c4); System.out.println(c3); } |
2、创建实例:通过反射来生成对象主要有两种方法:
(1)使用Class对象的newInstance()方法来创建Class对象对应类的实例。
//1.管理无参构造 @Test public void test2() throws Exception { //1.获取到某个类的字节码文件对象,即class的对象 Class<Dog> c = Dog.class; // 2.帮你调用无参构造 Dog dog = c.newInstance(); System.out.println(dog); } |
(2)先通过Class对象获取指定的Constructor对象,再调用Constructor对象的newInstance()方法来创建对象,这种方法可以用指定的构造器构造类的实例。
//2.管理有参构造 @Test public void test3() throws Exception { // 1.获取到某个类的字节码文件对象,即class的对象 Class<Dog> c = Dog.class; // 2.获取有参构造的管理对象--2个参数的那个 Constructor<Dog> con = c.getDeclaredConstructor(String.class); // 3.帮助Dog类调用有参构造 Dog dog = con.newInstance("旺财"); System.out.println(dog); } |
3、通过反射获取构造方法并使用:
(1)批量获取的方法:
public Constructor[] getConstructors():所有"公有的"构造方法
public Constructor[] getDeclaredConstructors():获取所有的构造方法(包括私有、受保护、默认、公有)
(2)单个获取的方法,并调用:
public Constructor getConstructor(Class… parameterTypes):获取单个的"公有的"构造方法:
public Constructor getDeclaredConstructor(Class… parameterTypes):获取"某个构造方法"可以是私有的,或受保护、默认、公有;
(3) 调用构造方法:
Constructor–>newInstance(Object… initargs)
newInstance是 Constructor类的方法(管理构造函数的类)
//3.管理属性 @Test public void test4() throws Exception { //1.获取到某个类的字节码文件对象,即Class的对象 Class<Dog> c = Dog.class; //2.获取某个属性的管理对象 Field f = c.getDeclaredField("name"); //先创建一个狗狗对象 Dog dog = c.newInstance(); f.setAccessible(true); //开启私有属性操作权限 //3.帮助dog给name属性赋值 f.set(dog, "来福"); System.out.println(dog); } //4.管理方法 @Test public void test5() throws Exception { //1.获取到某个类的字节码文件对象,即Class的对象 Class<Dog> c = Dog.class; //2.获取某个方法setAge(int age)的管理对象 Method m = c.getDeclaredMethod("setAge", int.class); //先创建一个狗狗对象 Dog dog = c.newInstance(); //3.帮助dog给调用setAge方法 m.invoke(dog, 3); System.out.println(dog); //管理toString方法 Method m2 = c.getDeclaredMethod("toString"); System.out.println(m2.invoke(dog)); } |
反射和properties文件
先复习一个Propertis这个类
在Emp类中写一个方法study
在resources中创建一个db.properties文件录入内容
className=com.hr.entity.Emp
methodName=study
创建测试方法
@Test
public void testReflect() throws Exception {
//加载文件
Properties props = new Properties();
ClassLoader classLoader = EmpServiceTest.class.getClassLoader();
InputStream is = classLoader.getResourceAsStream("db.properties");
props.load(is);
//
String className = props.getProperty("className");
String methodName = props.getProperty("methodName");
//
Class<?> clazz = Class.forName(className);
Object obj = clazz.newInstance();
Method method = clazz.getMethod(methodName, String.class);
method.invoke(obj, "熊康榕");
} |
反射和xml文件
什么是 XML?
XML 指可扩展标记语言(EXtensible Markup Language)。 XML 是一种很像HTML的标记语言。
XML的设计宗旨是传输数据,而不是显示数据。
XML 标签没有被预定义。您需要自行定义标签。
XML 被设计为具有自我描述性。 XML 是 W3C的推荐标准。
XML 和 HTML 之间的差异
XML 不是 HTML 的替代。。
XML 和 HTML 为不同的目的而设计:
XML 被设计用来传输和存储数据,其焦点是数据的内容。
HTML 被设计用来显示数据,其焦点是数据的外观。
HTML 旨在显示信息,而 XML 旨在传输信息。
宠物管理系统
1.预先定义好父类:动物类,子类:狗狗类,企鹅类,大象类,
2.在xml文件中配置各个宠物类的全路径名
3.编写一个宠物领养方法,根据用户输入的宠物名称,从xml读取相应的类路径,使用反射构建宠物对象,并返回。
注意:使用父类作为方法返回值,字符串作为参数。
xml文件
<?xml version="1.0" encoding="UTF-8" ?> <animal> <狗狗> <name>旺财</name> <class>reflect.pet.Dog</class> </狗狗> <企鹅> <name>皮皮</name> <class>reflect.pet.Penguin</class> </企鹅> <大象> <name>肉肉</name> <class>reflect.pet.Elephant</class> </大象> </animal> |
Java文件
@Test public void test1() throws Exception { Scanner sc=new Scanner(System.in); System.out.println("请选择您要领养的宠物:狗狗,企鹅,大象"); String name = sc.next(); Animal animal = getAnimal(name); System.out.println(animal); } public Animal getAnimal(String name) throws Exception { // 1.创建解析器 SAXReader reader = new SAXReader(); // 解析xml文档,得到document对象 Document document = reader.read("src/reflect1/pet/pet.xml"); // 根据document对象获取根节点 Element root = document.getRootElement(); // 查找根节点下的子节点 element() elements() Element animal = root.element(name); String className = animal.element("class").getText(); //2.使用反射创建对象 return (Animal) Class.forName(className).newInstance(); } |
反射和泛型
@Test//案例一:将一个map中的数据转存到一个实体类对象中。 public void test5() throws Exception { HashMap<String, Object> map = new HashMap<>(); map.put("name","旺财"); map.put("age",3); Dog dog = getObject(map, Dog.class); System.out.println(dog); } public <T>T getObject(Map<String,Object> map, Class<T> c) throws Exception { T t = c.newInstance(); //1.拆开map Set<Map.Entry<String, Object>> entries = map.entrySet(); for (Map.Entry<String, Object> entry : entries) { String key = entry.getKey(); //2.将map中的值存入T这个类的对象属性中 Field f = c.getDeclaredField(key); f.setAccessible(true); f.set(t,entry.getValue()); } return t; } |
反射和注解
1、注解
1.1 注解Annotation的概念
1.注解的作用:
注解Annotation是从JDK1.5开始引入的新技术,我们在编程中经常会使用到注解,它的作用有:
1) 编译检查:比如@SuppressWarnings,@Deprecated和@Override都具有编译检查作用;
2) 替代配置文件:使用反射来读取注解信息。
目前大部分框架(如Spring)都使用了注解简化代码并提高编码的效率(使用注解之前使用的xml进行配置)。
注解其实就是对程序作出解释(这一点和注释类似),不是程序本身,可以被其他程序读取。可以通过注解告诉类如何运行。
2.注解的使用范围:
在Java技术里注解的典型应用是:可以通过反射技术去得到类里面的注解,以决定怎么去运行类。注解可以标记在package包、class类、field属性、method方法等上面,且在同一个地方可以同时标记多个注解。
注解可以在编译(source),类加载(class),运行时(runtime)被读取,并执行相应的处理,以便于其他工具补充信息或者进行部署。
3.注解的格式:
@注解名称(参数名=“参数值”,...)
例如:@SuppressWarnings(value = "unchecked")
4.注解的作用分类:
编写文档:通过代码里标识的注解生成文档(生成文档doc文档)
代码分析:通过代码里标识的注解对代码进行分析(使用反射)
编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查(@SuppressWarnings等)
1.2 内置注解
主要的内置注解有三个:
@Override -只适用于修饰方法,表示一个方法声明打算重写超类中的另一个方法声明。
@Deprecated -标记过时的方法,不建议使用该方法。
@SuppressWarnings -用来抑制编译时的警告信息,还需要添加一个参数。
@SuppressWarnings("all/unchecked"),指示关闭警告的范围。
1.3 元注解
元注解的作用就是负责注解其他注解,Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明.
1.@Target -用来描述注解可以使用的范围(比如:方法、类或字段),其中ElementType是枚举类型。若没有@Target,则该注解可以用于任何地方。
public enum ElementType { /**标明该注解可以用于类、接口(包括注解类型)或enum声明*/ TYPE, /** 标明该注解可以用于字段(域)声明,包括enum实例 */ FIELD, /** 标明该注解可以用于方法声明 */ METHOD, /** 标明该注解可以用于参数声明 */ PARAMETER, /** 标明注解可以用于构造函数声明 */ CONSTRUCTOR, /** 标明注解可以用于局部变量声明 */ LOCAL_VARIABLE, /** 标明注解可以用于注解声明(应用于另一个注解上)*/ ANNOTATION_TYPE, /** 标明注解可以用于包声明 */ PACKAGE, /** * 标明注解可以用于类型参数声明(1.8新加入) * @since 1.8 */ TYPE_PARAMETER, /** * 类型使用声明(1.8新加入) * @since 1.8 */ TYPE_USE } |
比如:@Target(value = {ElementType.TYPE,ElementType.METHOD}),表示该注解可以用在类(接口)或者方法上。
2.@Retention用来约束注解的生命周期,分别有三个值,源码级别source、类文件级别class和运行时级别runtime。若没有@Retention,则默认是类文件级别class。(生命周期source<class<runtime)
SOURCE:注解将被编译器丢弃(该类型的注解信息只会保留在源码里,源码经过编译后,注解信息会被丢弃,不会保留在编译好的class文件里)
CLASS:注解在class文件中可用,但会被JVM丢弃(该类型的注解信息会保留在源码里和class文件里,在执行的时候,不会加载到虚拟机中)。
RUNTIME:注解信息将在运行期(JVM)也保留,因此可以通过反射机制读取注解的信息(源码、class文件和执行的时候都有注解的信息),如SpringMvc中的@Controller、@Autowired、@RequestMapping等。
3.@Documented -说明该注解将被包含在用户文档javadoc中
4.@Inherited -说明子类可以继承父类中的该注解。如:当类B继承了类A,@Inherited注解加到了A上,则B也会带上该注解。
1.4 自定义注解
使用@interface来声明一个注解,格式:public @interface 注解名{ 定义内容; },定义内容中的每一个“方法”实际上是声明了一个配置参数。如下,定义了MyAnnotation注解:
@Target({ElementType.TYPE,ElementType.METHOD}) //作用范围
@Retention(RetentionPolicy.RUNTIME) //生命周期
@Documented // 生成javadoc中含有
@Inherited // 子类可以继承
@interface MyAnnotation{
String value() default ""; //使用类型 名称()默认值 的格式;
int age();
String[ ] school() default {"yndx", "清华大学"};
}
该注解中有三个配置参数,String类型的value,int类型的age和String数组类型的school,其中使用default定义了默认值。
注意:
定义注解时,意味着它实现了 java.lang.annotation.Annotation 接口,即该注解就是一个Annotation。
和我们通常 implements实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后,该注解不能继承其他注解或接口。
2、反射
2.1 Java反射机制概述
2.1.1 静态语言和动态语言
1.动态语言:是一类在运行时可以改变其结构的语言:例如新的函数、对象、甚至代码可以被引进,已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。
主要的动态语言有:C#、JavaScript、PHP、Python等;
function f() {
var x = "var a=3;var b=5;alert(a+b)";
eval(x);
// 运行时改变x的类型和值
}
2.静态语言:与动态语言相对应的,运行时结构不可变的语言就是静态语言。如Java、C、C++。
注:Java不是动态语言,但Java可以称之为“准动态语言”。即Java有一定的动态性,我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活!
2.1.2 Reflection反射
Reflection(反射)是java被视为动态语言的关键,反射机制允许程序在指定期借助于Reflection API取得任何类的内部信息,并能直接操作任意对象的内部属性及方法。
Class c = Class.forName("java.lang.String");
加载完类之后,在堆内存的方法区中就产生了一个Class类型的对象(一个类只有一个Class对象),这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子,透过这个镜子看到类的结构,所以,我们形象的称之为:反射。
2.1.3 Java反射机制提供的功能
在运行时判断任意一个对象所属的类;
在运行时构造任意一个类的对象;
在运行时判断任意一个类所具有的成员变量和方法;
在运行时获取泛型信息;
在运行时调用任意一个对象的成员变量和方法;
在运行时处理注解;
生成动态代理;
2.1.4 Java反射的优点和缺点
优点:可以实现动态创建对象和编译,体现出很大的灵活性。
缺点:对性能有影响。使用反射基本上是一种解释操作,我们可以告诉JVM,我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作(直接通过对象操作的方式)。
2.2 理解Class类并获取Class实例
2.2.1 Class类
1.概述
对象照镜子后可以得到一个信息:某个类的属性、方法和构造器,某个类到底实现了哪些接口。
对于每个类而言,JRE都为其保留一个不变的Class类型的对象,一个Class对象包含了特定某个结构的有关信息。
Class本身也是一个类。
Class对象只能由系统建立。
一个加载的类在JVM中只会有一个Class实例。
一个Class对象对应的是一个加载到JVM中的.class文件。
每个类的实例都会记得自己是由哪个Class实例所生成的。
通过Class可以完整地得到一个类中的所有被加载的结构。
Class类是Reflection的根源,针对任何你想动态加载、运行的类,唯有先获得相应的Class对象。
2.Class类的常用方法:
ClassforName(String name);返回指定类名name的Class对象。
Object newInstance();调用缺省构造函数,返回Class对象的一个实例。
getName();返回此Class对象所表示的实体类(类、接口、数组类或void)的名称。
Class getSuperClass();返回当前Class对象的父类的Class对象。
Class[ ] getinterfaces();获取当前Class对象的接口。
ClassLoader getClassLoader();返回该类的类加载器。
Constructor[ ] getConstructors();返回一个包含某些Constructor对象的数组。
Method getMothed(String name,Class… T);返回一个Method对象,此对象的形参类型为paramType。
Field[ ] getDeclaredFields();返回Field对象的一个数组。
2.2.2 获得Class类的方式
1.若已知具体的类,通过类的class属性获取,该方法最为安全可靠,程序性能最高。如:
Class clazz = Person.class;
2.已知某个类的实例,调用该实例的getClass()方法获取Class对象。如:
Class clazz = person.getClass();
在Object类中定义了getClass()方法,此方法被所有子类继承:
public final Class getClass();
以上的方法返回值的类型是一个Class类,此类是Java反射的源头,实际上所谓反射从程序的运行结果来看也很好理解,即:可以通过对象反射求出类的名称。
因此,所有类都继承了getClass()方法。
3.已知一个类的全类名,且该类在类路径下,可通过Class类的静态方法forName()获取,可能抛出ClassNotFoundException。如:
Class clazz = Class.forName("demo01.Student");
4.内置基本数据类型可以直接用类名.Type。
Class c = Integer.TYPE;
5.还可以利用ClassLoader。
2.2.3 哪些类型有Class对象
class:外部类,成员(成员内部类,静态内部类),局部内部类,匿名内部类
interface:接口
[ ]:数组
enum:枚举
annotation:注解@interface
primitive type:基本数据类型
void:空类型
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); // 只要元素类型与维度一样就是同一个Class。 int[] a = new int[10]; int[] b = new int[100]; System.out.println(a.getClass().hashCode()); System.out.println(b.getClass().hashCode()); } } |
2.3 类的加载与ClassLoader
2.3.1 Java内存分析
堆
存放new的对象和数组;
可以被所有的线程共享,不会存放别的对象的引用。
栈
存放基本变量类型(会包含这个基本类型的具体数值);
引用对象的变量(会存放这个引用在堆里面的具体地址)。
方法区
可以被所有的线程共享;
包含了所有的class和static变量。
2.3.2 类的加载过程
当程序主动使用某个类时,如果该类还未被加载到内存中,则系统会通过这三个步骤对该类进行初始化:
1.类的加载(Load)
将类的class文件读入内部,并为之创建一个java.lang.Class对象。此过程由类加载器完成
加载:将class文件字节码内容加载到内存中,并将这些静态数据转换成方法区的运行时数据结构,然后生成一个代表这个类的java.lang.Class对象。
2.类的链接(Link)
将类的二进制数据合并到JRE中;
链接:将Java类的二进制代码合并到JVM的运行状态之中的过程。包括:
验证:确保加载的类信息符合JVM规范,没有安全方面的问题
准备:正式为类变量(static)分配内存并设置类变量默认初始值的阶段,这些内存都将在方法区中进行分配。
解析:虚拟机常量池内的符号引用(常量名)替换为直接引用(地址)的过程。
3.类的初始化(Initialize)
1)JVM负责对类进行初始化:
执行类构造器<clinit>()方法的过程。类构造器<clinit>()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。(<类构造器是构造类信息的,不是构造该类对象的构造器>)。
当初始化一个类的时候,如果发现其父类还没有进行初始化,则需要先触发其父类的初始化。
虚拟机会保证一个类的<clinit>()方法在多线程环境中被正确加锁和同步。
2)什么时候会发生类的初始化?
1.类的主动引用(一定会发生类的初始化)
当虚拟机启动,先初始化main方法所在的类;
new 一个类的对象;
调用类的静态成员(除了final常量)和静态方法;
使用java.lang.reflect包的方法对类进行反射调用;
当初始化一个类,如果其父类没有被初始化,则先会初始化它的父类。
2.类的被动引用(不会发生类的初始化)
当访问一个静态域时,只有真正声明这个域的类才会被初始化。如:当通过子类引用父类的静态变量,不会导致子类初始化。
通过数组定义类引用,不会触发此类的初始化;
引用常量不会触发此类的初始化(常量在链接阶段就存入调用类的常量池中了)。
代码演示:
public class Test05 { public static void main(String[] args) { A a = new A(); System.out.println(A.m); } } class A{ static { System.out.println("A类静态代码块初始化"); m = 300; } static int m = 100; public A(){ System.out.println("A类的无参数构造函数初始化"); } } |
解释:
执行过程
1.加载到内存,会产生一个类对应Class对象;
2.链接,连接结束后分配内存设置初始值 m=0;
3.初始化
(){ //将静态代码块合并执行
System.out.println("A类静态代码块初始化");
m=300
m=100}
2.3.3 类的加载器
类加载器的作用:将class文件字节码内容加载到内存中,并将这些静态数据转换成方法区的运行时数据结构,然后在堆中生成一个代表这个类的java.lang.Class对象,作为方法区中类数据的访问入口。
类缓存:标准的JavaSE类加载器可以按要求查找类,但一旦某个类被加载到类加载器中,它将持续加载(缓存)一段时间。不过JVM垃圾回收机制可以回收这些Class对象。
类加载器的分类
引导类加载器:用C++编写的,是JVM自带的类加载器,负责Java平台核心库,用来装载核心类库,该加载器无法直接获取。
扩展类加载器:负责jre/lib/ext目录下的jar包或-D Java.ext.dirs指定目录下的jar包装入工作库
系统类加载器:负责java -classpath或 -D java.class.path所指的目录下的类与jar包装入工作,是最常用的加载器。
public class Test07 { public static void main(String[] args) throws ClassNotFoundException { // 获取系统类的加载器 ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader(); System.out.println(systemClassLoader); // 获取系统类加载器的父类加载器 --> 扩展类加载器 ClassLoader parent = systemClassLoader.getParent(); System.out.println(parent); // 获取扩展类加载器的父类加载器 --> 根加载器(c/c++实现) ClassLoader parent1 = parent.getParent(); System.out.println(parent1); //测试当前类是哪个类加载器加载的 ClassLoader classLoader = Class.forName("com.yjx.reflection.Test07").getClassLoader(); System.out.println(classLoader); // 测试JDK内置的类是谁加载的 ClassLoader classLoader1 = Class.forName("java.lang.Object").getClassLoader(); System.out.println(classLoader1); // 如何获得系统类加载器可以加载的路径 System.out.println(System.getProperty("java.class.path")); } } |
2.4 Class对象的作用
2.4.1 使用Class对象获得运行时类的完整结构
通过反射获取运行时类的完整结构:Field属性、Method方法、Constructor构造器、SuperClass父类、Interface接口、Annotation注解
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.yjx.reflection.User");
// User user = new User(); // c1 = user.getClass(); //通过反射也能获得类Class // 获得类的名字 System.out.println(c1.getName()); // 获得包名 + 类名 System.out.println(c1.getSimpleName()); // 获得类名 // 获得类的属性 System.out.println("================"); Field[] fields = c1.getFields(); // 只能找到public属性 for (Field field : fields) { System.out.println(field); } // 获得类的属性 能打印出来 System.out.println("=========="); Field[] declaredFields = c1.getDeclaredFields(); // 找到全部的属性 for (Field declaredField : declaredFields) { System.out.println(declaredField); } // 获得指定属性 System.out.println(c1.getDeclaredField("age")); //获得类的方法 System.out.println("=====获得类的方法1====="); //获得本类和父类的所有public方法:User类和Object类 Method[] methods = c1.getMethods(); for (Method method : methods) { System.out.println(method); } System.out.println("=====获得类的方法2====="); Method[] declaredMethods = c1.getDeclaredMethods(); // 获得本类的所有方法 for (Method declaredMethod : declaredMethods) { System.out.println(declaredMethod); } // 获得指定的方法 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); } constructors = c1.getDeclaredConstructors(); // 获得本类所有的构造方法 for (Constructor constructor : constructors) { System.out.println("****" + constructor); } // 需要指明构造器参数类型 System.out.println("获得指定构造器:" + c1.getDeclaredConstructor(null)); System.out.println("获得指定构造器:" + c1.getDeclaredConstructor(int.class, int.class, String.class)); } } |
2.4.2 创建对象
创建类的对象:调用Class对象的newInstance()方法
1.类必须有一个无参数的构造器;
没有无参构造器创建对象的方法:
只要在操作的时候明确的调用类中的构造器,并将参数传递进去之后,才可以实例化操作:
步骤:
1.通过Class类的getDeclaredConstructor(Class...parameterTypes)取得本类的指定形参类型的构造器;
2.向构造器的形参中传递一个对象数组进去,里面包含了构造器中所需的各个参数;
3.通过Constructor实例化对象。
2.类的构造器的访问权限需要足够。
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.yjx.reflection.User"); // 构造一个对象 使用无参构造器 // User user = (User)c1.getDeclaredConstructor(null).newInstance(); //本质是调用了类的无参构造器 // System.out.println(user); // 使用有参构造器创建对象 User user = (User) c1.getDeclaredConstructor(int.class, int.class, String.class).newInstance(18, 1, "yjx"); System.out.println(user); // 通过反射调用普通方法 User user1 = (User) c1.getDeclaredConstructor(int.class, int.class, String.class).newInstance(24, 2, "dyt"); // 通过反射获取一个方法 Method setName = c1.getDeclaredMethod("setName", String.class); setName.invoke(user1, "tt"); //invoke()激活的意思, (对象,“方法的值”) System.out.println(user1.getName()); // 通过反射操作属性 User user2 = (User) c1.getDeclaredConstructor(int.class, int.class, String.class).newInstance(22, 3, "dyt"); Field name = c1.getDeclaredField("name"); // 操作私有属性name 不能直接操作私有属性,我们需要关闭程序的安全检测,通过设置属性或者方法的setAccessible(true)实现 name.setAccessible(true); // 关掉私有权限访问的问题 name.set(user2, "框看"); System.out.println(user2.getName()); } } |
2.4.3 调用指定方法
调用指定的方法:
1.通过Class类的getMethod("方法名", 参数类型列表)获得一个Method对象;
2. Method.invoke("执行方法的对象",参数值列表)进行调用,格式:
Object invoke(Object obj, Object...args):
Object对应原方法的返回值,若原方法没有返回值,此时返回null;
若原方法为静态方法,此时形参Object obj可为null;
若原方法形参列表为空,则Object[ ]args为null;
若原方法声明为private,则需要在调用此invoke()方法前,显式调用方法对象的setAccessible(true)方法,才可访问该方法。
(代码示例同上)
性能分析
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("普通方式执行10亿次:" + (endTime - startTime) + "ms"); } // 反射方式调用 public static void test02() throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException { 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 test03() throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException { 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 ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException { test01(); test02(); test03(); } } |
2.4.5 通过反射获取泛型信息
通过反射获取泛型
Java采用泛型擦除的机制来引入泛型,Java中的泛型仅仅是给编译器javac使用的,确保数据的安全性和免去强制类型转换问题,但是,一旦编译完成﹐所有和泛型有关的类型全部擦除。
为了通过反射操作这些类型,Java新增了ParameterizedType , GenericArrayType ,TypeVariable和WildcardType几种类型来代表不能被归一到Class类中的类型但是又和原始类型齐名的类型。
ParameterizedType:表示一种参数化类型,比如Collection
GenericArrayType:表示一种元素类型是参数化类型或者类型变量的数组类型
TypeVariabie:是各种类型变量的公共父接口
WildcardType:代表一种通配符类型表达
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 method = Test11.class.getDeclaredMethod("test01", Map.class, List.class); Type[] genericParameterTypes = method.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 method2 = Test11.class.getDeclaredMethod("test02", null); Type genericReturnType = method2.getGenericReturnType(); if (genericReturnType instanceof ParameterizedType){ //如果返回值类型是参数化类型/泛型 Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments(); for (Type actualTypeArgument : actualTypeArguments) { System.out.println("**" + actualTypeArgument); } } } } |
反射操作注解
注解类:
// 类名的注解 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @interface Tablekuang{ String value(); } // 属性的注解 @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @interface Fieldkuang{ String columnName(); String type(); int length(); } |
实体类:
@Tablekuang("db_student") class Student2{ @Fieldkuang(columnName = "db_id",type = "int", length = 10) private int id; @Fieldkuang(columnName = "db_age",type = "int", length = 10) private int age; @Fieldkuang(columnName = "db_name",type = "varchar", length = 3) private String name; 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; } public Student2() { } } |
测试:
import java.lang.annotation.*; import java.lang.reflect.Field; // 练习反射操作注解 public class Test12 { public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException { Class<?> c1 = Class.forName("com.yjx.reflection.Student2"); // 通过反射获得注解 Annotation[] annotations = c1.getAnnotations(); for (Annotation annotation : annotations) { System.out.println(annotation); } // 获得指定注解的value的值 Tablekuang tablekuang = c1.getAnnotation(Tablekuang.class); String value = tablekuang.value(); System.out.println("tablekuang注解的值为:" + value); // 获得类指定属性的指定值注解 Field f = c1.getDeclaredField("id"); Fieldkuang annotation = f.getAnnotation(Fieldkuang.class); System.out.println(annotation.columnName()); System.out.println(annotation.type()); System.out.println(annotation.length()); // 反射框架的实现就是利用这个获得信息,实现SQL语言的拼接 } } |
运行结果:
- 利用Jdk动态代理模拟MyBatis的Mapper功能
本文将先介绍jdk动态代理的基本用法,并对其原理和注意事项予以说明。之后将以两个最常见的应用场景为例,进行代码实操。这两个应用场景分别是拦截器和声明性接口,它们在许多开发框架中广泛使用。比如在spring和mybatis中均使用了拦截器模式,在mybatis中还利用动态代理来实现声明性接口的功能。因此,掌握动态代理的原理和代码书写方式,对阅读理解这些开源框架非常有益。
示例代码基于jdk8编写
小示例
先来看一个jdk代理的最小demo
package demo.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Proxy; public class JdkProxyBasicDemo { // ⑴ 定义业务接口 interface BusinessInterface { void greeting(String str); } // ⑵ 编写代理逻辑处理类 static class ProxyLogicHandler implements InvocationHandler { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { System.out.printf("运行的代理类为: %s\n", proxy.getClass().getName()); System.out.printf("调用的代理方法为: %s\n", method.getName); System.out.printf("调用方法的参数为: %s\n", args[0]); System.out.println("请在这里插入代码逻辑代码..."); // ⑵.1 return null; // ⑵.2 } } // ⑶ 生成代理实例,并使用 public static void main(String[] args) { ProxyLogicHandler proxyLogicHandler = new ProxyLogicHandler(); Class[] interfaces = new Class[]{BusinessInterface.class}, BusinessInterface businessProxy = (BusinessInterface) Proxy.newProxyInstance(BusinessInterface.class.getClassLoader(), proxyLogicHandler); businessProxy.greeting("Hello, Jdk Proxy"); } } |
上述代码执行后的输出结果如下:
运行的代理类为: class com.sun.proxy.$Proxy0 调用的代理方法为: greeting 调用方法的参数为: Hello, Jdk Proxy 请在这里插入代理的逻辑代码... |
其中倒数第二行的businessProxy变量,就是一个代理对象,它是BusinessInterface接口的一个实例,但我们并没有编写这个接口的实现类,而是通过Proxy.newProxyInstance方法生成出了该接口的实例。那么这个动态代理实例对应的Class长什么样子呢?上面的结果输出中已经打印出来了,这个代理类名称为com.sun.proxy.$Proxy0。实际上,如果我们再为另外一个接口生成代理对象的话,它的Class名称为com.sun.proxy.$Proxy1,依次类推。
还有一个值得关注的问题:最重要的逻辑代码应该写在哪里?答案是写在InvocationHandler这个接口的invoke()方法中,也就是上面示例代码的第⑵处。由此可以看出:代理对象实际要执行的代码,就是invoke()方法中的代码,换言之,代理对象所代理的所有接口方法,最终要执行的代码都在invoke方法里,因此,这里是一切魔法的入口。
编写一个jdk代理实例的基本步骤如下:
编写业务接口
因为jdk代理是基于接口的,因此,只能将业务方法定义成接口,但它可以一次生成多个接口的代理对象
编写调用处理器
即编写一个java.lang.reflect.InvocationHandler接口的实现类,代理对象的业务逻辑就写在该接口的invoke方法中
生成代理对象
有了业务接口和调用处理器后,将二者作为参数,通过Proxy.newProxyInstance方法便可以生成这个(或这些)接口的代理对象。比如上述示例代码中的businessProxy对象,它拥有greeting()这个方法,调用该方法时,实际执行的就是invoke方法。
- 编写一个jdk代理实例的基本步骤如下:
编写业务接口
因为jdk代理是基于接口的,因此,只能将业务方法定义成接口,但它可以一次生成多个接口的代理对象
编写调用处理器
即编写一个java.lang.reflect.InvocationHandler接口的实现类,代理对象的业务逻辑就写成该接口的invoke方法中
生成代理对象
有了业务接口和调用处理器后,将二者作为参数,通过Proxy.newProxyInstance方法便可以生成这个(或这些)接口的代理对象。比如上述示例代码中的businessProxy对象,它拥有greeting()这个方法,调用该方法时,实际执行的就是invoke方法。
代理对象生成原理
代理的目的,是为接口动态生成一个实例对象,该对象有接口定义的所有方法。调用对象的这些方法时,都将执行生成该对象时,指定的“调用处理器”中的方法(即invoke方法)。
Proxy.newProxyInstance (ClassLoader loader, Class<?>[] interfaces, InvocationHandler handler)
classloader一般选择当前类的类加载器,interfaces是一个接口数组,newProxyInstance方法将为这组接口生成实例对象,handler中的代码则是生成的实例对象实际要执行的内容,这些代码就位于invoke方法中。在生成代理对象前,会先生成一个Class,这个Class实现了interfaces中的所有接口,且这些方法的内容为直接调用handler#invoke,如下图所示:
代理对象生成原理
代理的目的,是为接口动态生成一个实例对象,该对象有接口定义的所有方法。调用对象的这些方法时,都将执行生成该对象时,指定的“调用处理器”中的方法(即invoke方法)。
生成代理对象的方法签名如下:
Proxy.newProxyInstance (ClassLoader loader, Class<?>[] interfaces, InvocationHandler handler)
classloader一般选择当前类的类加载器,interfaces是一个接口数组,newProxyInstance方法将为这组接口生成实例对象,handler中的代码则是生成的实例对象实际要执行的内容,这些代码就位于invoke方法中。在生成代理对象前,会先生成一个Class,这个Class实现了interfaces中的所有接口,且这些方法的内容为直接调用handler#invoke,如下图所示:
特别说明
InvocationHandler的invoke方法签名为:
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable |
在该方法的实现代码中,不要调用proxy参数的toString方法, 这会导致递归死循环
下面将以小示例中的BusinessInterface接口和ProxyLogicHandler为基础,用普通Java代码的方式,模拟一下Proxy.newProxyInstance的代码逻辑,如下:
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler handler) { return new Proxy0(handler); } static class Proxy0 implements BusinessInterface{ private InvocationHandler handler; BusinessInterface(InvocationHandler handler) { this.handler = handler; } @Override public void greeting(String str) { handler.invoke(this, 'greeting', new Object[]{str}); } } |
上面的代码是示意性的,并不正确,比如它没有使用到loader和interfaces参数,调用hanlder.invoke方法时,对于method参数只是简单的用'greeting'字符串替代,类型都不正确。但这段示意代码很简单明了地呈现了真实的Proxy.newProxyInstance方法内部的宏观流程。
下面再提供一个与真实的newProxyInstance方法稍微接近一点的模拟实现(需要您对jdk里JavaCompiler类的使用有一定了解)
package guzb.diy.proxy; import javax.tools.*; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.OutputStream; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.net.URI; import java.nio.charset.Charset; import java.util.ArrayList; import java.util.List; import java.util.Locale; public class ImitateJdkProxy { public static void main(String[] args) throws Throwable{ InvocationHandler handler = new InvocationHandler() { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { System.out.println("执行invocationHandler#invoke()方法"); System.out.println("调用的代理方法名为:" + method.getName()); System.out.println("调用时传递的参数为:" + args[0]); return null; } }; Foo foo = (Foo) newProxyInstance(ImitateJdkProxy.class.getClassLoader(), Foo.class, handler); foo.sayHi("East Knight"); } /** * 模拟java.lang.reflect.Proxy#newProxyInstance方法 * 这里简化了代理类的类名,固定为:guzb.diy.$Proxy0 */ public static final Object newProxyInstance(ClassLoader loader, Class<?> interfaces, InvocationHandler handler) throws Exception { // 1. 构建代理类源码对象 JavaFileObject sourceCode = generateProxySourceCode(); // 2. 编译代理源代码 JavaBytesFileObject byteCodeFile = new JavaBytesFileObject("guzb.diy.$Proxy0"); JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); StandardJavaFileManager stdFileManager = compiler.getStandardFileManager(null, Locale.CHINA, Charset.forName("utf8")); JavaFileManager fileManager = new ForwardingJavaFileManager(stdFileManager) { @Override public JavaFileObject getJavaFileForOutput(Location location, String className, JavaFileObject.Kind kind, FileObject sibling) throws IOException { return byteCodeFile; } }; List<JavaFileObject> compilationUnits = new ArrayList<>(); compilationUnits.add(sourceCode); JavaCompiler.CompilationTask compilationTask = compiler.getTask(null, fileManager, null, null, null, compilationUnits); if (!compilationTask.call()) { return null; } // 3. 加载编译后的代理类字节码 loader = new ClassLoader() { @Override public Class<?> findClass(String name) throws ClassNotFoundException { byte[] bytes = byteCodeFile.getBytes(); return defineClass(name, bytes, 0, bytes.length); } }; Class clazz = loader.loadClass("guzb.diy.$Proxy0"); // 4. 创建代理类实例并返回 Constructor constructor = clazz.getConstructor(new Class[]{InvocationHandler.class}); return constructor.newInstance(handler); } /** * 生成代理Class的源代码,该代码将在运行期间动态编译和加载。 * 为了便于直观查看代理类的原理,故意采用了这个使用源码编译的方式,实际上, * JDK真实的newProxyInstance方法,内部是采用纯反射+直接生成字节码数组的方式实现的,比较晦涩。 * 这里也简化了代理代码,比如: * 1. 写死了代理类的类名:guzb.diy.$Proxy0 * 2. 写死了要实现的接口和方法 * 不写死的话,需要通过反射遍历所有接口的所有方法,并基于Method对象的方法名、返回类型、参数列表和异常列表, * 创建实现类的方法签名文本,这样的话,代码就太冗长了,干扰了对代理主线逻辑的理解,也不是本文的重点 * 3. 没有使用调用者传递的ClassLoader来加载编译后的字节码文件,原因同上,涉及加载器的隔离问题,代码过于冗长 */ private static JavaFileObject generateProxySourceCode() throws NoSuchMethodException { String[] codeLines = new String[]{ "package guzb.diy;", "import java.lang.reflect.*;", "import guzb.diy.proxy.ImitateJdkProxy.Foo;", "public class $Proxy0 implements Foo { ", " private InvocationHandler handler; ", " ", " public $Proxy0 (InvocationHandler handler) { ", " this.handler = handler; ", " } ", " ", " @Override ", " public void sayHi(String name) throws Throwable { ", " Method method = Foo.class.getMethod(\"sayHi\", new Class[]{String.class}); ", " this.handler.invoke(this, method, new Object[]{name}); ", " }", "}" }; String code = ""; for (String codeLine : codeLines) { code += codeLine + "\n"; } return new JavaStringFileObject("guzb.diy.$Proxy0", code); } /** 一个简单的业务接口 */ public interface Foo { void sayHi(String name) throws Throwable; } /** 基于字符串的Java源代码对象 */ public static class JavaStringFileObject extends SimpleJavaFileObject { // 源代码文本 final String code; /** * @param name Java源代码文件名,要包含完整的包名,比如guzb.diy.Proxy * @param code Java源代码文本 */ JavaStringFileObject(String name, String code) { super(URI.create("string:///" + name.replace('.','/') + Kind.SOURCE.extension), Kind.SOURCE); this.code = code; } @Override public CharSequence getCharContent(boolean ignoreEncodingErrors) { return code; } } /** 编译后的字节码文件 */ public static class JavaBytesFileObject extends SimpleJavaFileObject { // 接收编译后的字节码 private ByteArrayOutputStream byteCodesReceiver; /** @param name Java源代码文件名,要包含完整的包名,比如guzb.diy.Proxy */ protected JavaBytesFileObject(String name) { super(URI.create("bytes:///" + name + name.replace(".", "/")), Kind.CLASS); byteCodesReceiver = new ByteArrayOutputStream(); } @Override public OutputStream openOutputStream() throws IOException { return byteCodesReceiver; } public byte[] getBytes() { return byteCodesReceiver.toByteArray(); } } } |
代码运行结果为:
执行invocationHandler#invoke()方法 调用的代理方法名为:sayHi 调用时传递的参数为:East Knight |
应用场景
上面提到:代理是在运行期,为接口动态生成了一个实现类,和这个实现类的实例。那这个功能有什么用呢?我们直接写一个实现类不也是一样的么?代理类与我们手动写代码的主要差异在于它的动态性,它允许我们在程序的运行期间动态创建Class,这对于框架类程序,为其预设的业务组件增加公共特性提供了技术支持。因为这种额外特性的加持,对业务代码没有直接的侵入性,因此效果非常好。动态代理的两个最常用见应用场景为拦截器和声明性接口,下面分别介绍。
拦截器功能
搭载器就是将目标组件劫持,在执行目标组件代码的前后,塞入一些其它代码。比如在正式执行业务方法前,先进行权限校验,如果校验不通过,则拒绝继续执行。对于此类操作,业界已经抽象出一组通用的编程模型:面向切面编程AOP。
接下来,将以演员和导演为业务背景,实现一个简易的拦截器,各个组件介绍如下:
Performer <Interface>
演员接口,有play和introduction方法
DefaultActor <Class>
代表男性演员,它实现了Performer接口,也是拦截器将要拦截的对象
Director <Interface>
导演接口,只有一个getCreations方法, 该方法返回一个字符串列表,它代表导演的作品集
DefaultDirector <Class>
Director接口的实现类,同时也是拦截器将要拦截的对象
ProxyForInterceptor <Class>
拦截器核心类,实现了InvocationHandler接口,拦截器代码位于接口的invoke方法中。
拦截器将持有Performer和Direcotor的真实实现实例,并在调用Performer的play和introduction方法前,先执行一段代码。这里实现为打印一段文本,接着再调用play或introduction,执行完后,再执行一段代码,也是打印一段文本。Director实例方法的拦截处理逻辑与此相同。这便是最简单的拦截器效果了。
IntercepterTestMain <Class>
拦截器测试类,在main方法中,验证上述组件的拦截器功能效果。这个例子中,特意写了两个接口和两个实现类,就是为了演示,JDK的动态代理是支持多接口的。
Performer |
package guzb.diy.proxy; /** * 演员接口 * 在这个示例中,将为该接口生成代理实例 */ public interface Performer { /** * 根据主题即兴表演一段 * @param subject 表演的主题 */ void play(String subject); /** 自我介绍 */ String introduction(); } |
DefaultActor |
package guzb.diy.proxy; /** * 这是演员接口的默认实现类 * 在本示例中,它将作为原始的接口实现者,被代理(拦截) */ public class DefaultActor implements Performer { @Override public void play(String subject) { System.out.println("[DefaultActor]: 默认男演员正在即兴表演《"+ subject +"》"); } @Override public String introduction() { return "李白·上李邕: 大鹏一日同风起,扶摇直上九万里。假令风歇时下来,犹能颠却沧溟水。世人见我恒殊调,闻余大言皆冷笑。宣父尚能畏后生,丈夫未可轻年少。"; } } |
Director |
package guzb.diy.proxy; import java.util.List; /** * 导演接口 * 在这个示例中,将为该接口生成代理实例 */ public interface Director { /** * 获取曾导演过的作品集 * @return 作品名称列表 */ List<String> getCreations(); } |
DefaultDirector |
package guzb.study.javacore.proxy.jdk; import java.util.ArrayList; import java.util.List; /** * 这是导演接口的默认实现类 * 在本示例中,它将作为原始的接口实现者,被代理(拦截) */ public class DefaultDirector implements Director{ @Override public List<String> getCreations() { return new ArrayList(){ { add("活着"); add("盲井"); add("走出夹边沟"); add("少年派的奇幻漂流"); } }; } } |
ProxyForInterceptor |
package guzb.diy.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; /** * 代理应用场景一:拦截器 * 即在原来的业务逻辑上追加额外的代码,这是代理功能最常见的应用场景。 * * 在本示例中,导演与演员实例代表原始业务, * 由于代理的目的是在执行真实的接口实现类方法的前后,执行一段其它代码。 * 因此,本类需要持有原始的导演和演员实例。 */ public class ProxyForInterceptor implements InvocationHandler { // 原始的演员对象 private Performer performer; // 原始的导演对象 private Director director; public ProxyForInterceptor(Director director, Performer performer) { this.director = director; this.performer = performer; } @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { String methodName = method.getName(); System.out.printf("[DirectorActorProxyHandler]: 调用的代理方法为:%s\n", methodName); System.out.printf("[DirectorActorProxyHandler]: >>> 调用 %s 之前的逻辑\n", methodName); Object result = null; // 因为本代理处理器,只针对Director和Actor接口,因此,如果方法名为play,则一定调用的是Actor的play方法 // 根据Actor#play方法的参数定义,它只有一个String参数,所以直接取args[0]即可 if(methodName.equals("play")) { performer.play((String)args[0]); } else if (methodName.equals("introduction")) { result = performer.introduction(); } else if (methodName.equals("getCreations")) { result = director.getCreations(); } System.out.printf("[DirectorActorProxyHandler]: <<< 调用 %s 之后的逻辑\n", methodName); return result; } } |
IntercepterTestMain |
package guzb.diy.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Proxy; import java.util.List; public class IntercepterTestMain { public static void main(String[] args) { Performer actor = new DefaultActor(); Director director = new DefaultDirector(); InvocationHandler interceptor = new ProxyForInterceptor(director, actor); // 要代理的接口,这里称之为委托接口,即委托给代理实例,去实现相应的功能 Class[] principalInterfaces = new Class[]{Director.class, Performer.class}; // 创建一个代理实例,该实例实现了委托接口所定义的方法,因此,这个实例可以强转为Performer和Director Object directorPerformerProxy = Proxy.newProxyInstance(IntercepterTestMain .class.getClassLoader(), principalInterfaces, interceptor); Performer performerProxy = (Performer) directorPerformerProxy; Director directorProxy = (Director) directorPerformerProxy; // ① 调用代理实例中,Performer接口相关的方法 performerProxy.play("长板坡"); String introduction = performerProxy.introduction(); System.out.printf("[IntercepterTestMain ]: 代理对象返回的个人简介内容为: %s\n", introduction); // 调用代理实例中,Director接口相关的方法 List<String> creations = directorProxy.getCreations(); System.out.println("[IntercepterTestMain ]: 代理对象返回的导演作品列表:"); for (String creation : creations) { System.out.printf(" · %s\n", creation); } } } |
以上代码的执行结果如下:
[DirectorActorProxyHandler]: 调用的代理方法为:play [DirectorActorProxyHandler]: >>> 调用 play 之前的逻辑 [DefaultActor]: 默认男演员正在即兴表演《长板坡》 [DirectorActorProxyHandler]: <<< 调用 play 之后的逻辑 [DirectorActorProxyHandler]: 调用的代理方法为:introduction [DirectorActorProxyHandler]: >>> 调用 introduction 之前的逻辑 [DirectorActorProxyHandler]: <<< 调用 introduction 之后的逻辑 [IntercepterTestMain ]: 代理对象返回的个人简介内容为: 李白·上李邕: 大鹏一日同风起,扶摇直上九万里。假令风歇时下来,犹能颠却沧溟水。世人见我恒殊调,闻余大言皆冷笑。宣父尚能畏后生,丈夫未可轻年少。 [DirectorActorProxyHandler]: 调用的代理方法为:getCreations [DirectorActorProxyHandler]: >>> 调用 getCreations 之前的逻辑 [DirectorActorProxyHandler]: <<< 调用 getCreations 之后的逻辑 [IntercepterTestMain ]: 代理对象返回的导演作品列表: · 活着 · 盲井 · 走出夹边沟 · 少年派的奇幻漂流 |
可以看到,在main方法中,调用代理类的play方法后(位于代码的①处),在执行真实的DefaultActor#play方法前后,均有额外的文本输出,这些都不是DefaultActor#play方法的逻辑。这便实现了拦截器效果,且对于使用者而言(即编写DefaultActor类的开发者),是无侵入无感知的。
声明性接口
声明性接口的特点是:开发者只需要提供接口,并在接口方法中声明该方法要完成的功能(通常是以多个注解的方式声明),但不用编写具体的功能实现代码,而是通过框架的工厂方法来获取该接口的实例。当然,该实例会完成接口方法中所声明的那些功能。比较典型的产品是MyBatis的Mapper接口。实现手段也是采用jdk动态代理,在InvocationHandler的invoke方法中,完成该接口方法所声明的那些特性功能。
接下来,本文将模拟MyBatis的Mapper功能,组件说明如下:
SqlMapper <Annotaton>
与MyBatis的Mapper注解等效,用于标识一个接口为Sql映射接口,但在本示例中,这个接口并未使用到。因为这个标识接口的真实用途,是在SpringBoot环境中,用于自动扫描和加载Mapper接口的。本示例仅模拟Mapper本身的声明性功能,因此用不上它。保留这个接口,只是为了显得更完整。
Select <Annotation>
与MyBatis的Select注解等效,它有一个sql属性,用于指定要执行的SQL语句,且支持#{}形式的插值
ParamName <Annotation>
与MyBatis的Param注解等效,用于标识Mapper接口的方法参数名称,以便用于Select注解中sql语句的插值替换
PerformerMapper <Interface>
演员实体的数据库访问接口,与开发者使用MyBatis时,日常编写的各类Mapper接口一样。在里边定义各种数据库查询接口方法,并利用Select和ParamName注解,声明数据操作的具体功能。
ProxyForDeclaration <Class>
整个Mapper功能的核心类,实现了InvocationHandler接口,在invoke方法中,完成Mapper的所有功能
DeclarationTestMain <Class>
声明性接口的功能测试类,在main方法中,通过jdk代理获得一个PerformerMapper实例,并调用其中的getQuantityByNameAndAage、getRandomPoetryOf和listAllOfAge方法,分别传入不的SQL和参数,用以验证3种不同的情况。
下面是各个组件的源代码:
SqlMapper |
package guzb.diy.proxy; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 标识一个接口是一个SQL映射类,用于模拟MyBatis的mapper功能 */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) public @interface SqlMapper { } |
Select |
package guzb.diy.proxy; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 为一个mapper方法指定查询类sql语句 * 本类用于模拟MyBatis的mapper功能 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Select { /** * 查询sql语句,支持#{}这样的插值占位符 */ String sql(); } |
ParamName |
package guzb.diy.proxy; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 为一个mapper方法的参数,指定一个名称,以便在sql语句中进行插值替换 * 本类用于模拟MyBatis的mapper功能 */ @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) public @interface ParamName { /** 参数的名称 */ String value(); } |
PerformerMapper |
package guzb.diy.proxy; /** * 演员实体查询接口。 * 本类用于模拟MyBatis的mapper功能 */ @SqlMapper public interface PerformerMapper { @Select(sql = "select count(*) from performer where name=#{name} and age = #{ age }") Long getQuantityByNameAndAage(@ParamName("name") String name, @ParamName("age") Integer age); @Select(sql = "select poetry_item from poetry where performer_name = #{ name }") String getRandomPoetryOf(@ParamName("name") String name); // ② SQL中故障引入了一个pageSize的变量,由于方法签名中没有声明这个参数,因此会导致SQL在插值替换阶段发生异常 @Select(sql = "select * from performer where age >= #{age} limit #{ pageSize }") Object listAllOfAge(@ParamName("age") int age); } |
ProxyForDeclaration |
package guzb.diy.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Parameter; import java.util.Collections; import java.util.HashMap; import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * 〔声明性接口〕功能的核心实现类 */ public class ProxyForDeclaration implements InvocationHandler { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { System.out.printf("[ProxyForDeclaration]: 调用的方法名为:%s\n", method.getName()); // 1. 先提取出原始的SQL String rawSql = extractSql(method); if (rawSql == null || rawSql.trim().length() == 0) { System.out.printf("[ProxyForDeclaration]: 方法%s()未指定SQL语句,无法执行。请通过@Select注解指定Sql\n", method.getName()); return null; } System.out.printf("[ProxyForDeclaration]: 原始sql为:%s\n", rawSql); // 2. 对原始SQL做插值替换,String类型的参数追加''号,其它类型原样替换 String finalSql = interpolateSql(rawSql, method, args); System.out.printf("[ProxyForDeclaration]: 插值替换后的sql为:%s\n", finalSql); // 3. 模拟执行SQL语句 return imitateJdbcExecution(finalSql, method.getReturnType()); } private String extractSql(Method method) { Select selectAnnotation = method.getAnnotation(Select.class); return selectAnnotation == null ? null : selectAnnotation.sql(); } private String interpolateSql(String rawSql, Method method, Object[] args) { // 使用正则表达式来完成插值表达式#{}的内容替换 Pattern interpolationTokenPattern = Pattern.compile("(#\\{\\s*([a-zA-Z0-9]+)\\s*\\})"); Matcher matcher = interpolationTokenPattern.matcher(rawSql); // 提取出方法参数名称与参数对象的对应关系,key为参数名(通过@ParamName注解指定),value为参数对象 Map<String, Object> paramMap = extractParameterMap(method, args); // 插值替换 String finalSql = rawSql; while (matcher.find()) { String interpolationToken = matcher.group(1); String parameterName = matcher.group(2); if (!paramMap.containsKey(parameterName)) { throw new SqlMapperExecuteException("未知参数:" + parameterName); } Object value = paramMap.get(parameterName); String valueStr = value instanceof String ? "'" + value.toString() + "'" : value.toString(); finalSql = finalSql.replace(interpolationToken, valueStr); } return finalSql; } private Map<String, Object> extractParameterMap(Method method, Object[] args) { Parameter[] parameters = method.getParameters(); if (parameters.length == 0) { return Collections.EMPTY_MAP; } Map<String, Object> sqlParamMap = new HashMap<>(); for (int i = 0; i < parameters.length; i++) { Parameter parameter = parameters[i]; ParamName paramName = parameter.getAnnotation(ParamName.class); // 这里不用检查数组越界问题,因为args参数本身就是调用接口方法时的传递的参数,只要是正常调用(不是通过反射)就不会越界 sqlParamMap.put(paramName.value(), args[i]); } return sqlParamMap; } /** 模拟执行jdbc sql, 这里仅对数字和字符串进行了模拟,其它返回null */ private Object imitateJdbcExecution(String finalSql, Class<?> returnType) { if(Number.class.isAssignableFrom(returnType)){ return (long)(Math.random() * 1000 + 1); } if (returnType == String.class) { String[] poetry = new String[]{ "黄四娘家花满蹊,千朵万朵压枝低。", "留连戏蝶时时舞,自在妖莺恰恰啼。", "荷尽已无擎雨盖,菊残犹有傲霜枝。", "一年好景君须记,最是橙黄橘绿时。" }; int index = (int)(Math.random() * 4); return poetry[index]; } return null; } static class SqlMapperExecuteException extends RuntimeException { public SqlMapperExecuteException(String message) { super(message); } } } |
DeclarationTestMain |
package guzb.diy.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Proxy; import java.util.List; /** * 〔声明性接口〕功能测试入口类 */ public class DeclarationTestMain { public static void main(String[] args) { Class[] principalInterfaces = new Class[]{PerformerMapper.class}; ProxyForDeclaration declarationHandler = new ProxyForDeclaration(); PerformerMapper performerMapper = (PerformerMapper) Proxy.newProxyInstance(JdkProxyStudyMain.class.getClassLoader(), principalInterfaces, declarationHandler); Long count = performerMapper.getQuantityByNameAndAage("Jane Lotus", 47); System.out.printf("[DeclarationTestMain]: 代理实例方法方法的返回值为:%s\n\n", count); String poetryItem = performerMapper.getRandomPoetryOf("杜甫"); System.out.printf("[DeclarationTestMain]: 代理实例方法的返回值为:%s\n\n", poetryItem); // ③ 本方法调用后将发生异常,因为PerformerMapper中的②处,声明的SQL有未知的插值变量,这里特意测试验证 performerMapper.listAllOfAge(100); } } |
以上代码的执行结果为: |
[ProxyForDeclaration]: 调用的方法名为:getQuantityByNameAndAage [ProxyForDeclaration]: 原始sql为:select count(*) from performer where name=#{name} and age = #{ age } [ProxyForDeclaration]: 插值替换后的sql为:select count(*) from performer where name='Jane Lotus' and age = 47 [DeclarationTestMain]: 代理实例方法方法的返回值为:40 [ProxyForDeclaration]: 调用的方法名为:getRandomPoetryOf [ProxyForDeclaration]: 原始sql为:select poetry_item from poetry where performer_name = #{ name } [ProxyForDeclaration]: 插值替换后的sql为:select poetry_item from poetry where performer_name = '杜甫' [DeclarationTestMain]: 代理实例方法的返回值为:黄四娘家花满蹊,千朵万朵压枝低。 [ProxyForDeclaration]: 调用的方法名为:listAllOfAge [ProxyForDeclaration]: 原始sql为:select * from performer where age >= #{age} limit #{ pageSize } Exception in thread "main" guzb.diy.proxy.ProxyForDeclaration$SqlMapperExecuteException: 未知参数:pageSize at guzb.diy.proxy.ProxyForDeclaration.interpolateSql(ProxyForDeclaration.java:55) at guzb.diy.proxy.ProxyForDeclaration.invoke(ProxyForDeclaration.java:29) at com.sun.proxy.$Proxy1.listAllOfAge(Unknown Source) at guzb.diy.proxy.DeclarationTestMain.main(JdkProxyStudyMain.java:24) |
以上代码共模拟了3个调用Mapper的场景:
调用getQuantityByNameAndAage()方法根据姓名的年龄查询演员数量。但并未真正执行JDBC查询,只是将SQL进行了插值替换和输出,然后随机返回了一个数字。这足以演示声明性接口这一特性了,真实地执行jdbc查询,那将一个代码量巨大的工作,它的缺失并不影响本示例的主旨。
调用getRandomPoetryOf()方法查询指定诗人的一段诗句。同样没有真正执行jdbc查询,而是随机返回了一句诗文。
调用listAllOfAge()方法查询指定年龄的所有演员。该方法有意设计为引发一个异常,因为接口方法上声明的SQL中,pageSize这个插值变量并未在方面签名中声明。