一 什么是代理模式?
代理模式:是为一个对象提供一个替身,以控制对这个对象的访问。即通过代理对象访问目标对象。
这样做的好处是:以不改变目标对象为前提,在目标对象的基础上,增添额外的功能,即扩展目标对象的功能。
被代理的对象:可以是远程对象、创建开销大的对象或者需要安全控制的对象。
代理模式的分类:
- 静态代理模式
- 动态代理模式:动态代理又可以分为JDK动态代理和cglib动态代理
代理模式的示意图:
代理模式是AOP思想的一种体现
二 静态代理
1. 静态代理概述
静态代理在使用时,需要定义接口或者父类,被代理对象(即目标对象)与代理对象一起实现相同的接口或者是继承相同父类。
2. 静态代理案例分析
1) 定义一个接口:ITeacherDao
2) 目标对象TeacherDAO实现接口ITeacherDAO
3) 使用静态代理方式,就需要在代理对象TeacherDAOProxy中也实现ITeacherDAO
4) 调用的时候通过调用代理对象的方法来调用目标对象.
5) 特别提醒:代理对象与目标对象要实现相同的接口,然后通过调用相同的方法来调用目标对象的方法。
3. 静态代理案例实现
1) 接口
public interface ITeacherDao {
public void teach();
}
2) 目标类(对象)
//TeacherDao必须实现ITeacherDao这个接口
public class TeacherDao implements ITeacherDao {
public void teach() {
System.out.println("老师教课");
}
}
3) 代理类(对象)
//TeacherDaoProxy必须和TeacherDao实现相同的接口,即ITeacherDao
public class TeacherDaoProxy implements ITeacherDao {
//聚合目标对象
private ITeacherDao target;
public TeacherDaoProxy(ITeacherDao target) {
this.target = target;
}
public void teach() {
System.out.println("开始代理");
target.teach();
System.out.println("代理结束");
}
}
4) 客户端类(测试类)
public class Client {
public static void main(String[] args) {
//创建目标对象
ITeacherDao iTeacherDao=new TeacherDao();
//创建代理对象
TeacherDaoProxy teacherDaoProxy=new TeacherDaoProxy(iTeacherDao);
//通过代理对象调用方法
teacherDaoProxy.teach();
}
}
4. 静态代理的优缺点
-
优点:在不修改目标对象的功能前提下, 能通过代理对象对目标功能扩展
-
缺点:因为代理对象需要与目标对象实现一样的接口,所以会有很多代理类;一旦接口增加方法,目标对象与代理对象都要维护
三 JDK动态代理
1. JDK动态代理概述
JDK动态代理概述,又称为基于接口的动态代理,被代理对象必须实现接口,否则不能被代理。和静态代理不一样,JDK动态代理的代理对象不需要实现接口。
代理对象的生成,是利用JDK的API,动态的在内存中创建代理对象。
2. JDK 中生成代理对象的API
1) 代理类所在包:java.lang.reflect.Proxy
2) JDK实现代理只需要使用newProxyInstance方法,但是该方法需要接收三个参数,完整的写法是:
static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces,InvocationHandler h )
3. JDK动态态代理案例分析
和静态代理使用的案例一样
4. JDK动态代理的案例实现
1) 接口
public interface ITeacherDao {
public void teach();
public void eat();
}
2) 目标类(目标对象)
//目标对象必须实现接口,即ITeacherDao,否则不能被代理
public class TeacherDao implements ITeacherDao{
public void teach() {
System.out.println("老师教课");
}
public void eat() {
System.out.println("老师开始吃饭了");
}
}
3) 代理工厂
生成代理对象使用的是Proxy类的newProxyInstance方法
newProxyInstance方法有三个参数
- 第一个:目标对象的类的类加载器
- 第二个:目标对象实现的接口
- 第三个:InvocationHandler接口的实例(实现这个接口的时候必须实现这个接口的invoke方法)
invoke方法的参数(主要使用method参数,和args参数)
- method是代理对象调用的方法
- args是代理对象调用的方法的参数
在invoke方法中写对目标对象的增强代码以及通过反射机制调用目标对象的方法
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class ProxyFactory {
private Object target;
public ProxyFactory(Object target) {
this.target = target;
}
public Object getProxyInstance() {
return Proxy.newProxyInstance(target.getClass().getClassLoader(),
target.getClass().getInterfaces(),
new InvocationHandler() {
/**
* 作用:执行被代理对象的任何接口方法都会经过该方法
* 方法参数的含义
* @param proxy 代理对象的引用
* @param method 当前执行的方法
* @param args 当前执行方法所需的参数
* @return 和被代理对象方法有相同的返回值
* @throws Throwable
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//代理对象中增强的部分
System.out.println("代理开始了");
//执行目标对象的方法,在这里是使用的反射机制调用方法
//method是代理对象调用的方法,target是目标对象,args是代理对象调用方法时传的参数
Object returnVal = method.invoke(target, args);//returnVal是代理对象所调用方法的返回值
//代理对象中增强的部分
System.out.println("代理结束了");
return returnVal;
}
});
}
}
4) 客户类(测试类)
方法执行的流程(可以使用debug模式查看)
- 调用teacherDaoProxy.teach()
- 程序跳转到invoke方法中开始执行
- 执行代理对象增强部分,即System.out.println("代理开始了");
- 通过反射机制执行目标对象的方法,即Object returnVal = method.invoke(target, args);其中method就是teach()方法,target就是目标对象,args即使teach()方法传入的参数,returnVal就是teach()方法的返回值
- 执行代理对象增强部分,即System.out.println("代理结束了");
public class Client {
public static void main(String[] args) {
//创建目标对象
TeacherDao target=new TeacherDao();
//创建代理工厂
ProxyFactory proxyFactory=new ProxyFactory(target);
ITeacherDao teacherDaoProxy =(ITeacherDao) proxyFactory.getProxyInstance();
teacherDaoProxy.teach();
/*
输出如下:
代理开始了
老师教课
代理结束了
*/
teacherDaoProxy.eat();
/*
输出如下:
代理开始了
老师吃饭
代理结束了
*/
}
}
5) 不使用工厂来创建目标对象的代理对象并测试
对于cglib动态代理,提供不提供目标对象实例均可;但是JDK动态代理我只找到了提供目标对象实例的写法,不提供目标对象实例的话,我测试的会报错
package com.shangguigu.proxy.jdkDynamicProxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class Client2 {
public static void main(String[] args) {
/**
* 动态代理:
* 特点:字节码随用随创建,随用随加载
* 作用:不修改源码的基础上对方法增强
* 分类:
* 基于接口的动态代理
* 基于子类的动态代理
* 基于接口的动态代理:
* 涉及的类:Proxy
* 提供者:JDK官方
* 如何创建代理对象:
* 使用Proxy类中的newProxyInstance方法
* 创建代理对象的要求:
* 被代理类最少实现一个接口,如果没有则不能使用
* newProxyInstance方法的参数:
* ClassLoader:类加载器
* 它是用于加载代理对象字节码的。和被代理对象使用相同的类加载器。固定写法。
* Class[]:字节码数组
* 它是用于让代理对象和被代理对象有相同方法。固定写法。
* InvocationHandler:用于提供增强的代码
* 它是让我们写如何代理。我们一般都是些一个该接口的实现类,通常情况下都是匿名内部类,但不是必须的。
* 此接口的实现类都是谁用谁写。
*/
//创建目标对象
final TeacherDao target = new TeacherDao();
//创建目标对象的代理对象,使用Proxy.newProxyInstance()方法
ITeacherDao teacherDaoProxy = (ITeacherDao) Proxy.newProxyInstance(target.getClass().getClassLoader(),
target.getClass().getInterfaces(),
new InvocationHandler() {
/**
* 作用:执行被代理对象的任何接口方法都会经过该方法
* 方法参数的含义
* @param proxy 代理对象的引用
* @param method 当前执行的方法
* @param args 当前执行方法所需的参数
* @return 和被代理对象方法有相同的返回值
* @throws Throwable
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//代理对象增强代码
System.out.println("JDK动态代理开始了");
//使用反射机制调用目标对象的方法
Object returnVal = method.invoke(target, args);
//代理对象增强代码
System.out.println("代理结束");
return returnVal;
}
});
teacherDaoProxy.teach();
teacherDaoProxy.eat();
}
}
四 cglib动态代理
1. cglib动态代理概述
- 静态代理和JDK代理模式都要求目标对象是实现一个接口,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候可使用目标对象子类来实现代理-这就是Cglib代理。
- Cglib代理也叫作基于子类的代理,它是在内存中构建一个子类对象从而实现对目标对象功能扩展。
- Cglib是一个强大的高性能的代码生成包,它可以在运行期扩展java类与实现java接口.它广泛的被许多AOP的框架使用,例如Spring AOP,实现方法拦截。
- 在AOP编程中如何选择代理模式:目标对象需要实现接口,用JDK代理;目标对象不需要实现接口,用Cglib代理
- Cglib包的底层是通过使用字节码处理框架ASM来转换字节码并生成新的类
2. cglib动态代理需要导入的jar包,或者在maven工程中的坐标
<!--和cglib相关的依赖,只需要导入这一个依赖即可,只要cglib包导入了,和asm相关的jar会自动导入--> <dependency> <groupId>cglib</groupId> <artifactId>cglib</artifactId> <version>2.2.2</version> </dependency>
3. cglib动态态代理案例分析
和静态代理使用的案例一样
4. cglib动态代理的案例实现
1) 目标类(目标对象)
在cglib动态代理中,目标对象不需要实现接口
//在cglib动态代理中,目标对象不需要实现接口
public class TeacherDao {
public void teach(){
System.out.println("老师在上课");
}
}
2) 代理工厂
package com.shangguigu.proxy.cglibDynamicProxy;
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
//MethodInterceptor:方法拦截器
public class ProxyFactory{
//维护一个目标对象
private Object target;
public ProxyFactory(Object target) {
this.target = target;
}
//该方法能获取一个目标对象的代理对象
public Object getProxyInstance(){
//创建一个加强对象
Enhancer enhancer=new Enhancer();
/*说明要对谁加强,因为cglib动态代理是基于子类的动态代理,
也就是在内存中创建一个目标对象的子类对象以增强目标对象的功能,
所以这里要说明父类是谁*/
enhancer.setSuperclass(target.getClass());
//设置回调函数
enhancer.setCallback(new MethodInterceptor() {
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
System.out.println("cglib动态代理开始");
Object returnVal = method.invoke(target, objects);
System.out.println("代理结束");
return returnVal;
}
});
//创建代理对象,即目标对象的子类对象
return enhancer.create();
}
}
3) 客户类(测试类)
方法执行的流程(可以使用debug模式查看)
- 调用teacherDaoProxy.teach()
- 程序跳转到intercept方法中开始执行
- 执行代理对象增强部分,即System.out.println("cglib动态代理开始");
- 通过反射机制执行目标对象的方法,即Object returnVal = method.invoke(target, objects);
其中method就是teach()方法,target就是目标对象,objects即使teach()方法传入的参数,returnVal就是teach()方法的返回值 - 执行代理对象增强部分,即System.out.println("代理结束");
public class Client {
public static void main(String[] args) {
//创建目标对象
TeacherDao target=new TeacherDao();
//创建代理工厂
ProxyFactory proxyFactory=new ProxyFactory(target);
//获取代理对象
TeacherDao teacherDaoProxy =(TeacherDao) proxyFactory.getProxyInstance();
//通过代理对象调用方法
teacherDaoProxy.teach();
/*
输出结果:
cglib动态代理开始
老师在上课
代理结束
*/
}
}
4) 不使用工厂直接创建目标对象的代理对象并测试
不使用工厂直接创建目标对象的代理对象由两种方式,一是提供目标对象实例,二是不提供目标对象实例
方法一:提供目标对象实例
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class Client2 {
public static void main(String[] args) {
/**
* 动态代理:
* 特点:字节码随用随创建,随用随加载
* 作用:不修改源码的基础上对方法增强
* 分类:
* 基于接口的动态代理
* 基于子类的动态代理
* 基于子类的动态代理:
* 涉及的类:Enhancer
* 提供者:第三方cglib库
* 如何创建代理对象:
* 使用Enhancer类中的create方法
* 创建代理对象的要求:
* 被代理类不能是最终类
*/
//创建目标对象
final TeacherDao target=new TeacherDao();
//创建一个增强类
Enhancer enhancer=new Enhancer();
//说明是给谁增强,给这个增强类设置父类,因为cglib代理是基于子类的代理,即在内存中创建目标类的子类的实例
enhancer.setSuperclass(target.getClass());
//设置Callback,设置Callback可以理解成生成的代理类的方法被调用时(比如说调用teacherDaoProxy.teach()时),会执行的逻辑。
enhancer.setCallback(new MethodInterceptor() {
/**
* 执行北地阿里对象的任何方法都会经过该方法
* @param proxy
* @param method
* @param args
* 以上三个参数和基于接口的动态代理中invoke方法的参数是一样的
* @param methodProxy :当前执行方法的代理对象
* @return
* @throws Throwable
*/
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
//代理对象的增强代码部分
System.out.println("cglib代理开始了");
Object returnVal = methodProxy.invoke(target, objects);
System.out.println("代理结束了");
return returnVal;
}
});
TeacherDao teacherDaoProxy =(TeacherDao) enhancer.create();
teacherDaoProxy.teach();
}
}
方法二:不提供目标对象实例
package com.shangguigu.proxy.cglibDynamicProxy;
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class Client3 {
public static void main(String[] args) {
//创建一个增强类
Enhancer enhancer=new Enhancer();
//说明是给谁增强,给这个增强类设置父类,因为cglib代理是基于子类的代理,即在内存中创建目标类的子类的实例
enhancer.setSuperclass(TeacherDao.class);
//设置Callback,设置Callback可以理解成生成的代理类的方法被调用时(比如说调用teacherDaoProxy.teach()时),会执行的逻辑。
enhancer.setCallback(new MethodInterceptor() {
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
//代理对象的增强代码部分
System.out.println("cglib代理开始了");
Object returnVal = methodProxy.invokeSuper(o, objects);
System.out.println("代理结束了");
return returnVal;
}
});
TeacherDao teacherDaoProxy =(TeacherDao) enhancer.create();
teacherDaoProxy.teach();
}
}