专栏首页Java架构-筑基讲一些你所不知道的Java动态代理
原创

讲一些你所不知道的Java动态代理

简介


Proxy 是设计模式中的一种。当需要在已存在的 class 上添加或修改功能时,可以通过创建 proxy object 来实现

通常 proxy object 和被代理对象拥有相同的方法,并且拥有被代理对象的引用,可以调用其方法

代理模式应用场景包括

  • 在方法执行前后打印和记录日志
  • 认证、参数检查
  • lazy instantiation (Hibernate, Mybatis)
  • AOP (transaction)
  • mocking

代理有两种实现方式

  • 静态代理:在编译时期,创建代理对象
  • 动态代理:在运行时期,动态创建

对于重复性工作,如打印日志,静态代理需要为每个 class 都创建 proxy class,过程繁琐和低效,而动态代理通过使用反射在运行时生成 bytecode 的方式来实现,更加方便和强大

过程


因为 JDK 自带的 Dynamic proxy 只能够代理 interfaces,因此被代理对象需要实现一个或多个接口。

先来看一些概念:

  • proxy interface proxy class 实现的接口
  • proxy class 运行时创建的代理 class,并实现一个或多个 proxy interface
  • proxy instance proxy class 的实例
  • InvocationHandler 每个 proxy instance 都有一个关联的 invocation handler,当调用 proxy 对象的方法时,会统一封装,并转发到invoke()方法

InvocationHandler 接口的定义如下

package java.lang.reflect;
public interface InvocationHandler {
    public Object invoke(Object proxy, Method method, Object[] args)
            throws Throwable;
}

只定义了一个方法invoke(),参数含义如下

  • Object proxy生成的代理对象
  • Method method调用的方法,类型为 java.lang.reflect.Method
  • Object[] args调用方法的参数,array of objects

简单来说就是,调用 proxy object 上的方法,最终都会转换成对关联InvocationHandlerinvoke()方法的调用

可以使用java.lang.reflect.Proxy的静态方法newProxyInstance来创建Proxy object

public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
    {
    ...
}

参数说明

  • loader 定义 proxy class 的 ClassLoader
  • interfaces 需要代理的接口
  • h 关联的 InvocationHandler

例子


使用动态代理打印方法的执行耗时

定义代理接口

public interface Foo {
    String doSomething();
}

实现接口

public class FooImpl implements Foo {
    @Override
    public String doSomething() {
        return "finished";
    }
}

定义 InvocationHandler,target 为被代理对象的引用,在方法执行完后打印耗时

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class TimingInvocationHandler implements InvocationHandler {
    private Object target;
    public TimingInvocationHandler(Object target) {
        this.target = target;
    }
    public Object invoke(Object proxy, Method method, Object[] args)
                throws Throwable {
        long start = System.nanoTime();
        Object result = method.invoke(target, args);
        long elapsed = System.nanoTime() - start;
        System.out.println(String.format("Executing %s finished in %d ns",
                        method.getName(),
                        elapsed));
        return result;
    }
}

测试

import org.junit.Test;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;
public class DynamicProxyTest {
    @Test
        public void test() {
        ClassLoader cl = DynamicProxyTest.class.getClassLoader();
        Class[] interfaces = new Class[]{Foo.class};
        FooImpl fooImpl = new FooImpl();
        InvocationHandler timingInvocationHandler = new TimingInvocationHandler(fooImpl);
        Foo foo = (Foo) Proxy.newProxyInstance(cl, interfaces, timingInvocationHandler);
        foo.doSomething();
    }
}

执行完会打印类似

Executing doSomething finished in 23148 ns

细节


生成 proxy class 的一些属性和细节

  • public, final, and not abstract.
  • 类名不确定,以 $Proxy 开头
  • 继承 java.lang.reflect.Proxy,且 Proxy 实现了 java.io.Serializable 接口,因此 proxy instance 是可以序列化的
  • 按照 Proxy.newProxyInstance() 传入 interfaces 参数中的接口顺序来实现接口
  • 在 proxy class 上调用 getInterfaces,getMethods,getMethod 方法,会返回实现的接口中定义的方法,顺序和创建时的参数保持一致
  • 当调用 proxy instance 同名、同 parameter signature 方法时,invoke() 方法的 Method 参数会是最早定义这个方法的 interface 的方法,无论实际调用的方法是什么
  • 当 Foo 为实现的代理接口之一时, proxy instanceof Foo 返 true,并且可以转换 (Foo) proxy
  • Proxy.getInvocationHandler 静态方法会返回 proxy object 关联的 invocation handler

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 反射真的慢么?动态代理会创建很多临时class?

    当我们在IDE中编写代码的时候,打一个点号,IDE会自动弹出对应的属性和方法名,当我们在debug的时候,IDE会将方法运行时方法内局部变量和外部实例上属性的值...

    苏先生
  • 如何做好一个系统架构师:抓住敏捷架构中几个关键决策点

    开发人员在任何软件项目过程中都会做出数百个微观和宏观决策。有些似乎相对无害,但对下游会有一个很大的影响。几位Cantina工程师聚在一起,回顾了我们在学习了一些...

    苏先生
  • 面试必备——关于Java ClassLoader你真的了解吗

    类加载机制作为一个高频的面试题经常会在面试中被问到,前几天一个电话面试就问到,之前有了解过,但是没有梳理成自己的体系,所以说的有点凌乱,今天花点时间整理一下,分...

    苏先生
  • 【Nginx]配置文件详解

    landv
  • Java基础之SPI机制

    在前几天的译文 Java中的类加载器 中有部分关于ContextClassLoader的内容,涉及到SPI机制,本文将学习下相关知识。

    码代码的陈同学
  • Java基础笔记10

    dreamkong
  • Spring的三种Circuit Breaker

    今天我们分享的内容是在spring下的三种circuit breaker的做法。接下来我们分别演示spring cloud netflix hystrix、sp...

    ImportSource
  • 阶段01Java基础day10面向对象05

    声明:本文为原创,作者为 对弈,转载时请保留本声明及附带文章链接:http://www.duiyi.xyz/c%e5%ae%9e%e7%8e%b0%e9%9b%...

    对弈
  • SpringBoot系列教程web篇之全局异常处理

    当我们的后端应用出现异常时,通常会将异常状况包装之后再返回给调用方或者前端,在实际的项目中,不可能对每一个地方都做好异常处理,再优雅的代码也可能抛出异常,那么在...

    一灰灰blog
  • 源码分析 | 手写mybait-spring核心功能(干货好文一次学会工厂bean、类代理、bean注册的使用)

    一个知识点的学习过程基本分为;运行helloworld、熟练使用api、源码分析、核心专家。在分析mybaits以及mybatis-spring源码之前,我也只...

    小傅哥

扫码关注云+社区

领取腾讯云代金券