JDK动态代理

一、引言

通过JDK实现动态代理，主要涉及到接口java.lang.reflect.InvocationHandler和类java.lang.reflect.Proxy

1) InvocationHandler接口，只有：public Object invoke(Object proxy, Method method, Object[] args)方法。

参数proxy: 代理对象；

参数method: 调用的方法；

参数args: 方法的参数，可能为多值，所以是数组；

在该方法中，用户可以调用真实对象的某个方法，并且可以在调用某个方法之前和之后做一些操作，如记录日志、检查安全性等。

2) Proxy类，生成真实类的代理对象，生成代理对象的方法：public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)。

参数loader: 类加载器，可以通过真实对象target.getClass().getClassLoader()取得；

参数interfaces: 真实类实现了哪些接口，可以通过真实对象target.getClass().getInterfaces()取得；

参数h: 操作句柄

 

二、示例代码

1) 接口UserManager

package com.wbf.user.mgr;

public interface UserManager {
	void addUser(String name, int age);
	void deleteUser(String name, int age);
	void modifyUser(String name, int age);
	void queryUser(String name, int age);
}

 

2) 接口实现类UserManagerImpl

package com.wbf.user.mgr;

public class UserManagerImpl implements UserManager {

	@Override
	public void addUser(String name, int age) {
		System.out.println("addUser(" + name + ", " + age + ")");
	}

	@Override
	public void deleteUser(String name, int age) {
		System.out.println("deleteUser(" + name + ", " + age + ")");
	}

	@Override
	public void modifyUser(String name, int age) {
		System.out.println("modifyUser(" + name + ", " + age + ")");
	}

	@Override
	public void queryUser(String name, int age) {
		System.out.println("queryUser(" + name + ", " + age + ")");
	}

}

 

3) 操作句柄UserManagerHandler

package com.wbf.user.mgr;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class UserManagerHandler implements InvocationHandler {

	private Object target;
	
	public UserManagerHandler() {}
	
	//实例化的过程中初始化真实对象target
	public UserManagerHandler(Object t) {
		this.target = t;
	}
	
	@Override
	public Object invoke(Object proxy, Method method, Object[] args)
			throws Throwable {
		//在调用真实对象的方法之前
		System.out.println("--------before " + method.getName() + "()----------");
		//调用真实对象的方法
		Object ret = method.invoke(target, args);
		//在调用真实对象的方法之后
		System.out.println("--------after " + method.getName() + "()----------");
		
		System.out.println();
		
		return ret;
	}

}

 

4) 测试类UserManagerTest

 

package com.wbf.user.test;

import java.lang.reflect.Proxy;

import com.wbf.user.mgr.UserManager;
import com.wbf.user.mgr.UserManagerHandler;
import com.wbf.user.mgr.UserManagerImpl;

public class UserManagerTest {

	public static void main(String[] args) {
		//真实对象
		UserManager userManager = new UserManagerImpl();
		//InvocationHandler，将真实对象注入其中
		UserManagerHandler handler = new UserManagerHandler(userManager);
		
		//Proxy，将Invocationhandler对象注入其中，这样在代理对象执行某个方法时通过Handler才知道调用真实对象的方法
		UserManager userManagerProxy = (UserManager)Proxy.newProxyInstance(userManager.getClass().getClassLoader(), userManager.getClass().getInterfaces(), handler);
		//调用代理对象方法
		userManagerProxy.addUser("张三", 21);
		//userManagerProxy.deleteUser("张三", 21);
		//userManagerProxy.modifyUser("张三", 21);
		//userManagerProxy.queryUser("张三", 21);
	}

}

 运行结果：

--------before addUser()----------
addUser(张三, 21)
--------after addUser()----------

 

三、对于InvocationHandler和测试代码的更优实现

1) 操作句柄UserManagerHandler2

package com.wbf.user.mgr;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

public class UserManagerHandler2 implements InvocationHandler {

	private Object target;
	
	public UserManagerHandler2() {}
	
	//获取真是对象的代理，在获取之前先初始化UserManagerHandler2的成员变量target
	public Object getProxyInstance(Object t) {
		this.target = t;
		return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), this);
	}
	
	@Override
	public Object invoke(Object proxy, Method method, Object[] args)
			throws Throwable {
		//在调用真实对象的方法之前
		System.out.println("--------before " + method.getName() + "()----------");
		//调用真实对象的方法
		Object ret = method.invoke(target, args);
		//在调用真实对象的方法之后
		System.out.println("--------after " + method.getName() + "()----------");
		
		System.out.println();
		
		return ret;
	}

}

 

2) 测试代码UserManagerTest2

 

package com.wbf.user.test;

import com.wbf.user.mgr.UserManager;
import com.wbf.user.mgr.UserManagerHandler2;
import com.wbf.user.mgr.UserManagerImpl;

public class UserManagerTest2 {

	public static void main(String[] args) {
		UserManagerHandler2 handler = new UserManagerHandler2();
		//通过调用handler的方法来获取代理对象
		UserManager userManagerProxy = (UserManager)handler.getProxyInstance(new UserManagerImpl());
		userManagerProxy.addUser("张三", 21);
	}
}

 运行结果：

--------before addUser()----------
addUser(张三, 21)
--------after addUser()----------

 

四、补充说明

1) userManagerProxy.addUser("张三", 21);

执行流程：userManagerProxy: addUser() ----> UserManagerHandler: invoke() ----->调用之前记录日志 ----> UserManagerImpl: addUser() ----> 调用之后记录日志

2) 动态代理完成的功能和静态代理完成的功能没有什么不同，所以在一般的开发中很少用到动态代理机制，但是在开发一些底层代码和框架（如spring framework）时，动态代理就用的比较多。