30 | 热点问题答疑（3）：Spring框架中的设计模式

在构思这个专栏的时候，回想当时我是如何研究Tomcat和Jetty源码的，除了理解它们的实现之外，也从中学到了很多架构和设计的理念，其中很重要的就是对设计模式的运用，让我收获到不少经验。而且这些经验通过自己消化和吸收，是可以把它应用到实际工作中去的。

在专栏的热点问题答疑第三篇，我想跟你分享一些我对设计模式的理解。有关Tomcat和Jetty所运用的设计模式我在专栏里已经有所介绍，今天想跟你分享一下Spring框架里的设计模式。Spring的核心功能是IOC容器以及AOP面向切面编程，同样也是很多Web后端工程师每天都要打交道的框架，相信你一定可以从中吸收到一些设计方面的精髓，帮助你提升设计能力。

简单工厂模式

我们来考虑这样一个场景：当A对象需要调用B对象的方法时，我们需要在A中new一个B的实例，我们把这种方式叫作硬编码耦合，它的缺点是一旦需求发生变化，比如需要使用C类来代替B时，就要改写A类的方法。假如应用中有1000个类以硬编码的方式耦合了B，那改起来就费劲了。于是简单工厂模式就登场了，简单工厂模式又叫静态工厂方法，其实质是由一个工厂类根据传入的参数，动态决定应该创建哪一个产品类。

Spring中的BeanFactory就是简单工厂模式的体现，BeanFactory是Spring IOC容器中的一个核心接口，它的定义如下：

public interface BeanFactory {
   Object getBean(String name) throws BeansException;
   <T> T getBean(String name, Class<T> requiredType);
   Object getBean(String name, Object... args);
   <T> T getBean(Class<T> requiredType);
   <T> T getBean(Class<T> requiredType, Object... args);
   boolean containsBean(String name);
   boolean isSingleton(String name);
   boolea isPrototype(String name);
   boolean isTypeMatch(String name, ResolvableType typeToMatch);
   boolean isTypeMatch(String name, Class<?> typeToMatch);
   Class<?> getType(String name);
   String[] getAliases(String name);
}

我们可以通过它的具体实现类（比如ClassPathXmlApplicationContext）来获取Bean：

BeanFactory bf = new ClassPathXmlApplicationContext("spring.xml");
User userBean = (User) bf.getBean("userBean");

从上面代码可以看到，使用者不需要自己来new对象，而是通过工厂类的方法getBean来获取对象实例，这是典型的简单工厂模式，只不过Spring是用反射机制来创建Bean的。

工厂方法模式

工厂方法模式说白了其实就是简单工厂模式的一种升级或者说是进一步抽象，它可以应用于更加复杂的场景，灵活性也更高。在简单工厂中，由工厂类进行所有的逻辑判断、实例创建；如果不想在工厂类中进行判断，可以为不同的产品提供不同的工厂，不同的工厂生产不同的产品，每一个工厂都只对应一个相应的对象，这就是工厂方法模式。

Spring中的FactoryBean就是这种思想的体现，FactoryBean可以理解为工厂Bean，先来看看它的定义：

public interface FactoryBean<T> {
  T getObject()；
  Class<?> getObjectType();
  boolean isSingleton();
}

我们定义一个类UserFactoryBean来实现FactoryBean接口，主要是在getObject方法里new一个User对象。这样我们通过getBean(id) 获得的是该工厂所产生的User的实例，而不是UserFactoryBean本身的实例，像下面这样：

BeanFactory bf = new ClassPathXmlApplicationContext("user.xml");
User userBean = (User) bf.getBean("userFactoryBean");

单例模式

单例模式是指一个类在整个系统运行过程中，只允许产生一个实例。在Spring中，Bean可以被定义为两种模式：Prototype（多例）和Singleton（单例），Spring Bean默认是单例模式。那Spring是如何实现单例模式的呢？答案是通过单例注册表的方式，具体来说就是使用了HashMap。请注意为了方便你阅读，我对代码进行了简化：

public class DefaultSingletonBeanRegistry {
    
