网上关于Java的动态代理,Proxy和InvocationHandler这些概念有讲解得非常高深的文章.现在咱们通过一个最简单的例子认识什么是InvocationHandler。值得一提的是,InvocationHandler在Spring框架实现中被广泛使用,这意味着我们吃透了InvocationHandler,就为将来的Spring源码学习打下一个坚实的基础。
开发一个接口,包含两个方法,可以向指定的人问候“你好”或者“再见”。
1 2 3 4 5 6 7 public interface IHello { void sayHello (String name) ; void sayGoogBye (String name) ; }
创建一个简单的类,实现这个IHello接口。
1 2 3 4 5 6 7 8 9 10 public class Helloimplements implements IHello { @Override public void sayHello (String name) { System.out.println("Hello " + name); } @Override public void sayGoogBye (String name) { System.out.println(name+" GoodBye!" ); } }
消费这个实现类,迄今为止没什么特别的。
现在假设我们接到了这个需求:老板要求在该实现类每次问候某人时,必须把问候的细节记录到日志文件里。为了简单起见,我们在问候前打印下面的一行语句来模拟日志记录的动作。
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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 您也许会说,这还不简单?直接修改Helloimplements的对应方法,把这行日志插入到对应方法即可。  然而,老板的要求是:不允许你修改原来的Helloimplements类。在现实场景中,Helloimplements可能是第三方的jar包提供的,我们没有办法修改代码。  您也许会说,我们可以用设计模式里的代理模式,即创建一个新的Java类作为代理类,同样实现IHello接口,然后将Helloimplements类的实例传入代理类。我们虽然被要求不允许修改Helloimplements的代码,但是可以把日志记录代码写在代理类里。完整代码如下: ```java public class StaticProxy implements IHello { private IHello iHello; public void setImpl(IHello impl){ this.iHello = impl; } @Override public void sayHello(String name) { System.out.println("问候之前的日志记录..."); iHello.sayHello(name); } @Override public void sayGoogBye(String name) { System.out.println("问候之前的日志记录..."); iHello.sayGoogBye(name); } static public void main(String[] arg) { Helloimplements hello = new Helloimplements(); StaticProxy proxy = new StaticProxy(); proxy.setImpl(hello); proxy.sayHello("Jerry"); } }
这种做法能够实现需求:
下面我们再看如何用InvocationHandler实现同样的效果。
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 InvocationHandler是一个JDK提供的标准接口。看下面的代码: import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;import java.lang.reflect.Proxy;public class DynaProxyHello implements InvocationHandler { private Object delegate; public Object bind (Object delegate) { this .delegate = delegate; return Proxy.newProxyInstance( this .delegate.getClass().getClassLoader(), this .delegate .getClass().getInterfaces(), this ); } public Object invoke (Object proxy, Method method, Object[] args) throws Throwable { Object result = null ; try { System.out.println("问候之前的日志记录..." ); result = method.invoke(this .delegate, args); } catch (Exception e) { e.printStackTrace(); } return result; }
上面代码里的bind方法很想我之前代理类StaticProxy的setImpl方法,只不过这个bind方法的输入参数类型更加通用。日志记录的代码写在方法invoke里。
看看如何使用:
1 2 3 4 5 6 static public void main (String[] arg) { DynaProxyHello helloproxy = new DynaProxyHello(); Helloimplements hello = new Helloimplements(); IHello ihello = (IHello) helloproxy.bind(hello); ihello.sayHello("Jerry" ); }
执行效果和StaticProxy那种解决方案完全一致。
咱们先来调试一下。当bind方法执行时,方法Proxy.newProxyInstance被调用,Helloimplements类的实例被传入。
我们在调试器里观察IHello ihello = (IHello) helloproxy.bind(hello)这行语句返回的ihello变量。虽然它的静态类型是IHello,但请注意,在调试器里观察它的实际类型,并不是Helloimplements的实例,而是JVM给我们加过工的,包含了我们在invoke方法里手写的那行日志记录代码。这个ihello类型为$Proxy0。
当这个被JVM加过工的变量的sayHello方法被调用时,JVM自动将调用转交到DynaProxyHello.invoke去:
于是,在invoke方法里,我们手写的日志记录代码被执行,然后通过Java反射执行原始的sayHello代码。
有的朋友可能会问,你这个InvocationHandler看起来比静态代理StaticProxy还复杂啊?有什么好处?
假设老板的需求又变了,在调用问候和说再见的方法里,要使用不同的日志记录策略。
看看用InvocationHandler如何优雅实现吧:
希望这个例子能让大家对Java的动态代理之InvocationHandler有了最基本的了解。
也可以将其用在服务转发,如前置服务收到请求后,将请求预处理后,分发至具体的server来处理:
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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 public final class ProxyManager <T > { private final static Logger LOGGER = LoggerFactory.getLogger(ProxyManager.class ) ; private Class<T> clazz; private String url; private OkHttpClient okHttpClient; public ProxyManager (Class<T> clazz, String url, OkHttpClient okHttpClient) { this .clazz = clazz; this .url = url; this .okHttpClient = okHttpClient; } public T getInstance () { return (T) Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), new Class[]{clazz}, new ProxyInvocation()); } private class ProxyInvocation implements InvocationHandler { @Override public Object invoke (Object proxy, Method method, Object[] args) throws Throwable { JSONObject jsonObject = new JSONObject(); String serverUrl = url + "/" + method.getName() ; if (args != null && args.length > 1 ) { throw new CIMException(VALIDATION_FAIL); } if (method.getParameterTypes().length > 0 ){ Object para = args[0 ]; Class<?> parameterType = method.getParameterTypes()[0 ]; for (Field field : parameterType.getDeclaredFields()) { field.setAccessible(true ); jsonObject.put(field.getName(), field.get(para)); } } return HttpClient.call(okHttpClient, jsonObject.toString(), serverUrl); } } }
用法很多,这里就不一一列举了