spring 声明一个单例的service spring实现单例

转载

数据大侠客 2024-03-28 08:30:11

文章标签 spring ioc java 设计模式编程语言 文章分类 架构后端开发

相信只要从事过java程序开发的程序员就没有没听说过Spring框架的。对于Java后端开发者来说，Spring简直是神兵利器一样的存在。而Spring源码又是非常优质的代码，里面充分利用了各种设计模式，对于程序员来说，能够看懂、理解Spring源码的设计，无论是面试还是应用到开发中，都是对自己有非常大的裨益的。
Spring有两个非常重要的功能，一个是IOC，一个是AOP。今天我们所要探讨的对象的创建就属于IOC层面。IOC(控制反转)，是由Spring框架提供，来帮助开发者创建bean对象、管理bean对象的。我们今天就通过debug源码的方式了解一下单例对象的创建。

一、准备工作

首先让我们来准备一个我们将要生成的对象。

public class A {

    private String aname;

    public String getAname() {
        return aname;
    }

    public void setAname(String aname) {
        this.aname = aname;
    }
}

配置文件中定义bean信息

<bean id="a" class="com.mao.springstudy.A">
        <property name="aname" value="我是A"></property>
    </bean>

在main方法中进行代码编写

ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring-config.xml");
A a = (A) context.getBean("a");
System.out.println("a的name" + a.getAname());

二、跟着debug进入源码

1.ClassPathXmlApplicationContext

点击运行，跟着调试断点走到ClassPathXmlApplicationContext的构造方法里。

public ClassPathXmlApplicationContext(
			String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
			throws BeansException {

		super(parent);
		setConfigLocations(configLocations);
		if (refresh) {
			refresh();
		}
	}

其中setConfigLocation(configLocations)是用来设置本地的配置信息。
重点是refresh()方法。

根据断点调试我们可以发现，这个refresh()方法实际是调用了AbstractApplicationContext中的refresh()方法。这个refresh()方法是AbstractApplicationContext的一个模板方法，由子类调用。

2.refresh

在refresh()的十三个方法中，创建对象的方法是finishBeanFactoryInitialization(beanFactory)，源码中给的注释是“Instantiate all remaining (non-lazy-init) singletons.”，翻译过来也就是“实例化所有剩余的（非延迟初始化）单例。”。
跟着调试点进方法中，找到beanFactory.preInstantiateSingletons();，继续点进这个方法。我们看到有一个ArrayList，这个ArrayList就是将配置文件中的bean转成beanDefinition的name的集合，也就表示了我们将要创建对象的数量。接下来通过for循环，将对象创建出来。

3.getBean(beanName)和doGetBean()

让我们跟着断点继续走，断点进到了getBean(beanName)的方法中，从这里开始，就将进入创建对象的步骤中。进入到“getBean()”方法中。

@Override
	public Object getBean(String name) throws BeansException {
		return doGetBean(name, null, null, false);
	}

可以看到，getBean方法又调用了doGetBean()方法。

这里重点强调下，在spring源码中，真正“做事”的方法都是以“do”开头的。比如说这里的getBean和doGetBean方法，真正去获取Bean对象的实际是doGetBean方法。让我们跟着断点继续走到doGetBean()方法中。

在doGetBean()方法中，先调用getSingleton(beanName)方法，这个方法是个非常重要的方法，它是从spring的三级缓存中查找对象是否已被创建。三级缓存的存在是spring为了解决对象循环依赖问题。我将在以后的文章中聊一聊spring循环依赖的问题。
跟着断点继续往下走，走到下方代码处。

// Create bean instance.
	if (mbd.isSingleton()) {
		sharedInstance = getSingleton(beanName, () -> {
			try {
				return createBean(beanName, mbd, args);
			}
			catch (BeansException ex) {
				destroySingleton(beanName);	
				throw ex;
			}	
		});
	bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
	}

根据if判断条件我们可以知道，这里是判断我们所要创建的bean是否是单例模式，如果是单例模式的bean就进到if分支中。这里的getSingleton()方法有些特殊，它是以lambda表达式作为入参。我们进到getSingleton()方法中粗略的看一下。在getSingleton()方法中有一行代码

singletonObject = singletonFactory.getObject();

其中的signletonFactory就是我们传入的lambda表达式。当调用了singletonFactory.getObject()方法，就是调用了lambda表达式中的代码块，也就是调用了lambda表达式中的createBean(beanName, mbd, args)方法。

4.createBean()和doCreateBean()

从createBean()的方法名字中我们就可以知道，这是一个用来创建Bean的方法。让我们跟着断点点进去。进去之后我们可以找到一个方法，叫做doCreateBean()方法。根据我们上面强调的规则，这个方法是真正创建bean对象的方法，让我们点进这个方法。在方法中我们可以看到这一段代码。

if (instanceWrapper == null) {
	// createBeanInstance方法中通过反射调用bean的构造方法,实例化出bean
	// 调用链 createBeanInstance -> instantiateBean -> SimpleInstantiationStrategy.instantiate
	instanceWrapper = createBeanInstance(beanName, mbd, args);
}

进到createBeanInstance(beanName, mbd, args)方法中，跟着断点走，一直走到方法最后一行instantiateBean(beanName, mbd)方法中。方法中有以下代码。

// 调用策略类实例化bean
beanInstance = getInstantiationStrategy().instantiate(mbd, beanName, this);

5.instantiateBean(beanName, mbd)(实例化出对象)

再进入instantiate()方法中。跟着断点继续调试，调试到其中一行代码。

// 通过反射获取bean构造方法
constructorToUse = clazz.getDeclaredConstructor();

！！！亲人啊！看到这行代码就像看到了亲人！！！这一行代码不就是java利用反射获取构造方法嘛！
让我们继续往下看，获取了构造方法后就是调用newInstance方法了。BeanUtils.instantiateClass(constructorToUse)方法就是将构造函数传过去调用newInstance方法，让我们点进方法里面去，在这个方法中我们可以找到：

return ctor.newInstance(argsWithDefaultValues);

到这里，一个对象就算通过反射的方式实例化成功了。（笔芯）

6.对象属性赋值及对象后置处理

让我们继续让断点走完。实例化对象后我们又回到了doCreateBean()方法中。spring通过

addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));