    //使用了线程安全容器ConcurrentHashMap，保存各种单实例对象
    private final Map<String, Object> singletonObjects = new ConcurrentHashMap<String, Object>;

    protected Object getSingleton(String beanName) {
    //先到HashMap中拿Object
    Object singletonObject = singletonObjects.get(beanName);
    
    //如果没拿到通过反射创建一个对象实例，并添加到HashMap中
    if (singletonObject == null) {
      singletonObjects.put(beanName,
                           Class.forName(beanName).newInstance());
   }
   
   //返回对象实例
   return singletonObjects.get(beanName);
  }
}

上面的代码逻辑比较清晰，先到HashMap去拿单实例对象，没拿到就创建一个添加到HashMap。

代理模式

所谓代理，是指它与被代理对象实现了相同的接口，客户端必须通过代理才能与被代理的目标类进行交互，而代理一般在交互的过程中（交互前后），进行某些特定的处理，比如在调用这个方法前做前置处理，调用这个方法后做后置处理。代理模式中有下面几种角色：

抽象接口：定义目标类及代理类的共同接口，这样在任何可以使用目标对象的地方都可以使用代理对象。
目标对象：定义了代理对象所代表的目标对象，专注于业务功能的实现。
代理对象：代理对象内部含有目标对象的引用，收到客户端的调用请求时，代理对象通常不会直接调用目标对象的方法，而是在调用之前和之后实现一些额外的逻辑。

代理模式的好处是，可以在目标对象业务功能的基础上添加一些公共的逻辑，比如我们想给目标对象加入日志、权限管理和事务控制等功能，我们就可以使用代理类来完成，而没必要修改目标类，从而使得目标类保持稳定。这其实是开闭原则的体现，不要随意去修改别人已经写好的代码或者方法。

代理又分为静态代理和动态代理两种方式。静态代理需要定义接口，被代理对象（目标对象）与代理对象（Proxy)一起实现相同的接口，我们通过一个例子来理解一下：

//抽象接口
public interface IStudentDao {
    void save();
}

//目标对象
public class StudentDao implements IStudentDao {
    public void save() {
        System.out.println("保存成功");
    }
}

//代理对象
public class StudentDaoProxy implements IStudentDao{
    //持有目标对象的引用
    private IStudentDao target;
    public StudentDaoProxy(IStudentDao target){
        this.target = target;
    }

    //在目标功能对象方法的前后加入事务控制
    public void save() {
        System.out.println("开始事务");
        target.save();//执行目标对象的方法
        System.out.println("提交事务");
    }
}

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

    //创建代理对象,把目标对象传给代理对象,建立代理关系
    StudentDaoProxy proxy = new StudentDaoProxy(target);
   
    //执行的是代理的方法
    proxy.save();
}

而Spring的AOP采用的是动态代理的方式，而动态代理就是指代理类在程序运行时由JVM动态创建。在上面静态代理的例子中，代理类（StudentDaoProxy）是我们自己定义好的，在程序运行之前就已经编译完成。而动态代理，代理类并不是在Java代码中定义的，而是在运行时根据我们在Java代码中的“指示”动态生成的。那我们怎么“指示”JDK去动态地生成代理类呢？

在Java的java.lang.reflect包里提供了一个Proxy类和一个InvocationHandler接口，通过这个类和这个接口可以生成动态代理对象。具体来说有如下步骤：

1.定义一个InvocationHandler类，将需要扩展的逻辑集中放到这个类中，比如下面的例子模拟了添加事务控制的逻辑。

public class MyInvocationHandler implements InvocationHandler {

    private Object obj;

    public MyInvocationHandler(Object obj){
        this.obj=obj;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args)
            throws Throwable {

        System.out.println("开始事务");
        Object result = method.invoke(obj, args);
        System.out.println("开始事务");
        
        return result;
    }
}

2.使用Proxy的newProxyInstance方法动态的创建代理对象：

