1.代理模式
代理(Proxy)是一种设计模式,提供了对目标对象另外的访问方式;即通过代理对象访问目标对象.这样做的好处是:可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能. 这里使用到编程中的一个思想:不要随意去修改别人已经写好的代码或者方法,如果需改修改,可以通过代理的方式来扩展该方法
举个例子来说明代理的作用:假设我们想邀请一位明星,那么并不是直接连接明星,而是联系明星的经纪人,来达到同样的目的.明星就是一个目标对象,他只要负责活动中的节目,而其他琐碎的事情就交给他的代理人(经纪人)来解决.这就是代理思想在现实中的一个例子
用图表示如下:
代理模式的关键点是:代理对象与目标对象.代理对象是对目标对象的扩展,并会调用目标对象
1.1.静态代理
静态代理在使用时,需要定义接口或者父类,被代理对象与代理对象一起实现相同的接口或者是继承相同父类 .
下面举个案例来解释: 模拟保存动作,定义一个保存动作的接口:IUserDao.java,然后目标对象实现这个接口的方法UserDao.java,此时如果使用静态代理方式,就需要在代理对象(UserDaoProxy.java)中也实现IUserDao接口.调用的时候通过调用代理对象的方法来调用目标对象. 需要注意的是,代理对象与目标对象要实现相同的接口,然后通过调用相同的方法来调用目标对象的方法
代码示例: 接口:IUserDao.java
public interface IUserDao {
void save () ;
}
目标对象:UserDao.java
public class UserDao implements IUserDao {
public void save () {
System.out .println ("----已经保存数据!----" );
}
}
代理对象:UserDaoProxy.java
public class UserDaoProxy implements IUserDao {
private IUserDao target;
public UserDaoProxy (IUserDao target) {
this .target =target;
}
public void save () {
System.out .println ("开始事务..." );
target.save ();
System.out .println ("提交事务..." );
}
}
测试类:App.java
public class App {
public static void main (String[] args) {
UserDao target = new UserDao ();
UserDaoProxy proxy = new UserDaoProxy (target);
proxy.save ();
}
}
静态代理总结: 1.可以做到在不修改目标对象的功能前提下,对目标功能扩展 . 2.缺点:
因为代理对象需要与目标对象实现一样的接口,所以会有很多代理类 ,类太多.同时,一旦接口增加方法,目标对象与代理对象都要维护.
如何解决静态代理中的缺点呢?答案是可以使用动态代理方式
1.2.动态代理
动态代理有以下特点: 1.代理对象,不需要实现接口 2.代理对象的生成,是利用JDK的API ,动态的在内存中构建代理对象(需要我们指定创建代理对象/目标对象实现的接口的类型) 3.动态代理也叫做:JDK代理,接口代理
JDK中生成代理对象的API 代理类所在包:java.lang.reflect.Proxy JDK实现代理只需要使用newProxyInstance方法,但是该方法需要接收三个参数,完整的写法是:
static Object newProxyInstance (ClassLoader loader, Class>[] interfaces,InvocationHandler h )
注意该方法是在Proxy类中是静态方法,且接收的三个参数依次为:
ClassLoader loader,
:指定当前目标对象使用类加载器 ,获取加载器的方法是固定的
Class>[] interfaces,
:目标对象实现的接口的类型 ,使用泛型方式确认类型
InvocationHandler h
:事件处理,执行目标对象的方法时,会触发事件处理器的方法,会把当前执行目标对象的方法 作为参数传入
代码示例: 接口类IUserDao.java以及接口实现类,目标对象UserDao是一样的,没有做修改.在这个基础上,增加一个代理工厂类(ProxyFactory.java),将代理类写在这个地方,然后在测试类(需要使用到代理的代码)中先建立目标对象和代理对象的联系,然后代用代理对象的中同名方法
代理工厂类:ProxyFactory.java
public class ProxyFactory {
private Object target;
public ProxyFactory (Object target) {
this .target =target;
}
public Object getProxyInstance () {
return Proxy.newProxyInstance (
target.getClass ().getClassLoader (),
target.getClass ().getInterfaces (),
new InvocationHandler() {
@Override
public Object invoke (Object proxy, Method method, Object[] args) throws Throwable {
System.out .println ("开始事务2" );
Object returnValue = method.invoke (target, args);
System.out .println ("提交事务2" );
return returnValue;
}
}
);
}
}
测试类:App.java
public class App {
public static void main (String[] args) {
IUserDao target = new UserDao ();
System.out .println (target.getClass ());
IUserDao proxy = (IUserDao) new ProxyFactory (target).getProxyInstance ();
System.out .println (proxy.getClass ());
proxy.save ();
}
}
总结: 代理对象不需要实现接口,但是目标对象一定要实现接口,否则不能用动态代理
1.3.Cglib代理
上面的静态代理和动态代理模式都是要求目标对象是实现一个接口的目标对象,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候就可以使用以目标对象子类的方式类实现代理,这种方法就叫做:Cglib代理
Cglib代理,也叫作子类代理,它是在内存中构建一个子类对象从而实现对目标对象功能的扩展.
JDK的动态代理有一个限制,就是使用动态代理的对象必须实现一个或多个接口 ,如果想代理没有实现接口的类,就可以使用Cglib实现 .
Cglib是一个强大的高性能的代码生成包,它可以在运行期扩展java类与实现java接口.它广泛的被许多AOP的框架使用,例如Spring AOP和synaop,为他们提供方法的interception(拦截)
Cglib包的底层是通过使用一个小而块的字节码处理框架ASM来转换字节码并生成新的类.不鼓励直接使用ASM,因为它要求你必须对JVM内部结构包括class文件的格式和指令集都很熟悉.
Cglib子类代理实现方法: 1.需要引入cglib的jar文件,但是Spring的核心包中已经包括了Cglib功能,所以直接引入spring-core-3.2.5.jar
即可. 2.引入功能包后,就可以在内存中动态构建子类 3.代理的类不能为fina l,否则报错 4.目标对象的方法如果为final/static,那么就不会被拦截,即不会执行目标对象额外的业务方法.
代码示例: 目标对象类:UserDao.java
public class UserDao {
public void save () {
System.out .println ("----已经保存数据!----" );
}
}
Cglib代理工厂:ProxyFactory.java
public class ProxyFactory implements MethodInterceptor {
private Object target;
public ProxyFactory (Object target) {
this .target = target;
}
public Object getProxyInstance () {
Enhancer en = new Enhancer ();
en.setSuperclass (target.getClass ());
en.setCallback (this );
return en.create ();
}
@Override
public Object intercept (Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
System.out .println ("开始事务..." );
Object returnValue = method.invoke (target, args);
System.out .println ("提交事务..." );
return returnValue;
}
}
测试类:
public class App {
@Test
public void test () {
UserDao target = new UserDao ();
UserDao proxy = (UserDao)new ProxyFactory (target).getProxyInstance ();
proxy.save ();
}
}
在Spring的AOP编程中: 如果加入容器的目标对象有实现接口,用JDK代理 如果目标对象没有实现接口,用Cglib代理
另一位博主的介绍:
Java编程的目标是实现现实不能完成的,优化现实能够完成的,是一种虚拟技术。生活中的方方面面都可以虚拟到代码中。代理模式所讲的就是现实生活中的这么一个概念:中介 。
代理模式的定义 :给某一个对象提供一个代理,并由代理对象控制对原对象的引用。
代理模式包含如下角色:
ISubject :抽象主题角色,是一个接口。该接口是对象和它的代理共用的接口。
RealSubject :真实主题角色,是实现抽象主题接口的类。
Proxy :代理角色,内部含有对真实对象RealSubject的引用,从而可以操作真实对象。代理对象提供与真实对象相同的接口,以便在任何时刻都能代替真实对象。同时,代理对象可以在执行真实对象操作时,附加其他的操作,相当于对真实对象进行封装。
实现动态代理的关键技术是反射。
静态代理
代理模式有几种,虚拟代理,计数代理,远程代理,动态代理。主要分为两类,静态代理和动态代理。静态代理比较简单,是由程序员编写的代理类,并在程序运行前就编译好的,而不是由程序动态产生代理类,这就是所谓的静态。
考虑这样的场景,管理员在网站上执行操作,在生成操作结果的同时需要记录操作日志,这是很常见的。此时就可以使用代理模式,代理模式可以通过聚合和继承两种方式实现:
[java] view plain
copy
print ?
public interface Manager {
void doSomething();
}
public class Admin implements Manager {
public void doSomething() {
System.out.println("Admin do something." );
}
}
public class AdminPoly implements Manager{
private Admin admin;
public AdminPoly(Admin admin) {
super ();
this .admin = admin;
}
public void doSomething() {
System.out.println("Log:admin操作开始" );
admin.doSomething();
System.out.println("Log:admin操作结束" );
}
}
Admin admin = new Admin();
Manager m = new AdminPoly(admin);
m.doSomething();
public class AdminProxy extends Admin {
@Override
public void doSomething() {
System.out.println("Log:admin操作开始" );
super .doSomething();
System.out.println("Log:admin操作开始" );
}
}
AdminProxy proxy = new AdminProxy();
proxy.doSomething();
聚合实现方式中代理类聚合了被代理类,且代理类及被代理类都实现了同一个接口,可实现灵活多变。继承式的实现方式则不够灵活。
比如,在管理员操作的同时需要进行权限的处理,操作内容的日志记录,操作后数据的变化三个功能。三个功能的排列组合有6种,也就是说使用继承要编写6个继承了Admin的代理类,而使用聚合,仅需要针对权限的处理、日志记录和数据变化三个功能编写代理类,在业务逻辑中根据具体需求改变代码顺序即可。
动态代理
一般来说,对代理模式而言,一个主题类与一个代理类一一对应,这也是静态代理模式的特点。
但是,也存在这样的情况,有n各主题类,但是代理类中的“前处理、后处理”都是一样的,仅调用主题不同。也就是说,多个主题类对应一个代理类,共享“前处理,后处理”功能,动态调用所需主题,大大减小了程序规模,这就是动态代理模式的特点。
JDK动态代理
实现
[java] view plain
copy
print ?
public interface Moveable {
void move() throws Exception;
}
public class Car implements Moveable {
public void move() throws Exception {
Thread.sleep(new Random().nextInt( 1000 ));
System.out.println("汽车行驶中…" );
}
}
public class TimeHandler implements InvocationHandler {
private Object target;
public TimeHandler(Object target) {
super ();
this .target = target;
}
public Object invoke(Object proxy, Method method, Object[] args)
throws Throwable {
long startTime = System.currentTimeMillis();
System.out.println("汽车开始行驶…" );
method.invoke(target, args);
long stopTime = System.currentTimeMillis();
System.out.println("汽车结束行驶…汽车行驶时间:" + (stopTime - startTime) + "毫秒!" );
return null ;
}
}
public class Test {
public static void main(String[] args) throws Exception{
Car car = new Car();
InvocationHandler h = new TimeHandler(car);
Class> cls = car.getClass();
Moveable m = (Moveable) Proxy.newProxyInstance(cls.getClassLoader(),cls.getInterfaces(), h);
m.move();
}
}
代码讲解:
在测试代码中,Proxy.newProxyInstance()方法需要3个参数:类加载器(要进行代理的类)、被代理类实现的接口,事务处理器。所以先实例化Car,实例化InvocationHandler的子类TimeHandler,将各参数传入Proxy的静态方法newProxyInstance()即可获得Car的代理类,前面的静态代理,代理类是我们编写好的,而动态代理则不需要我们去编写代理类,是在程序中动态生成的。
JDK动态代理步骤
1. 创建一个实现InvocationHandler接口的类,它必须实现invoke()方法
2. 创建被代理的类及接口
3. 调用Proxy的静态方法,创建一个代理类
4. 通过代理调用方法
而为什么要进行如此操作,可以从Proxy和InvocationHandler的源码中找打答案。对源码不感兴趣的可以将下面的源码部分小节略过。
JDK 动态代理原理与源码
newProxyInstance()方法的源码:
[java] view plain
copy
print ?
public static Object newProxyInstance(ClassLoader loader,
Class>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException{
if (h == null ) {
throw new NullPointerException();
}
final Class>[] intfs = interfaces.clone();
final SecurityManager sm = System.getSecurityManager();
if (sm != null ) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
Class> cl = getProxyClass0(loader, intfs);
try {
final Constructor> cons =cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
if (sm != null && ProxyAccessHelper.needsNewInstanceCheck(cl)) {
return AccessController.doPrivileged(newPrivilegedAction() {
public Object run() {
return newInstance(cons,ih);
}
});
} else {
return newInstance(cons,ih);
}
} catch (NoSuchMethodException e) {
throw new InternalError(e.toString());
}
}
可以看到,获得代理类的代码是
Class>cl = getProxyClass0(loader,intfs);
并由此获得代理类的构造函数,生成代理类的实例返回给该方法的调用者。
继续跟进getProxyClass0()方法:
[java] view plain
copy
print ?
private static Class> getProxyClass0(ClassLoader loader,
Class>... interfaces) {
if (interfaces.length > 65535 ) {
throw new IllegalArgumentException( "interface limit exceeded" );
}
return proxyClassCache.get(loader, interfaces);
}
还是没有看到代理类是怎么生成的,只知道代理类是从
proxyClassCache 中取得的,这个变量是与缓存相关的一个对象,查看该变量的声明与初始化:
[java] view plain
copy
print ?
private static final WeakCache[], Class>>
proxyClassCache = new WeakCache<>( new KeyFactory(), new ProxyClassFactory());
可以发现
proxyClassCache 是个用来缓存代理类的类变量,大家知道类变量的特点是与类一一对应,在一个虚拟机中类只有一个,对应着在一个虚拟机中类变量也只有一个,且在此处,在Proxy类被加载的时候就赋值了。在赋值操作的参数中有ProxyClassFactory()这么一个构造函数,这个是动态代理中的关键:生成代理类的类文件字节码。继续跟进去,找到代理类的生成之处了:
[java] view plain
copy
print ?
private static final class ProxyClassFactory
implements BiFunction[], Class>>
{
private static final String proxyClassNamePrefix = "$Proxy" ;
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class> apply(ClassLoader loader,Class>[] interfaces) {
Map, Boolean>interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class> intf : interfaces) {
Class> interfaceClass =null ;
try {
interfaceClass = Class.forName(intf.getName(),false , loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from classloader" );
}
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface" );
}
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null ) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null ;
for (Class> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
String name =intf.getName();
int n = name.lastIndexOf( '.' );
String pkg = ((n == -1 ) ? "" : name.substring( 0 , n + 1 ));
if (proxyPkg == null ) {
proxyPkg = pkg;
} else if (!pkg.equals(proxyPkg)) {
throw new IllegalArgumentException(
"non-public interfaces fromdifferent packages" );
}
}
}
if (proxyPkg == null ) {
proxyPkg = ReflectUtil.PROXY_PACKAGE + "." ;
}
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
byte [] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName,interfaces);
try {
return defineClass0(loader, proxyName,proxyClassFile, 0 , proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
在
ProxyClassFactory 中,可以看到产生代理类的具体逻辑,大致上是,根据传递的被代理类及其实现的接口生成代理类的字节码加载到缓存中,但是加载到缓存中只是一个.java文件也不能用,所以底层还有编译等操作。到这里,可以大致的看清JDK中动态代理的面孔了,实现的步骤为:
1. 创建代理类的源码;
2. 对源码进行编译成字节码;
3. 将字节码加载到内存;
4. 实例化代理类对象并返回给调用者;
底层的代码我们看不到,但是我们可以查看其生成的字节码:
[java] view plain
copy
print ?
byte [] classFile = ProxyGenerator.generateProxyClass( "$Proxy1" , Car. class .getInterfaces());
FileOutputStream out = null ;
try {
out = new FileOutputStream(System.getProperty( "user.dir" ) + "\\$Proxy1.class" );
out.write(classFile);
out.flush();
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
out.close();
} catch (IOException e) {
e.printStackTrace();
}
}
importcn.com.goser.proxy.imooc.staticproxy.Moveable;
importjava.lang.reflect.InvocationHandler;
importjava.lang.reflect.Method;
importjava.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class $Proxy1 extends Proxy
implements Moveable
{
private static Method m1;
private static Method m3;
private static Method m0;
private static Method m2;
public $Proxy1(InvocationHandler paramInvocationHandler)
throws
{
super (paramInvocationHandler);
}
public final boolean equals(Object paramObject)
throws
{
try
{
return ((Boolean) this .h.invoke( this , m1, new Object[] { paramObject })).booleanValue();
}
catch (RuntimeException localRuntimeException)
{
throw localRuntimeException;
}
catch (Throwable localThrowable)
{
}
throw new UndeclaredThrowableException(localThrowable);
}
public final void move()
throws Exception
{
try
{
this .h.invoke( this , m3, null );
return ;
}
catch (Exception localException)
{
throw localException;
}
catch (Throwable localThrowable)
{
}
throw new UndeclaredThrowableException(localThrowable);
}
public final int hashCode()
throws
{
try
{
return ((Integer) this .h.invoke( this , m0, null )).intValue();
}
catch (RuntimeException localRuntimeException)
{
throw localRuntimeException;
}
catch (Throwable localThrowable)
{
}
throw new UndeclaredThrowableException(localThrowable);
}
public final String toString()
throws
{
try
{
return (String) this .h.invoke( this , m2, null );
}
catch (RuntimeException localRuntimeException)
{
throw localRuntimeException;
}
catch (Throwable localThrowable)
{
}
throw new UndeclaredThrowableException(localThrowable);
}
static
{
try
{
m1 = Class.forName("java.lang.Object" ).getMethod( "equals" , new Class[] { Class.forName( "java.lang.Object" ) });
m3 = Class.forName("cn.com.goser.proxy.imooc.staticproxy.Moveable" ).getMethod( "move" , new Class[ 0 ]);
m0 = Class.forName("java.lang.Object" ).getMethod( "hashCode" , new Class[ 0 ]);
m2 = Class.forName("java.lang.Object" ).getMethod( "toString" , new Class[ 0 ]);
return ;
}
catch (NoSuchMethodExceptionlocalNoSuchMethodException)
{
throw new NoSuchMethodError(localNoSuchMethodException.getMessage());
}
catch (ClassNotFoundExceptionlocalClassNotFoundException)
{
}
throw new NoClassDefFoundError(localClassNotFoundException.getMessage());
}
}
生成的字节码比较长,但是在字节码中最关键的信息是代理类的声明:
public final class $Proxy1 extends Proxy
可以看到生成的代理类是继承了Proxy类的,这就是说明了为什么使用JDK动态代理不能实现继承式动态代理,原因是Java不允许多继承,而生成的代理类本身就已经继承了Proxy类。
至此,JDK的动态代理的使用及底层原理分析完毕,揭下动态代理的神秘面纱,果然是枚美女。
至于最底层的native方法是怎么动态生成代理类的字节码我们也可以简单的模拟一下,先分析下模拟的步骤:首先要生成一段代理类的源码,然后将源码编译后生成代理类的实例返回给调用者。依据此步骤开始编写我们的模拟代码:
[java] view plain
copy
print ?
public class Proxy {
private static final String RT = "\r\n" ;
public static Object newProxyInstance() throws Exception{
String sourceCode =
"packagecn.com.goser.proxy.jdk.simulate;" + RT +
"importcn.com.goser.proxy.imooc.staticproxy.Admin;" + RT +
"importcn.com.goser.proxy.imooc.staticproxy.Manager;" + RT +
"//以聚合方式实现的代理主题" + RT +
"public class $Proxy0 implementsManager{" + RT +
" privateAdmin admin;" + RT +
" public$Proxy0(Admin admin) {" + RT +
" super();" + RT +
" this.admin= admin;" + RT +
" }" + RT +
" publicvoid doSomething() {" + RT +
" System.out.println(\"Log:admin操作开始\");" + RT +
" admin.doSomething();" + RT +
" System.out.println(\"Log:admin操作结束\");" + RT +
" }" + RT +
"}" ;
String filename = System.getProperty("user.dir" ) + "/src/main/java/cn/com/goser/proxy/jdk/simulate/$Proxy0.java" ;
File file = new File(filename);
FileUtils.writeStringToFile(file,sourceCode);
JavaCompiler complier = ToolProvider.getSystemJavaCompiler();
StandardJavaFileManager fileMgr =complier.getStandardFileManager(null , null , null );
Iterable its =fileMgr.getJavaFileObjects(filename);
CompilationTask task = complier.getTask(null , fileMgr, null , null , null , its);
task.call();
fileMgr.close();
ClassLoader loader = ClassLoader.getSystemClassLoader();
Class cls = loader.loadClass("cn.com.goser.proxy.jdk.simulate.$Proxy0" );
Constructor ct = cls.getConstructor(Admin.class );
return ct.newInstance( new Admin());
}
}
class test{
public static void main(String[] args) throws Exception {
Manager m = (Manager)Proxy.newProxyInstance();
m.doSomething();
}
}
运行测试代码,结果和手工编写的结果一致,完成了JDK中动态代理的实现模拟。
cglib动态代理
前面分析到,因为Java只允许单继承,而JDK生成的代理类本身就继承了Proxy类,因此,使用JDK实现的动态代理不能完成继承式的动态代理,但是我们可以使用cglib来实现继承式的动态代理。
大名鼎鼎的spring中就含有cglib动态代理,在此也以Spring中自带的cglib完成动态代理的实现:
[java] view plain
copy
print ?
public class Train{
public void move(){
System.out.println("火车行驶中…" );
}
}
public class CGLibProxy implements MethodInterceptor {
private Enhancer enhancer = new Enhancer();
public Object getProxy(Class> clazz){
enhancer.setSuperclass(clazz);
enhancer.setCallback(this );
return enhancer.create();
}
public Object intercept(Object obj, Method method, Object[] args,
MethodProxy proxy) throws Throwable {
System.out.println("日志开始" );
proxy.invokeSuper(obj, args);
System.out.println("日志结束" );
return null ;
}
}
public class Test {
public static void main(String[] args) {
CGLibProxy proxy = new CGLibProxy();
Train t = (Train) proxy.getProxy(Train.class );
t.move();
}
}
小结
动态代理与静态代理相比较,最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理。在接口方法数量比较多的时候,我们可以进行灵活处理,而不需要像静态代理那样对每一个方法或方法组合进行处理。Proxy 很美很强大,但是仅支持 interface 代理。Java 的单继承机制注定了这些动态代理类们无法实现对 class 的动态代理。好在有cglib为Proxy提供了弥补。class与interface的区别本来就模糊,在java8中更是增加了一些新特性,使得interface越来越接近class,当有一日,java突破了单继承的限制,动态代理将会更加强大。
转载自:http://www.cnblogs.com/cenyu/p/6289209.html
http://blog.csdn.net/goskalrie/article/details/52458773
http://www.cnblogs.com/whoislcj/p/5693980.html