【README】

本文阐述了3种代理模式的定义，并编写了代码测试案例；

代理其实是一种设计模式，可以在访问目标对象的方法上下文添加处理逻辑（扩展目标对象的功能），是 切面编程的基石；

【举个例子】 抖音直播带货就是一种代理模式；主播代理了工厂对象，提供了购买商品的方法；

主播可以下调商品价格（因为走量），类似于在购买商品方法上文添加了逻辑；

主播可以赠送其他商品，类似于在购买商品方法下文添加了逻辑；

【代理模式URL】

1.定义一个带有代理方法的接口；

2.定义目标对象实现这个接口；

3.定义代理对象实现这个接口，且代理对象调用目标对象的对应方法；

4.客户端调用代理对象的方法，代理对象接着调用目标对象的方法，且代理对象可以在上下文添加逻辑（代理模式的目的所在）；

 【1】静态代理（编译时生成代理类class文件）

1，代码结构： 需要代理对象和目标对象实现相同接口；

2，优点：可以在不修改目标对象的前提下，扩展其功能；

3，缺点：

• 冗余：每次代理都要定义一个代理类，会产生过多代理类；
• 不移维护： 一旦接口方法有增删改，则代理对象和目标对象都需要修改；

【1.1】静态代理代码示例

// 接口
public interface IUserDao {
    public void sayHello();
}

// 目标类
public class UserDaoImpl implements IUserDao {
    @Override
    public void sayHello() {
        System.out.println("i am method named sayHello.");
    }
}

// 代理类 
public class UserDaoStaticProxy implements IUserDao {

    private IUserDao target;
    public UserDaoStaticProxy(IUserDao target) {
        this.target = target;
    }

    @Override
    public void sayHello() {
        System.out.println("before");
        target.sayHello();
        System.out.println("after");
    }
}

main方法

public class StaticProxyTest {
    public static void main(String[] args) {
        // 目标对象
        IUserDao target = new UserDaoImpl();
        // 代理对象
        UserDaoStaticProxy proxy = new UserDaoStaticProxy(target);
        // 调用代理方法
        proxy.sayHello();
    }
}

执行结果 

before
i am method named sayHello.
after

【2】动态代理（运行时生成代理对象）

1，为了解决静态代理会有多个代理类，不易维护的缺点，我们引入了动态代理；

2，动态代理利用了JDK API，动态地在内存中构建代理对象，从而实现对目标对象的代理功能。动态代理又被称为JDK代理或接口代理。
3，静态代理与动态代理的区别主要在：

• 静态代理在编译时就已经实现，编译完成后代理类是一个实际的class文件；
• 动态代理是在运行时动态生成的，即编译完成后没有实际的class文件，而是在运行时动态生成类字节码，并加载到JVM中；

4，优点： 不需要代理对象实现接口，但目标对象必须实现接口；

5，底层实现： 底层调用了

// 生成代理对象 
Proxy.newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)

• loader： 目标对象的类加载器；
• interfaces： 目标对象实现的接口class数组；
• InvocationHandler：将目标方法调用分配到的调用处理器对象；

6，调用处理类实现接口 InvocationHandler ；

类描述：InvocationHandler 是代理对象关联的调用处理程序所实现的接口。
每个代理对象都有一个关联的调用处理程序。
当在代理对象上调用方法时，方法调用被编码并分派到其调用处理程序的调用方法。

public interface InvocationHandler {
    public Object invoke(Object proxy, Method method, Object[] args)
        throws Throwable;
}

 方法描述：处理代理对象上的方法调用并返回结果。

当在与其关联的代理对象上调用方法时，将在调用处理程序上调用本方法。

【2.1】动态代理代码示例

// 目标对象的接口
public interface IUserDao2 {
    public String sayHello();
}

// 目标对象所属类
public class UserDaoImpl2  implements IUserDao2 {
    @Override
    public String sayHello() {
        String msg = "i am method named sayHello. by dynamic proxy"; 
        System.out.println(msg);
        return msg;
    }
}

