CGLIB(Code Generator Library)是一个强大的、高性能的代码生成库。其被广泛应用于AOP框架(Spring、dynaop)中,用以提供方法拦截操作。Hibernate作为一个比较受欢迎的ORM框架,同样使用CGLIB来代理单端(多对一和一对一)关联。
CGLIB代理主要通过对字节码的操作,为对象引入间接级别,以控制对象的访问。我们知道Java中有一个动态代理也是做这个事情的,那我们为什么不直接使用Java动态代理,而要使用CGLIB呢?答案是CGLIB相比于JDK动态代理更加强大,JDK动态代理虽然简单易用,但是其有一个致命缺陷是,只能对接口进行代理。如果要代理的类为一个普通类、没有接口,那么Java动态代理就没法使用了。
首先创建目标对象:
public class UserManagerImpl {
public void addUser(String userName) {
System.out.println("UserManagerImpl add user name is:" + userName);
}
public void deleteUser(String userName) {
System.out.println("UserManagerImpl delete user name is:" + userName);
}
}
针对这个目标类,假如我们要使用动态代理实现AOP,那么我们只能在写一个增强的接口,然后让目标类实现增强接口,然后我们就可以使用动态代理实现目标类的增强,可是假如我们不想让目标类实现其他的接口,那么我们就只能使用CGLIB技术来实现目标类的增强了。
CGLIB实现目标类增强的原理是这样的:CGLIB会动态创建一个目标类的子类,然后返回该子类的对象,也就是增强对象,至于增强的逻辑则是在子类中完成的。我们知道子类要么和父类有一样的功能,要么就比父类功能强大,所以CGLIB是通过创建目标类的子类对象来实现增强的,所以:
目标子类 = 目标类 + 增强逻辑
引入maven坐标:
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>3.2.0</version>
</dependency>
通过CGLIB代理实现如下:
首先实现一个MethodInterceptor,方法调用会被转发到该类的intercept()方法。
然后在需要使用UserManagerImpl(目标对象)的时候,通过CGLIB动态代理获取代理对象。
我们仍然使用上面的UserManagerImpl作为目标对象,然后我们实现一个MethodInterceptor,在实现MethodInterceptor之前,我们先看一下这个接口是什么:
public interface MethodInterceptor extends Callback {
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable;
}
这里解释一下各个参数的意思:
下面是实现的一个MethodInterceptor,同时写了创建增强对象的逻辑即myCglibCreator()方法,该方法返回增强对象。
public class CglibFactory implements MethodInterceptor {
public <T> T myCglibCreator(Class<T> clazz) {
Enhancer enhancer = new Enhancer();
//将目标类设置为父类,cglib动态代理增强的原理就是子类增强父类,cglib不能增强目标类为final的类
enhancer.setSuperclass(clazz);
//设置回调接口,这里的MethodInterceptor实现类回调接口,而我们又实现了MethodInterceptor
//这里的回调接口就是本类对象,调用的方法其实就是intercept()方法
enhancer.setCallback(this);
//create()方法用于创建cglib动态代理对象
return (T) enhancer.create();
}
//回调接口的方法
//回调接口的方法执行的条件是:代理对象执行目标方法时会调用回调接口的方法
@Override
public Object intercept(Object obj, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
System.out.println("before action");
Object result = methodProxy.invokeSuper(obj, args);
System.out.println("after action");
//这里实现将返回值字符串变为大写的逻辑
return Optional.ofNullable(result).map(r -> String.valueOf(r).toUpperCase()).orElse("");
}
}
其中,Object result = methodProxy.invokeSuper(o, objects);调用代理类实例上的methodProxy方法的父类方法(即实体类UserServiceImpl中对应的方法),然后返回目标方法的返回值result,然后实现增强的逻辑,将返回的字符串变为大写的。下面是测试代码:
@Test
public void test_aop() {
UserManagerImpl proxy = new CglibFactory().myCglibCreator(UserManagerImpl.class);
String result = proxy.addUser("steven");
System.out.println("result is:" + result);
}
输出:
before action
UserManagerImpl add user name is:steven
after action
result is:STEVEN
上述代码中,我们通过CGLIB的Enhancer来指定要代理的目标对象、实际处理代理逻辑的对象,最终通过调用create()方法得到代理对象,对这个对象所有非final方法的调用都会转发给MethodInterceptor.intercept()方法,在intercept()方法里我们可以加入任何逻辑,比如修改方法参数,加入日志功能、安全检查功能等;通过调用MethodProxy.invokeSuper()方法,我们将调用转发给原始对象,具体到本例,就是UserServiceImpl的具体方法。CGLIG中MethodInterceptor的作用跟JDK动态代理代理中的InvocationHandler很类似,都是方法调用的中转站。
通过CGLIB很方便的实现动态增强,但是CGLIB也有其缺陷,那就是必须目标类必须是可以继承的,如果目标类不可继承,那么我们就无法使用CGLIB来增强该类,我们可以称JDK动态代理实现的AOP为面向接口的动态增强,将CGLIB实现的AOP称为面向子类的动态增强。
主要区别: