代理模式 # 定义 在代理模式（Proxy Pattern）中，一个类代表另一个类的功能。这种类型的设计模式属于结构型模式。 在代理模式中，我们创建具有现有对象的对象，以便向外界提供功能接口。 >代理模式有点像老大和小弟，也有点像分销商。主要解决的是问题是为某些资源的访问、对象的类的易用操作上提供方便使用的代理服务。而这种设计思想的模式经常会出现在我们的系统中，或者你用到过的组件中，它们都提供给你一种非常简单易用的方式控制原本你需要编写很多代码的进行使用的服务类。 类似这样的场景可以想到； 1. 你的数据库访问层面经常会提供一个较为基础的应用，以此来减少应用服务扩容时不至于数据库连接数暴增。 2. 使用过的一些中间件例如；RPC 框架，在拿到 jar 包对接口的描述后，中间件会在服务启动的时候生成对应的代理类，当调用接口的时候，实际是通过代理类发出的 socket 信息进行通过。 3. 另外像我们常用的 MyBatis，基本是定义接口但是不需要写实现类，就可以对 xml 或者自定义注解里的 sql 语句进行增删改查操作。 优点： 1、职责清晰。 2、高扩展性。 3、智能化。 缺点： 1、由于在客户端和真实主题之间增加了代理对象，因此有些类型的代理模式可能会造成请求的处理速度变慢。 2、实现代理模式需要额外的工作，有些代理模式的实现非常复杂。 使用场景：按职责来划分，通常有以下使用场景： 1、远程代理。 2、虚拟代理。 3、Copy-on-Write 代理。 4、保护（Protect or Access）代理。 5、Cache代理。 6、防火墙（Firewall）代理。 7、同步化（Synchronization）代理。 8、智能引用（Smart Reference）代理。 注意事项： 1、和适配器模式的区别：适配器模式主要改变所考虑对象的接口，而代理模式不能改变所代理类的接口。 2、和装饰器模式的区别：装饰器模式为了增强功能，而代理模式是为了加以控制。 # 实践 这里我们模拟实现 mybatis-spring 中代理类生成部分。 需要注意一些知识点： 1. `BeanDefinitionRegistryPostProcessor`，spring 的接口类用于处理对 bean 的定义注册。 2. `GenericBeanDefinition`，定义 bean 的信息，在 mybatis-spring 中使用到的是 `ScannedGenericBeanDefinition` 略有不同。 3. `FactoryBean`，用于处理bean工厂的类，这个类非常见。 代码结构：  自定义注解 ```java @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) public @interface Select { // sql语句 String value() default ""; } ``` DAO接口 ```java public interface IUserDao { @Select("select userName from user where id = #{uId}") String queryUserInfo(String uId); } ```` 代理类定义 ```java @Slf4j public class MapperFactoryBean<T> implements FactoryBean<T> { private Class<T> mapperInterface; public MapperFactoryBean(Class<T> mapperInterface) { this.mapperInterface = mapperInterface; } @Override public T getObject() throws Exception { InvocationHandler handler = (proxy, method, args) -> { Select select = method.getAnnotation(Select.class); log.info("SQL：{}", select.value().replace("#{uId}", args[0].toString())); return args[0] + ", 设计模式学习中。。。"; }; return (T) Proxy.newProxyInstance(this.getClass().getClassLoader(), new Class[]{mapperInterface}, handler); } @Override public Class<?> getObjectType() { return mapperInterface; } @Override public boolean isSingleton() { return true; } } ``` - 如果你有阅读过 mybatis 源码，是可以看到这样的一个类；MapperFactoryBean，这里我们也模拟一个这样的类，在里面实现我们对代理类的定义。 - 通过继承 FactoryBean，提供 bean 对象，也就是方法；T getObject()。 - 在方法 getObject() 中提供类的代理以及模拟对 sql 语句的处理，这里包含了用户调用 dao 层方法时候的处理逻辑。 - 还有最上面我们提供构造函数来透传需要被代理类，Class<T> mapperInterface，在 mybatis 中也是使用这样的方式进行透传。 - 另外 getObjectType() 提供对象类型反馈，以及 isSingleton() 返回类是单例的。 将Bean定义注册到Spring容器 ```java public class RegisterBeanFactory implements BeanDefinitionRegistryPostProcessor { @Override public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException { GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); beanDefinition.setBeanClass(MapperFactoryBean.class); beanDefinition.setScope("singleton"); beanDefinition.getConstructorArgumentValues().addGenericArgumentValue(IUserDao.class); BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(beanDefinition, "userDao"); BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, registry); } @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException { // left intentionally blank } } ``` - 这里我们将代理的 bean 交给 spring 容器管理，也就可以非常方便让我们可以获取到代理的 bean。这部分是 spring 中关于一个 bean 注册过程的源码。 - GenericBeanDefinition，用于定义一个 bean 的基本信息 setBeanClass(MapperFactoryBean.class);，也包括可以透传给构造函数信息 addGenericArgumentValue(IUserDao.class); - 最后使用 BeanDefinitionReaderUtils.registerBeanDefinition，进行 bean 的注册，也就是注册到 DefaultListableBeanFactory 中。 配置文件spring-config ``` <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd" default-autowire="byName"> <bean id="userDao" class="fun.lixj.design.agent.RegisterBeanFactory"/> </beans> ``` 测试类： ```java @Slf4j public class ApiTest { @Test public void test_IUserDao() { BeanFactory beanFactory = new ClassPathXmlApplicationContext("spring-config.xml"); IUserDao userDao = beanFactory.getBean("userDao", IUserDao.class); String res = userDao.queryUserInfo("100001"); log.info("测试结果：{}", res); } } ``` - 测试的过程比较简单，通过加载 Bean 工厂获取我们的代理类的实例对象，之后调用方法返回结果。 - 那么这个过程你可以看到我们是没有对接口先一个实现类的，而是使用代理的方式给接口生成一个实现类，并交给 spring 管理。 测试结果如下： ``` 16:49:00.670 [main] DEBUG org.springframework.context.support.ClassPathXmlApplicationContext - Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@345965f2 16:49:00.805 [main] DEBUG org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loaded 1 bean definitions from class path resource [spring-config.xml] 16:49:00.832 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'userDao' 16:49:00.886 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Overriding bean definition for bean 'userDao' with a different definition: replacing [Generic bean: class [fun.lixj.design.agent.RegisterBeanFactory]; scope=; abstract=false; lazyInit=false; autowireMode=1; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [spring-config.xml]] with [Generic bean: class [fun.lixj.design.agent.MapperFactoryBean]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null] 16:49:00.892 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'userDao' 16:49:00.909 [main] INFO fun.lixj.design.agent.MapperFactoryBean - SQL：select userName from user where id = 100001 16:49:00.910 [main] INFO ApiTest - 测试结果：100001, 设计模式学习中。。。 Process finished with exit code 0 ``` # 总结 - 关于这部分代理模式的讲解我们采用了开发一个关于 mybatis-spring 中间件中部分核心功能来体现代理模式的强大之处，所以涉及到了一些关于代理类的创建以及 spring 中 bean 的注册这些知识点，可能在平常的业务开发中都是很少用到的，但是在中间件开发中确实非常常见的操作。 - 代理模式除了开发中间件外还可以是对服务的包装，物联网组件等等，让复杂的各项服务变为轻量级调用、缓存使用。你可以理解为你家里的电灯开关，我们不能操作 220v 电线的人肉连接，但是可以使用开关，避免触电。 - 代理模式的设计方式可以让代码更加整洁、干净易于维护，虽然在这部分开发中额外增加了很多类也包括了自己处理 bean 的注册等，但是这样的中间件复用性极高也更加智能，可以非常方便的扩展到各个服务应用中。 >GitHub地址： https://github.com/fuzhengwei/CodeGuide/blob/master/docs/md/develop/design-pattern/2020-06-16-%E9%87%8D%E5%AD%A6%20Java%20%E8%AE%BE%E8%AE%A1%E6%A8%A1%E5%BC%8F%E3%80%8A%E5%AE%9E%E6%88%98%E4%BB%A3%E7%90%86%E6%A8%A1%E5%BC%8F%E3%80%8B.md