// 生成代理对象工厂
public class DynamicProxyFactory {
    private DynamicProxyFactory(){}

    public static Object getProxyInstance (Object target) {
        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("before");
                        // 执行目标方法
                        Object result = method.invoke(target, args);
                        System.out.println("after");
                        return result;
                    }
                });
    }
} 

main方法；

public class DynamicProxyTest {
    public static void main(String[] args) {
        // 目标对象
        UserDaoImpl2 target = new UserDaoImpl2();
        // 代理对象
        IUserDao2 proxy = (IUserDao2) DynamicProxyFactory.getProxyInstance(target);
        // 调用代理方法
        String result = proxy.sayHello();
        System.out.println(result);
    }
}

运行结果：

before
i am method named sayHello. by dynamic proxy
after
i am method named sayHello. by dynamic proxy

【3】cglib代理

1，cglib定义， cglib 是一个强大、高性能和高质量的代码生成库。 它可以扩展 JAVA 类并在运行时实现接口；

2，特点

1. JDK的动态代理有一个限制，就是使用动态代理的目标对象必须实现一个或多个接口。如果想目标对象不实现接口，就可以使用CGLIB实现；
2. CGLIB是一个强大的高性能的代码生成包，它可以在运行期扩展Java类与实现Java接口；它广泛的被许多AOP的框架使用，例如Spring AOP和dynaop，为他们提供方法的 interception（拦截）；
3. CGLIB包的底层是通过使用一个小而快的字节码处理框架ASM，来转换字节码并生成新的类。不鼓励直接使用ASM，因为它需要你对JVM内部结构包括class文件的格式和指令集都很熟悉；

3，cglib与动态代理最大的区别：

• 使用动态代理的对象必须实现一个或多个接口；使用cglib代理的对象则无需实现接口，达到代理类无侵入；

【3.1】cglib代理代码示例

1，maven 引入 cglib 依赖；

<dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.2.5</version>
        </dependency>

2，没有实现接口的目标类

public class UserDaoImpl3 {
    public String sayHello() {
        String msg = "i am method named sayHello. test cglib  proxy.";
        System.out.println(msg);
        return msg;
    }
}

3，代理工厂

public class CglibProxyFactory implements MethodInterceptor {
    private Object target;

    public CglibProxyFactory(Object target) {
        this.target = target;
    }

    public Object getProxyInstance () {
        this.target = target;
        // 工具类
        Enhancer enhancer = new Enhancer();
        // 设置父类
        enhancer.setSuperclass(target.getClass());
        // 设置回调函数
        enhancer.setCallback(this);
        // 创建子类对象代理
        return enhancer.create();
    }

    @Override
    public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        System.out.println("before");
        Object result = method.invoke(target, args);
        System.out.println("after");
        return result;
    }
}

4，main方法

public class CglibProxyTest {
    public static void main(String[] args) {
        // 目标对象
        UserDaoImpl3 target = new UserDaoImpl3();
        // 代理对象
        UserDaoImpl3 proxy = (UserDaoImpl3) new CglibProxyFactory(target).getProxyInstance();
        // 调用代理方法
        String result = proxy.sayHello();
        System.out.println(result);
    }
}

执行结果：

before
i am method named sayHello. test cglib  proxy.
after
i am method named sayHello. test cglib  proxy.

【4】java代理实现小结

1）静态代理

• 1.1）实现较简单，只要代理对象对目标对象进行包装，即可实现增强功能，但静态代理只能为一个目标对象服务，如果目标对象过多，则会产生很多代理类。
• 1.2）静态代理在编译时产生class字节码文件，可以直接使用，效率高。

2）动态代理

• 2.1）需要目标对象实现业务接口，代理对象关联的调用处理类需要实现InvocationHandler接口。
• 2.2）动态代理必须实现InvocationHandler接口，通过反射代理方法，比较消耗系统性能，但可以减少代理类的数量，使用更灵活。

