Java 动态代理 两种实现方法

时间:2024-11-06 16:05:14

AOP的拦截功能是由java中的动态代理来实现的。说白了,就是在目标类的基础上增加切面逻辑,生成增强的目标类(该切面逻辑或者在目标类函数执行之前,或者目标类函数执行之后,或者在目标类函数抛出异常时候执行。不同的切入时机对应不同的Interceptor的种类,如BeforeAdviseInterceptor,AfterAdviseInterceptor以及ThrowsAdviseInterceptor等)。

那么动态代理是如何实现将切面逻辑(advise)织入到目标类方法中去的呢?下面我们就来详细介绍并实现AOP中用到的两种动态代理。

AOP的源码中用到了两种动态代理来实现拦截切入功能:jdk动态代理和cglib动态代理。两种方法同时存在,各有优劣。

jdk动态代理是由java内部的反射机制来实现的,cglib动态代理底层则是借助asm来实现的。

总的来说,反射机制在生成类的过程中比较高效,而asm在生成类之后的相关执行过程中比较高效(可以通过将asm生成的类进行缓存,这样解决asm生成类过程低效问题)。还有一点必须注意:jdk动态代理的应用前提,必须是目标类基于统一的接口。如果没有上述前提,jdk动态代理不能应用。由此可以看出,jdk动态代理有一定的局限性,cglib这种第三方类库实现的动态代理应用更加广泛,且在效率上更有优势。。

1、定义接口和实现

  1. package com.meituan.hyt.test3.service;
  2.  public interface UserService {
  3.  public String getName(int id);
  4.  public Integer getAge(int id);
  5. }
  1.  package com.meituan.hyt.test3.service.impl;
  2.  import com.meituan.hyt.test3.service.UserService;
  3.  public class UserServiceImpl implements UserService {
  4.  @Override
  5.  public String getName(int id) {
  6.  System.out.println("------getName------");
  7.  return "Tom";
  8. }
  9.  @Override
  10.  public Integer getAge(int id) {
  11.  System.out.println("------getAge------");
  12.  return 10;
  13.  }
  14.  }

2、jdk动态代理实现

jdk动态代理是jdk原生就支持的一种代理方式,它的实现原理,就是通过让target类和代理类实现同一接口,代理类持有target对象,来达到方法拦截的作用,这样通过接口的方式有两个弊端,一个是必须保证target类有接口,第二个是如果想要对target类的方法进行代理拦截,那么就要保证这些方法都要在接口中声明,实现上略微有点限制。

  1.  package com.meituan.hyt.test3.jdk;
  2.  import java.lang.reflect.InvocationHandler;
  3.  import java.lang.reflect.Method;
  4.  public class MyInvocationHandler implements InvocationHandler {
  5.  private Object target;
  6.  MyInvocationHandler() {
  7.  super();
  8.  }
  9.  MyInvocationHandler(Object target) {
  10.  super();
  11.  this.target = target;
  12.  }
  13.  @Override
  14. public Object invoke(Object o, Method method, Object[] args) throws Throwable {
  15.  if("getName".equals(method.getName())){
  16.  System.out.println("++++++before " + method.getName() + "++++++");
  17.  Object result = method.invoke(target, args);
  18.  System.out.println("++++++after " + method.getName() + "++++++");
  19.  return result;
  20.  }else{
  21.  Object result = method.invoke(target, args);
  22.  return result;
  23.  }
  24.  }
  25.  }
  1.  package com.meituan.hyt.test3.jdk;
  2.  import com.meituan.hyt.test3.service.UserService;
  3.  import com.meituan.hyt.test3.service.impl.UserServiceImpl;
  4.  import java.lang.reflect.InvocationHandler;
  5.  import java.lang.reflect.Proxy;
  6.  public class Main1 {
  7.  public static void main(String[] args) {
  8.  UserService userService = new UserServiceImpl();
  9.  InvocationHandler invocationHandler = new MyInvocationHandler(userService);
  10.  UserService userServiceProxy = (UserService)Proxy.newProxyInstance(userService.getClass().getClassLoader(),
  11.  userService.getClass().getInterfaces(), invocationHandler);
  12.  System.out.println(userServiceProxy.getName(1));
  13.  System.out.println(userServiceProxy.getAge(1));
  14.  }
  15.  }

运行结果

++++++before getName++++++
------getName------
++++++after getName++++++
Tom
------getAge------
10