public static void main(String[] args) {
  //创建目标对象StudentDao
  IStudentDao stuDAO = new StudentDao();
  
  //创建MyInvocationHandler对象
  InvocationHandler handler = new MyInvocationHandler(stuDAO);
  
  //使用Proxy.newProxyInstance动态的创建代理对象stuProxy
  IStudentDao stuProxy = (IStudentDao) 
 Proxy.newProxyInstance(stuDAO.getClass().getClassLoader(), stuDAO.getClass().getInterfaces(), handler);
  
  //动用代理对象的方法
  stuProxy.save();
}

上面的代码实现和静态代理一样的功能，相比于静态代理，动态代理的优势在于可以很方便地对代理类的函数进行统一的处理，而不用修改每个代理类中的方法。

Spring实现了通过动态代理对类进行方法级别的切面增强，我来解释一下这句话，其实就是动态生成目标对象的代理类，并在代理类的方法中设置拦截器，通过执行拦截器中的逻辑增强了代理方法的功能，从而实现AOP。

本期精华

今天我和你聊了Spring中的设计模式，我记得我刚毕业那会儿，拿到一个任务时我首先考虑的是怎么把功能实现了，从不考虑设计的问题，因此写出来的代码就显得比较稚嫩。后来随着经验的积累，我会有意识地去思考，这个场景是不是用个设计模式会更高大上呢？以后重构起来是不是会更轻松呢？慢慢我也就形成一个习惯，那就是用优雅的方式去实现一个系统，这也是每个程序员需要经历的过程。

今天我们学习了Spring的两大核心功能IOC和AOP中用到的一些设计模式，主要有简单工厂模式、工厂方法模式、单例模式和代理模式。而代理模式又分为静态代理和动态代理。JDK提供实现动态代理的机制，除此之外，还可以通过CGLIB来实现，有兴趣的同学可以理解一下它的原理。

课后思考

注意到在newProxyInstance方法中，传入了目标类的加载器、目标类实现的接口以及MyInvocationHandler三个参数，就能得到一个动态代理对象，请你思考一下newProxyInstance方法是如何实现的。

不知道今天的内容你消化得如何？如果还有疑问，请大胆的在留言区提问，也欢迎你把你的课后思考和心得记录下来，与我和其他同学一起讨论。如果你觉得今天有所收获，欢迎你把它分享给你的朋友。

精选留言

neohope

2019-07-24 00:36:04

//在Proxy类里中：
//constructorParams的定义如下：
private static final Class<?>[] constructorParams = { InvocationHandler.class };

//newProxyInstance无限精简之后就是：
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
throws IllegalArgumentException {
//通过ProxyClassFactory调用ProxyGenerator生成了代理类
Class<?> cl = getProxyClass0(loader, interfaces);
//找到参数为InvocationHandler.class的构造函数
final Constructor<?> cons = cl.getConstructor(constructorParams);
//创建代理类实例
return cons.newInstance(new Object[]{h});
}

//在ProxyGenerator类中：
public static byte[] generateProxyClass(final String name,Class<?>[] interfaces, int accessFlags)){}
private byte[] generateClassFile() {}
//上面两个方法，做的就是
//将接口全部进行代理
//并生成其他需要的方法，比如上面用到的构造函数、toString、equals、hashCode等
//生成对应的字节码
//其实这也就说明了，为何JDK的动态代理，必须需要至少一个接口

作者回复

👍

2019-07-24 18:45:01
-W.LI-

2019-07-18 08:39:22

之前硬着头皮看过这个源码，中间有一步weakcache印象深刻。弱引用缓存，先从缓存中取，没取到获取字节码，校验魔术版本号之类的，最后反射实现。反射效率不高也是这个原因导致的，要获取源文件校验准备初始化(轻量级累加载一次)。
nightmare

2019-07-19 11:30:45

老师能讲一下spring这么解决循环依耐的吗

作者回复

Spring只解决了单例bean通过setXxx或者@Autowired进行循环依赖：https://blog.csdn.net/qq924862077/article/details/73926268

其他场景可以想办法绕过：https://www.baeldung.com/circular-dependencies-in-spring

2019-07-20 00:57:40
Standly

2019-07-18 23:20:56