3）cglib代理

• 无需实现接口，通过生成类字节码实现代理，比反射稍快，不存在性能问题，但cglib会继承目标对象，需要重写方法，所以目标对象不能为final类。

【reference】

https://segmentfault.com/a/1190000011291179https://segmentfault.com/a/1190000011291179

代理模式

代理模式(Proxy Pattern)是一种结构性模式。代理模式为一个对象提供了一个替身，以控制对这个对象的访问。即通过代理对象访问目标目标对象，可以在目标对象实现的基础上，增强额外的功能操作，即扩展目标对象的功能。

被代理的对象可以是远程对象、创建开销答得对象或需要安全控制得对象。代理模式主要有三种形式，分别是静态代理、动态代理（也称JDK代理、接口代理）和cglib代理（在内存动态创建对象而不需要实现接口，也可属于动态代理得范畴）

类图：

静态代理

静态代理是定义父类或者接口，然后被代理对象（即目标对象）与代理对象一起实现相同的接口或者是继承相同父类。代理对象与目标对象实现相同的接口，然后通过调用相同的方法来调用目标对象的方法。

• 优点：可不修改目标对象的功能，通过代理对象对目标功能扩展。
• 缺点：因为代理对象需要与目标对象实现一样的接口，所以会有很多代理类，一旦接口增加方法，目标对象与代理对象都要维护。

比如老师代课的案例：

• ITeacherDao：接口
• TeacherDao：目标对象，实现接口ITeacherDao
• TeacherDAOProxy：代理对象，也实现ITeacherDao接口，并且聚合ITeacherDao属性，通过构造器传参设置值，调用的时候通过调用代理对象的方法来调用目标对象。

代码

1. 接口

public interface ITeacherDao {
	void teach(); // 授课的方法
}

2. 被代理对象

public class TeacherDao implements ITeacherDao {
	@Override
	public void teach() {
		System.out.println("一键三连");
	}
}

3. 代理对象

public class TeacherDaoProxy implements ITeacherDao {
	private ITeacherDao target; //通过接口聚合目标对象
	public TeacherDaoProxy(ITeacherDao target) {
		this.target = target;
	}
	@Override
	public void teach() { //重写接口
		System.out.println("静态代理开始");
		target.teach();
		System.out.println("静态代理结束");
	}
}

4. 测试

public class Client {
	public static void main(String[] args) {
		//创建被代理对象
		TeacherDao teacherDao = new TeacherDao();

		//创建代理对象, 同时将被代理对象传递给代理对象
		TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao);

		//通过代理对象，调用到被代理对象的方法
		teacherDaoProxy.teach();
	}
}
/*运行结果：
静态代理开始
一键三连
静态代理结束
*/

动态代理

动态代理也叫JDK代理、接口代理。它使代理对象不需要实现接口（但目标对象要实现接口），代理对象的生成，是利用JDK的API，动态的在内存中构建代理对象。

即使用JDK包java.lang.reflect.Proxy中的newProxyInstance方法来动态的创建目标对象（被代理对象），该方法需要如下接收三个参数：

1. ClassLoader loader
   指定当前目标对象使用的类加载器
2. Class<?>[] interfaces
   目标对象实现的接口类型，使用泛型方法确认类型
3. InvocationHandler h
   事情处理，执行目标对象的方法时，会触发事情处理器方法，把当前执行的目标对象方法作为参数传入

static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces,InvocationHandler h )

类图：

核心是getProxyInstacne()

1. 根据传入的对象TeacherDao目标对象
2. 利用返回机制，返回一个代理对象
3. 然后通过代理对象，调用目标对象方法

代码：

1. 接口

public interface ITeacherDao {
	void teach();
	void tesst(String name);
}

2. 目标对象

public class TeacherDao implements ITeacherDao {
	@Override
	public void teach() {
		System.out.println("一键三连");
	}
	@Override
	public void tesst(String name) {
		System.out.println("传参测试：" + name);
	}
}