这个方法，将实例化后的对象放入三级缓存中第三级缓存。接着通过
populateBean(beanName, mbd, instanceWrapper)方法对对象的属性进行赋值，在赋值完成操作后，再调用exposedObject = initializeBean(beanName, exposedObject, mbd)方法，实现aware接口或者beanPostProcessors。

到这里，基本一个单例对象的创建就结束了。

三、总结

让我们来梳理一下spring中创建单例对象的脉络。首先由AbstractApplicationContext的子类来调用refresh()方法；refresh()方法在初始化IOC容器、准备beanPostProcessor等操作后，调用finishBeanFactoryInitialization(beanFactory)方法中的beanFactory.preInstantiateSingletons()方法；在beanFactory.preInstantiateSingletons()方法中找到getBean()方法，找到getBean()的doGetBean()方法中的if(mbd.isSingleton())判断分支；在判断分支中进入createBean()的doCreateBean()方法，这个方法是真正创建对象的方法；doCreateBean()方法中找到createBeanInstance(beanName, mbd, args)方法，该方法调用了instantiateBean(beanName, mbd)方法；instantiateBean(beanName, mbd)方法中通过调用了策略设计模式的instantiate(mbd, beanName, this)方法，在instantiate()方法中通过反射获取到了对象的构造方法，再通过BeanUtils.instantiateClass(constructorToUse)将对象实例化出来；实例化出对象后，再在doCreateBean()方法中继续调用populateBean(beanName, mbd, instanceWrapper)方法和initializeBean(beanName, exposedObject, mbd)，为对象赋值并实现aware和beanPostProcessor。到这里一个对象基本就创建完成了。