设计模式之代理模式

代理模式提供了目标对象另外的访问方式,在不修改目标类型的基础上对目标类型进行扩展,符合设计模式中遵循的开闭原则,对扩展开放,对修改关闭。

1. 静态代理

静态代理在使用时需要定义接口或者超类,被代理对象与代理对象一起实现同一个接口或者是继承同一个超类。

下面举个例子说明:
我们在购买火车票时可以到火车站购买,也可到各个代售点购买,火车站就是目标对象,代售点即是代理对象,他们都能完成购票,最主要的是代售点使用的售票接口就是车站官方的售票接口。

票务接口 TicketService.java

1
2
3
4
public interface TicketService{
void buyTicket();
void refund();//退票
}

目标对象车站 Station.java

1
2
3
4
5
6
7
8
public class Station implement TicketService{
public void buyTicket(){
System.out.println("----买票-----");
}
public void refund(){
System.out.println("----退票----");
}
}

代理对象代售处 Agency.java

1
2
3
4
5
6
7
8
9
10
public class Agency implement TicketService{
private Station station;
public void buyTicket(){
System.out.println("----这里是代售点-----");
station.buyTicket();
}
public void refund(){
System.out.println("----代售点不支持退票----")
}
}

静态代理可以在不修改目标对象的前提下对目标扩展,但也存在缺点。

因为代理对象需要与目标对象实现一样的接口,所以会有很多代理类,类太多;此外,一旦接口增加方法,目标对象与代理对象都要维护。
那么如何解决这些缺点呢,JDK中给出了动态代理的解决方案。

2. JDK动态代理

又叫做接口代理

特点:

  1. 被代理对象需要实现接口
  2. 代理对象的生成,是利用JDK中的api,动态的在内存中构建代理对象(需要我们指定创建代理对象/目标对象实现的接口类型)

2.1 使用

JDK中生成代理对象的API代理类所在包:java.lang.reflect.Proxy
JDK实现代理只需要使用newProxyInstance方法,但是该方法需要接收三个参数,完整的写法是:

1
static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces,InvocationHandler h )

注意该方法是在Proxy类中是静态方法,且接收的三个参数依次为:

  • ClassLoader loader:指定当前目标对象使用类加载器,获取加载器的方法是固定的
  • Class<?>[] interfaces:目标对象实现的接口的类型,使用泛型方式确认类型
  • InvocationHandler h:事件处理,执行目标对象的方法时,会触发事件处理器的方法,会把当前执行目标对象的方法作为参数传入。

代码示例:
接口类 TicketService.java以及接口实现类,目标对象Station是一样的,没有做修改。在这个基础上,增加一个代理工厂类(ProxyFactory.java),将代理类写在这个地方,然后在测试类(需要使用到代理的代码)中先建立目标对象和代理对象的联系,然后代用代理对象的中同名方法
代理工厂类:ProxyFactory.java

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
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() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("--这是代售点购票系统--");
//执行目标对象方法
Object returnValue = method.invoke(target, args);
return returnValue;
}
}
);
}

}

测试类:DynamicProxyTest.java

1
2
3
4
5
6
7
8
9
10
11
12
public class DynamicProxyTest {
public static void main(String[] args) {
// 目标对象
TicketService target = new Station();
System.out.println(target.getClass());
// 创建代理对象
TicketService proxy = (TicketService) new ProxyFactory(target).getProxyInstance();
System.out.println(proxy.getClass());
// 代理对象执行方法
proxy.buyTicket();
}
}

总结:代理对象不需要实现接口,但是目标对象一定要实现接口,否则不能用动态代理。

2.2 原理

3. Cglib动态代理

3.1 使用

上面的静态代理和动态代理模式都是要求目标对象是实现一个接口的目标对象,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候就可以使用以目标对象子类的方式类实现代理,这种方法就叫做:Cglib代理

Cglib代理,也叫作子类代理,它是在内存中构建一个子类对象从而实现对目标对象功能的扩展。

  • JDK的动态代理有一个限制,就是使用动态代理的对象必须实现一个或多个接口,如果想代理没有实现接口的类,就可以使用Cglib实现。
  • Cglib是一个强大的高性能的代码生成包,它可以在运行期扩展java类与实现java接口。它广泛的被许多AOP的框架使用,例如Spring AOP和synaop,为他们提供方法的interception(拦截)。
  • Cglib包的底层是通过使用一个小而块的字节码处理框架ASM来转换字节码并生成新的类。不鼓励直接使用ASM,因为它要求你必须对JVM内部结构包括class文件的格式和指令集都很熟悉。

Cglib子类代理实现方法:

  1. 需要引入cglib的jar文件,但是Spring的核心包中已经包括了Cglib功能,所以直接引入pring-core-3.2.5.jar即可。
  2. 引入功能包后,就可以在内存中动态构建子类
  3. 代理的类不能为final,否则报错
  4. 目标对象的方法如果为final/stati,那么就不会被拦截,即不会执行目标对象额外的业务方法。

代码示例:
目标对象类 Station.java ,目标对象,没有实现任何接口

1
2
3
4
5
6
public class Station {

public void buyTicket() {
System.out.println("----买票----");
}
}

Cglib代理工厂 ProxyFactory.java

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
public class ProxyFactory implements MethodInterceptor{
private Object target;
public ProxyFactory(Object target) {
this.target = target;
}

//给目标对象创建一个代理对象
public Object getProxyInstance(){
//1.工具类
Enhancer en = new Enhancer();
//2.设置父类
en.setSuperclass(target.getClass());
//3.设置回调函数
en.setCallback(this);
//4.创建子类(代理对象)
return en.create();

}

@Override
public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
System.out.println("--这是代售点购票系统--");
//执行目标对象的方法
Object returnValue = method.invoke(target, args);
return returnValue;
}
}

测试类:

1
2
3
4
5
6
7
8
9
10
11
public class CglibProxyTest {
@Test
public void test(){
//目标对象
Station target = new Station();
//代理对象
Station proxy = (Station)new ProxyFactory(target).getProxyInstance();
//执行代理对象的方法
proxy.buyTicket();
}
}

在Spring的AOP编程中:
如果加入容器的目标对象有实现接口,用JDK代理
如果目标对象没有实现接口,用Cglib代理

3.2 原理