老师，工厂方法模式没看懂。另外DefaultSingletonBeanRegistry的getBean方法的实现存在线程安全问题吧？虽然用了ConcurrentHashMap,但是if (singletonObject == null) 存在竞态条件，可能有2个线程同时判断为true，最后产生了2个对象实例。应该用putIfAbsent方法。

作者回复

汗颜，代码简化的过程中去掉了线程安全的部分，线程安全的版本应该是这样的：

//如果没拿到通过反射创建一个对象实例，并添加到HashMap中
if (singletonObject == null) {
synchronized(singletonObjects){
if(singletonObjects.get(beanName) == null){
singletonObjects.put(beanName,Class.forName(beanName).newInstance());
}
}
}

2019-07-20 01:24:19
QQ怪

2019-07-18 23:09:50

动态代理的思路便是动态生成一个新类，先通过传入的classLoader生成对应Class对象，后通过反射获取构造函数对象并生成代理类实例，jdk动态代理是通过接口实现的，但很多类是没有针对接口设计的，但是我们知道可以通过拼接字节码生成新的类的自由度是十分大的，所以cglib框架就是通过拼接字节码来实现非接口类的代理。
QQ怪

2019-07-18 22:37:37

老师这次加餐面试必问题
草戊

2019-07-29 08:26:09

BeanFactory和FactoryBean的代码示例是一样的？
靠人品去赢

2019-11-07 18:01:15

这个工厂模式，这各其实实例化的出来我觉得还是工厂bean，但是可以通过getObject来获取bean。这里可以看一下Spring的ObjectFactoryCreatingFactoryBean（通过继承AbstractFactoryBean ，然后由AbstractFactoryBean实现BeanFactory的）
public Object getObject() throws BeansException {
return this.beanFactory.getBean(this.targetBeanName);
}
对应类名字传过来即可，若果是动态那工厂模式就大显神威了。
桔子

2019-09-29 16:25:51

谢谢，我学会了动态代理~
芋头

2023-03-22 19:49:03

老师，其实我蛮好奇怎么样才能看到动态代理后的类代码
惘闻

2021-01-26 20:15:22

老师你说的代理模式是为了增强被代理类的方法。可是这不是装饰器模式的定义吗？代理模式主要是提供一种间接访问被代理类的方式和控制。
liyanzhaog

2020-07-29 12:45:11

动态反射的理解：
//创建目标对象StudentDao
IStudentDao stuDAO = new StudentDao();
// 创建目标对象的代理对象类
Class proxyClass=
Proxy.getProxyClass(stuDAO.getClass().getClassLoader(),stuDAO.getClass().getInterfaces());
// 获取代理对象类的构造器
Constructor constructors=proxyClass.getConstructor(InvocationHandler.class);
// 获取代理对象实例
IStudentDao studentDao=
(IStudentDao)constructors.newInstance(new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("开启事务...");
Object rst=method.invoke(stuDAO,args);
System.out.println("提交事务...");
return rst;
}
});
// 调用代理对象的方法
studentDao.save();

和静态代理的区别就在第一步创建对象的代理类，proxyClass的代码：
public final class $Proxy0 extends Proxy implements IStudentDao {
private static Method m3=
Class.forName("com.sustcoder.design.proxy.IStudentDao").getMethod("save");
public $Proxy0(InvocationHandler var1) throws {
super(var1);
}
public final void save() throws {
try {
super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
802.11

2019-07-29 08:19:49

文中的工厂模式，有一个疑惑，它确实解决了对象的创建问题，但是对象每一个字段的赋值，工厂模式可以解决吗？或者怎么解决呢，谢谢

作者回复

字段赋初始值一般来说由类的构造函数或者初始化函数完成，但是Spring比较特殊，可以通过反射注入字段值

2019-08-03 22:51:59
nightmare

2019-07-19 09:15:32

如果是基于反射实现的，那增强的业务这么植入的
许童童

2019-07-18 14:28:52

工厂方法模式说的就是抽象工厂模式吧
阿青，你学到了吗

2019-07-18 08:17:26

基于反射实现的