3、cglib动态代理实现

Cglib是一个优秀的动态代理框架,它的底层使用ASM在内存中动态的生成被代理类的子类,使用CGLIB即使代理类没有实现任何接口也可以实现动态代理功能。CGLIB具有简单易用,它的运行速度要远远快于JDK的Proxy动态代理:

cglib有两种可选方式,继承和引用。第一种是基于继承实现的动态代理,所以可以直接通过super调用target方法,但是这种方式在spring中是不支持的,因为这样的话,这个target对象就不能被spring所管理,所以cglib还是才用类似jdk的方式,通过持有target对象来达到拦截方法的效果。

CGLIB的核心类:
    net.sf.cglib.proxy.Enhancer – 主要的增强类
    net.sf.cglib.proxy.MethodInterceptor – 主要的方法拦截类,它是Callback接口的子接口,需要用户实现
    net.sf.cglib.proxy.MethodProxy – JDK的java.lang.reflect.Method类的代理类,可以方便的实现对源对象方法的调用,如使用:
    Object o = methodProxy.invokeSuper(proxy, args);//虽然第一个参数是被代理对象,也不会出现死循环的问题。

net.sf.cglib.proxy.MethodInterceptor接口是最通用的回调(callback)类型,它经常被基于代理的AOP用来实现拦截(intercept)方法的调用。这个接口只定义了一个方法
public Object intercept(Object object, java.lang.reflect.Method method,
Object[] args, MethodProxy proxy) throws Throwable;

第一个参数是代理对像,第二和第三个参数分别是拦截的方法和方法的参数。原来的方法可能通过使用java.lang.reflect.Method对象的一般反射调用,或者使用 net.sf.cglib.proxy.MethodProxy对象调用。net.sf.cglib.proxy.MethodProxy通常被首选使用,因为它更快。

  1.  package com.meituan.hyt.test3.cglib;
  2.  import net.sf.cglib.proxy.MethodInterceptor;
  3.  import net.sf.cglib.proxy.MethodProxy;
  4.  import java.lang.reflect.Method;
  5.  public class CglibProxy implements MethodInterceptor {
  6.  @Override
  7.  public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
  8.  System.out.println("++++++before " + methodProxy.getSuperName() + "++++++");
  9.  System.out.println(method.getName());
  10.  Object o1 = methodProxy.invokeSuper(o, args);
  11.  System.out.println("++++++before " + methodProxy.getSuperName() + "++++++");
  12.  return o1;
  13.  }
  14.  }
  1.  package com.meituan.hyt.test3.cglib;
  2.  import com.meituan.hyt.test3.service.UserService;
  3.  import com.meituan.hyt.test3.service.impl.UserServiceImpl;
  4.  import net.sf.cglib.proxy.Enhancer;
  5.  public class Main2 {
  6.  public static void main(String[] args) {
  7.  CglibProxy cglibProxy = new CglibProxy();
  8.  Enhancer enhancer = new Enhancer();
  9.  enhancer.setSuperclass(UserServiceImpl.class);
  10.  enhancer.setCallback(cglibProxy);
  11.  UserService o = (UserService)enhancer.create();
  12.  o.getName(1);
  13.  o.getAge(1);
  14.  }
  15.  }

运行结果:

++++++before CGLIB$getName$0++++++
getName
------getName------
++++++before CGLIB$getName$0++++++
++++++before CGLIB$getAge$1++++++
getAge
------getAge------

++++++before CGLIB$getAge$1++++++

4、需要注意的问题

需要注意的是,当一个方法没有被aop事务包裹,在该方法内部去调用另外一个有aop事务包裹的方法时,这个方法的aop事务不会生效。比如:
  1.  public void register() {
  2.  aopRegister();
  3.  }
  4.  @Transactional
  5.  public void aopRegister() {
  6.  }

因为通过上面的分析我们知道,在spring中,无论通过jdk的形式还是cglib的形式,代理类对target对象的方法进行拦截,其实都是通过让代理类持有target对象的引用,当外部引用aop包围的方法时,调用的其实是代理类对应的方法,代理类持有target对象,便可以控制target方法执行时的全方位拦截。

而如果在target的内部方法register调用一个aop包围的target方法aopRegister,调用的其实就是target自身的方法,因为这时候的this指针是不可能指向代理类的。所以事务是不能生效的。