（插播反爬信息 ）博主CSDN地址：https://wzlodq.blog.csdn.net/

3. 代理对象

public class ProxyFactory {
	//维护一个目标对象 , Object
	private Object target;
	//构造器 ， 对target 进行初始化
	public ProxyFactory(Object target) {
		this.target = target;
	}
	//动态生成一个代理对象
	public Object getProxyInstance() {
		return Proxy.newProxyInstance(target.getClass().getClassLoader(),
				target.getClass().getInterfaces(),
				new InvocationHandler() { //匿名类重写invoke方法
					@Override
					public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
						System.out.println("动态代理开始");
						Object returnVal = method.invoke(target, args);//反射机制调用目标对象的方法
						System.out.println("动态代理结束");
						return returnVal;
					}
				});
	}
}

4. 测试

public class Client {
	public static void main(String[] args) {
		//创建目标对象
		ITeacherDao target = new TeacherDao();

		//创建代理对象
		ITeacherDao proxyInstance = (ITeacherDao)new ProxyFactory(target).getProxyInstance();

		//内存中动态生成了代理对象
		System.out.println(proxyInstance.getClass());

		//通过代理对象，调用目标对象的方法
		proxyInstance.teach();
		proxyInstance.tesst("一键三连");
	}
}
/*运行结果：
动态代理开始
一键三连
动态代理结束
动态代理开始
传参测试：一键三连
动态代理结束
*/

cglib代理

Cglib代理也叫作子类代理，它使目标对象不需要实现接口，是在内存中构建一个子类对象从而实现对目标对象功能扩展，有的也将Cglib代理归属到动态代理。

Cglib是一个高性能的代码生成包，它可以在运行期扩展java类与实现java接口。被许多AOP的框架使用（如Spring AOP）。Cglib包的底层是通过使用字节码处理框架ASM来转换字节码并生成新的类。

特别注意：代理的类不能为final，否则报错java.lang.IllegalArgumentException ，如果目标对象的方法如果为final或static，那么就不会被拦截（即不会执行目标对象额外的业务方法）。

添加cglib包：
下载以下jar包，复制到项目中，然后右键add to library。
https://github.com/wuzelong/CSDNBLOG（顺便求个star）

不一样的是代理对象实现了MethodInterceptor接口，重写了intercept()方法实现对被代理对象（目标对象）的方法掉调用。

代码：

1. 目标对象

public class TeacherDao {
	public String teach() {
		System.out.println("一键三连");
		return "好";
	}
}

2. 代理对象

public class ProxyFactory implements MethodInterceptor {
	//目标对象
	private Object target;
	public ProxyFactory(Object target) {
		this.target = target;
	}
	//返回target对象的代理对象
	public Object getProxyInstance() {
		//创建一个工具类
		Enhancer enhancer = new Enhancer();

		//设置父类
		enhancer.setSuperclass(target.getClass());

		//设置回调函数
		enhancer.setCallback(this);

		//创建子类对象，即代理对象
		return enhancer.create();
	}
	//重写intercept方法，会调用目标对象的方法
	@Override
	public Object intercept(Object arg0, Method method, Object[] args, MethodProxy arg3) throws Throwable {
		System.out.println("Cglib代理开始");
		Object returnVal = method.invoke(target, args);
		System.out.println("Cglib代理结束");
		return returnVal;
	}
}

3. 测试

public class Client {
	public static void main(String[] args) {
		//创建目标对象
		TeacherDao target = new TeacherDao();

		//获取到代理对象，并且将目标对象传递给代理对象
		TeacherDao proxyInstance = (TeacherDao)new ProxyFactory(target).getProxyInstance();

		//执行代理对象的方法，触发intecept 方法，从而实现对目标对象的调用
		proxyInstance.teach();
		System.out.println(res);
	}
}
/*运行结果：
Cglib代理开始
一键三连
Cglib代理结束
好
*/

应用

• 防火墙代理
  内网通过代理穿透防火墙，实现对公网的访问。
• 缓存代理
  请求资源时先到缓存代理中取，如果取不到再到数据库或公网取，然后更新缓存（如Redis）。
• 远程代理
  通过网络和真正的远程对象沟通信息（如远程连接服务器）。
• 同步代理
  用在多线程编程中，完成多线程间同步工作。

原创不易，请勿转载（本不富裕的访问量雪上加霜 ）
博主首页：https://wzlodq.blog.csdn.net/
微信公众号：吾仄lo咚锵
如果文章对你有帮助，记得一键三连❤

首先我们看下没有使用CGLIB对Controller进行代理时代码的样子

原始程序

@SpringBootApplication
public class CglibProxyProblemMain {
    public static void main(String[] args) {
        SpringApplication.run(CglibProxyProblemMain.class, args);
    }
}
@Service
public class TestService {

    public String test(){
        return "test";
    }

    public String test2(){
        return "test2";
    }
}
@RestController
public class TestController {

    @Autowired
    private TestService testService;

    @GetMapping("/test")
    private String test(){
        return testService.test();
    }

    @GetMapping("/test2")
    public String test2(){
        return testService.test2();
    }
}

上面的逻辑很简单，CglibProxyProblemMain 作为Spring的启动入口，TestController中依赖了TestService。然后我们运行一下程序，并测试一下接口是否正常。

从curl的结果上看，我们TestController应该是生效了

加入切面

然后，我们引入一个切面，并在TestController的方法执行前先输出一个“before …”

@Component
@Aspect
public class TestAspect {

    @Before("pointCut()")
    public void beforeTest(){
        System.out.println("before ...");
    }

    @Pointcut("execution(public * com..TestController.*(..))")
    public void pointCut() {
        //定义切点
    }
}

然后我们再跑一次程序。服务启动正常：

接下来再测试一下之前的接口，然后我们的\test接口报错了：


神奇的空指针问题就这么出现了…

问题排查

既然是空指针，那我们先调试一下吧：

从调试的堆栈信息上看，this指向的当前对象是一个被CGLIB代理之后的对象。因为这个类没有接口，同时我们又启用了切面，所以当前对象是一个被CGLIB代理之后的对象感觉也没什么问题。
但是问题是为什么testService是null呢？难道没有注入成功？那我们换个注入方式吧，使用构造器注入，同时将testService使用final修饰，这样testService应该就不会null了。
修改之后TestController是这样的：

稳妥起见，我们再跟踪一次服务启动，确认一下testService确实被成功注入了。

这次应该没问题了，我们再测试一下接口：

依旧是一个空指针的报错，再调试一次程序，发现testService依旧是null，就像下面这样：

这就很诡异了…
我们再测试一下/test2这个接口，更加神奇的现象出现了，/test2完全没问题

难道testService又有了？我们接着调试一下：

从调试信息中可以看到，在执行test2时，testService确实是存在的，而且this指向并不是被CGLIB代理之后的类。

问题解决

这下就找到问题的原因了

CGLIB无法代理被private或final修饰的方法

由于test方法是private的，无法被CGLIB代理，所以当这个方法被调用时，其实调用的是代理类的同名方法。但是test2由于是public的，可以被正常代理，所以始终都没有问题。

引申

我们再深入一下这个问题，为什么代理类执行test方法时，testService是null呢？难道没有依赖注入成功吗？
要解决这个问题，首先我们得看下代理是什么时机生成的：

从调试信息中可以看到，生成代理时，bean已经实例化完毕，bean中的testService已经有值了。但是生成的代理类中的testService却是空的。

我们都知道CGLIB是基于继承的。也就是生成的代理类是被代理类的子类。但是我们既然写了构造器注入，为什么代理类的testService依旧是null呢?

原因是CGLIB作弊了，通过CGLIB生成的类的构造器中没有super(...)，所以testService就null了。饶了这么大一圈，其实最后还是因为对CGLIB代理的原理不够清晰才导致了这样的问题，-_-||