IOC与DI
IOC:inversion of control 控制反转,就是把原来代码需要实现的对象创建,依赖。反转交予容器来帮忙实现,我们需要一种描述来让容器知道要创建的对象与对象的关系。
DI:dependency injection 依赖注入,就是指被动接受依赖类而不自己主动去找,换句话说对象不用去容器查找他依赖的类,而是容器实例化后将其依赖主动注入进去。
Spring核心容器类图
BeanFactory:作为Spring最顶级接口之一,定义了IOC容器的基本功能规范。
ListableBeanFactory:枚举bean的实例,可列表话。
HierarchicalBeanFactory:使容器具有继承关系。
AutowrieCapableBeanFactory:使容器可以自动装配。
ConfigurableBeanFactory:使得容器具备配置能力,比如:类加载,类型转化,属性编辑器作用域等等,
实现类:
DefaultListableFactory:使Spring加载核心部分,实现了众多的接口,为提供了各种功能。而其子类XmlBeanFactory主要用于从XML文档中读取BeanDefinition,对于注册和获取bean都是从父类DefaultListableFactory继承的方法实现,维度与父类不同的是实现了XmlBeanDefinitionReader类的reader属性。使用reader属性对资源文件进行读取和注册。
比如:
- AliasRegistry:定义对alias的简但增删改等操作。
- SimpleAliasRegistry:主要使用map作为alias的缓存,并对接口AliasRegistry进行实现。
- SingletonBeanRegistry:定义对bean的注册及获取。
- BeanFactory:定义获取bean及bean的各种属性。
- HierarchicalBeanFactory:继承BeanFactory,也就是BeanFactory定义的功能基础上增加了对pa'renFactory的支持。
- DefaultSingletonBeanRegistry:对接口SingletonBeanRegistry各种函数的实现。
- BeanDefinitionRegistry:定义对BeanDefintiion的各种增删改。
- FactoryBeanRegistrySupport:在DefaultSingletonBeanRegistry基础上增加了FactoryBean的特殊处理功能。
- ConfigurableBeanFactory:提供了Factory的个中方法。
- ListableBeanFactory: 根据各种条件获取 bean 的配直清单 。
- AbstractBeanFactory: 综合 FactoryBeanRegistrySupport 和 ConfigurableBeanFactory 的 功能。
- AutowireCapableBeanFactory: 提供创 建 bean、自动注入、初始化以及应用 bean 的后 处理器 。
- AbstractAutowireCapableBeanFactory: 综合 AbstractBeanFactory 并对接口 Autowire、 Capable、 BeanFactory进行实现。
- ConfigurableListableBeanFactory: Beanfactory配直清单,指定忽略类型及接口等。
- DefaultListableBeanFactory: 综合上面所有功能, 主要是对 bean 注册后的处理。
XmlBeanDefionitionReader:xml配置读取是spring重要功能,同时也实现了很多接口提供了很多对资源文件读取,解析,注册等功能。通过继承AbstrctBeanDefinitionReader中的方法,来使用ResourceLoader将资源文件路径转为对应的Resource文件,通过DocumentLoader对Resource文件进行转换为Document文件,通过实现BeanDefinitionDocumentReader接口类对Document进行解析,使用BenaDefinitionParserDelegate对Element进行解析。
- ResourceLoader: 定义资源加载器,主要应用于根据给定的资源文件地址返回对应的 Resource。
- BeanDefinitionReader: 主要定义资源文件读取并转换为 BeanDefinition 的各个功能 。
- EnvironmentCapable: 定义获取 Environment 方法 。
- DocumentLoader: 定义从资源、文件加载到转换为 Document 的功能 。
- AbstractBeanDefinitionReader:对 EnvironmentCapable、 BeanDefinitionReader 类定义的功能进行实现 。
- BeanDefinitionDocumentReader :定义读取 Docuemnt 并注册 BeanDefinition 功能。
- BeanDefinitionParserDelegate:定义解析 Element 的各种方法 。
Resource:是对资源的抽象,每个实现类都代表了一种资源访问策列。
ResourceLoader:对资源加载,主要应用于根据给定的资源文件地址,返回对应的Resource。
BeanDefintion:主要用来描述Spring中的Bean对象。
BeanDefinitionReader:主要用来读取Spring配置文件的内容将其转为容器内部的数据结构BeanDefinition。
有了这些类的大概作用讲述方便下一步阅读源码。
web IOC容器的开始
1,从最熟系的DespatcherServlet开始,这个类存在一个init()但是这个方法有父类HttpServlet中进行实现的。
/**
init()初始话发方法
*/
@Override
public final void init() throws ServletException {
PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
if (!pvs.isEmpty()) {
try {
// 定位资源
BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
// 加载配置信息:web.xml
ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
initBeanWrapper(bw);
bw.setPropertyValues(pvs, true);
}
catch (BeansException ex) {
if (logger.isErrorEnabled()) {
logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
}
throw ex;
}
}
// 真正完成初始化容器动作的代码 由子类FrameworkServlet进行实现
initServletBean();
}
// FrameworkServlet.java
@Override
protected final void initServletBean() throws ServletException {
getServletContext().log("Initializing Spring " + getClass().getSimpleName() + " '" + getServletName() + "'");
if (logger.isInfoEnabled()) {
logger.info("Initializing Servlet '" + getServletName() + "'");
}
long startTime = System.currentTimeMillis();
try {
// 初始话并发布这个WebApplicationContext方法
this.webApplicationContext = initWebApplicationContext();
initFrameworkServlet();
}
catch (ServletException | RuntimeException ex) {
logger.error("Context initialization failed", ex);
throw ex;
}
if (logger.isDebugEnabled()) {
String value = this.enableLoggingRequestDetails ?
"shown which may lead to unsafe logging of potentially sensitive data" :
"masked to prevent unsafe logging of potentially sensitive data";
logger.debug("enableLoggingRequestDetails='" + this.enableLoggingRequestDetails +
"': request parameters and headers will be " + value);
}
if (logger.isInfoEnabled()) {
logger.info("Completed initialization in " + (System.currentTimeMillis() - startTime) + " ms");
}
}
protected WebApplicationContext initWebApplicationContext() {
// 先从ServletContext中获取父容器WebApplication
WebApplicationContext rootContext =
WebApplicationContextUtils.getWebApplicationContext(getServletContext());
// 声明子容器
WebApplicationContext wac = null;
if (this.webApplicationContext != null) {
wac = this.webApplicationContext;
if (wac instanceof ConfigurableWebApplicationContext cwac && !cwac.isActive()) {
if (cwac.getParent() == null) {
cwac.setParent(rootContext);
}
// 该方法调用了refresh(),这是一个启动IOC容器的入口
configureAndRefreshWebApplicationContext(cwac);
}
}
// ServletContext中查找web容器的应用是否存在,并创建好默认空的IOC容器
if (wac == null) {
wac = findWebApplicationContext();
}
if (wac == null) {
// 为上一步创建好的ioc容器进行赋值,实例化容器
wac = createWebApplicationContext(rootContext);
}
if (!this.refreshEventReceived) {
synchronized (this.onRefreshMonitor) {
// 由子类DispatcherServlet进行实现使得各种组件可以进行初始化
onRefresh(wac);
}
}
if (this.publishContext) {
// Publish the context as a servlet context attribute.
String attrName = getServletContextAttributeName();
getServletContext().setAttribute(attrName, wac);
}
return wac;
}
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac) {
if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
if (this.contextId != null) {
wac.setId(this.contextId);
}
else {
// Generate default id...
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
ObjectUtils.getDisplayString(getServletContext().getContextPath()) + '/' + getServletName());
}
}
wac.setServletContext(getServletContext());
//为web应用设置ServletCofnig
wac.setServletConfig(getServletConfig());
//设置命名空间
wac.setNamespace(getNamespace());
wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()));
ConfigurableEnvironment env = wac.getEnvironment();
if (env instanceof ConfigurableWebEnvironment cwe) {
cwe.initPropertySources(getServletContext(), getServletConfig());
}
postProcessWebApplicationContext(wac);
applyInitializers(wac);
// ioc容器真正的加载入口
wac.refresh();
}
@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
StartupStep contextRefresh = this.applicationStartup.start("spring.context.refresh");
//1 调用容器准备刷新的方法,获取容器当前时间设置同步标识
prepareRefresh();
// 2 告诉子类自动refreshBeanFactory()方法,bean定义资源文件从此入口进行加载。
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// 3 为beanFactory配置容器特性 比如:类加载,事件处理器等等。
prepareBeanFactory(beanFactory);
try {
// 4 为容器的某些子类指定特殊的Post事件处理器
postProcessBeanFactory(beanFactory);
StartupStep beanPostProcess = this.applicationStartup.start("spring.context.beans.post-process");
// 5 调用所有注册beanFactoryPostProccessor的bean
invokeBeanFactoryPostProcessors(beanFactory);
// 6 为beanFacotry注册Post事件处理器
registerBeanPostProcessors(beanFactory);
beanPostProcess.end();
// 7 初始化信息源和国际化相关
initMessageSource();
// 8 初始化容器的事件传播器
initApplicationEventMulticaster();
// 9 调用子类某些特殊bean的初始化方法
onRefresh();
// 10 为事件传播器注册事件监听器
registerListeners();
// 11 初始化所有剩余的到哪里bean
finishBeanFactoryInitialization(beanFactory);
// 12 初始化容器生命周期事件处理器发布生命周期事件
finishRefresh();}catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// 13 销毁创建的bean
destroyBeans();
// 14 取消刷新操作重置容器同步表示
cancelRefresh(ex);
throw ex;
}
finally {
// 15 重设公共缓存
resetCommonCaches();
contextRefresh.end();
}
}
}
refresh()方法是初始话的核心方法,由AbstractApplicationContext实现。为IOC容器管理Bean的生命周期提供有力条件,也会确保Spring使用一个全新的容器。
2,bean资源文件加载过程
流程图:
3,核心代码处截图:
//创建了IOC容器
@Override
protected final void refreshBeanFactory() throws BeansException {
// 判断容器是否存在,存在先销毁在关闭
if (hasBeanFactory()) {
// 先销毁
destroyBeans();
// 在关闭
closeBeanFactory();
}
try {
// 创建IOC容器:DefaultListableBeanFactory
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
// 对IOC容器进行定制化,如设置启动参数,开启注解的自动装配等等。
customizeBeanFactory(beanFactory);
// 调用载入bean定义的方法,这里使用了委派模式
loadBeanDefinitions(beanFactory);
this.beanFactory = beanFactory;
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
// 创建了一个Spring默认的容器实现类:DefaultListableBeanFactory
protected DefaultListableBeanFactory createBeanFactory() {
return new DefaultListableBeanFactory(getInternalParentBeanFactory());
}
/**
* 从指定位置加载bean的定义
* 这个bean定义的ResourceLoader是一个ResourcePatternResolver
*/
public int loadBeanDefinitions(String location, @Nullable Set<Resource> actualResources) throws BeanDefinitionStoreException {
// 获取在ioc容器初始化过程中设置的资源加载器
ResourceLoader resourceLoader = getResourceLoader();
if (resourceLoader == null) {
throw new BeanDefinitionStoreException(
"Cannot load bean definitions from location [" + location + "]: no ResourceLoader available");
}
if (resourceLoader instanceof ResourcePatternResolver resourcePatternResolver) {
try {
// Resource封装了多个配置文件的bean信息
// 返回加载多个指定位置bean的配置信息
//getResources()由AbstractApplicationContext实现
Resource[] resources = resourcePatternResolver.getResources(location);
// 委派调用其子类XmlbeanDefinitionReader方法实现加载功能
int count = loadBeanDefinitions(resources);
if (actualResources != null) {
Collections.addAll(actualResources, resources);
}
if (logger.isTraceEnabled()) {
logger.trace("Loaded " + count + " bean definitions from location pattern [" + location + "]");
}
return count;
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"Could not resolve bean definition resource pattern [" + location + "]", ex);
}
}
else {
// 将指定位置的bean配置信息解析为Springioc 容器封装的资源
// 加载指定位置bean的配置信息实际调用的是ApplicationContext的父类DefaultResourceLoader()的getResource();
Resource resource = resourceLoader.getResource(location);
// 委派调用其子类XmlBeanDefinitionReader方法实现加载功能
int count = loadBeanDefinitions(resource);
if (actualResources != null) {
actualResources.add(resource);
}
if (logger.isTraceEnabled()) {
logger.trace("Loaded " + count + " bean definitions from location [" + location + "]");
}
return count;
}
}
// DefaultDefinition.getResrouce();
@Override
public Resource getResource(String location) {
Assert.notNull(location, "Location must not be null");
for (ProtocolResolver protocolResolver : getProtocolResolvers()) {
Resource resource = protocolResolver.resolve(location, this);
if (resource != null) {
return resource;
}
}
// 如果是类路径的方式,使用后ClassPathResource来得到Bean文件的资源对象
if (location.startsWith("/")) {
return getResourceByPath(location);
}
else if (location.startsWith(CLASSPATH_URL_PREFIX)) {
return new ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader());
}
else {
try {
// 如果是URL方式,使用UrlResource作为bean文件资源对象
URL url = ResourceUtils.toURL(location);
return (ResourceUtils.isFileURL(url) ? new FileUrlResource(url) : new UrlResource(url));
}
catch (MalformedURLException ex) {
// 不是classpath标识又不是url标识的Resource定位,则使用容器本身的方法去获取
// defaultResourceLoader提供了此方法的实现就是为了处理上面这种情况。
return getResourceByPath(location);
}
}
}
// 加载bean资源文件的过程
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
// 将XML文件转为Document对象,解析过程又docuemntLoader()来进行完成
Document doc = doLoadDocument(inputSource, resource);
// 这里启动了对bean定义的解释的详细过程,该解析过程会用到Springbean配置规则
//registerBeanDefinitions方法启动Spring IoC容器对Bean定义的解析过程
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
//
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
/**
* 按照Spring的Bean语义要求将Bean配置信息解析并转换为容器内部数据接口,
* 解析过程:
* XML解析器将bean配置信息转换为文档对象但这些文档对象没有按照SpringBean规则进行解析
* 在完成通用的解析后按照SpringBean定义的规则对文档进行解析,解析过程在接口BeanDefinitionDocumentReader
* 的实现类DefaultBeanDefinitionDoucmentReader.registerBeanDefinitions中实现。
*/
// 得到BeanDefinitionDocumentReader来对XML格式的BeanDefintioon进行解析
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
// 获得容器中注册的bean数量
int countBefore = getRegistry().getBeanDefinitionCount();
// 解析过程入口,这里使用了委派模式BeanDefinitionDocumentReader完成。
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
// 统计解析的Bean数量
return getRegistry().getBeanDefinitionCount() - countBefore;
}
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
// 具体的解析过程由BeanDefinitionParaseDelegate实现
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
// We cannot use Profiles.of(...) since profile expressions are not supported
// in XML config. See SPR-12458 for details.
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isDebugEnabled()) {
logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
// 解析Bean定义之前进行自定义解析,增强解析的可扩展性
preProcessXml(root);
// 从文档的根元素开始进行bean定义的文档对象解析
parseBeanDefinitions(root, this.delegate);
// 在解析Bean定义之后,进行自定义解析,增强解析过程的可扩展性
postProcessXml(root);
this.delegate = parent;
}
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
// bean定义的文档对象使用Spring默认的XML命名空间
if (delegate.isDefaultNamespace(root)) {
// 获取bean定义的文档对象根元素的所有子节点
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
// 获得文档节点从XML元素节点
if (node instanceof Element ele) {
// bean定义的文档元素节点使用的是Spring默认的XML命名空间
if (delegate.isDefaultNamespace(ele)) {
// 使用Spring的bean规则解析元素节点
parseDefaultElement(ele, delegate);
}
else {
// 如果没有spring默认的命名空间使用自定义的规则解析节点
delegate.parseCustomElement(ele);
}
}
}
}
else {
// 文档的根节点没有使用Spring默认的命名空间
// 使用自定义的解析规则解析文档的根节点
delegate.parseCustomElement(root);
}
}
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
// 如果节点是<import>导入元素,进行导入解析
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
// 如果节点是<alias>别名进行别名解析
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
//如果是普通的Bean元素则按照Spring的Bean规则解析元素
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
/**
* 解析Bean资源文档对象的普通元素
*/
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// 像容器IOC注册解析得到的Bean定义,这是Bean定义向IOC容器注册的入口
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// 定义bean之后发送注册事件
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
@Nullable
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
// 获取<bean>元素中的id属性值
String id = ele.getAttribute(ID_ATTRIBUTE);
// 获取<bean>元素中name属性值
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
// 获取到bean元素中alias属性值
List<String> aliases = new ArrayList<>();
// 将bean元素中的所有name属性值存放到别名中
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
// 如果bean元素中没有配置id属性,将别名中的第一个值赋给beanName
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
// 检查bean元素所配置的id或者name的唯一性
// containingBean标识bean元素中是否包含子bean元素这
// containingBean = null
if (containingBean == null) {
// 检查bean元素所配置的id,name或者别名是否重复
checkNameUniqueness(beanName, aliases, ele);
}
// 详细对bean元素中配置的bean定义进行解析
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
// 如果bean元素中没有配置id 别名 name且没有包含子元素
// bean元素,则解析的bean生成一个唯一的beanName并注册
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
// 如果bean元素中没有配置id,别名或者name且了子元素
// bean元素,则将解析bean使用别名向ioc容器注册
beanName = this.readerContext.generateBeanName(beanDefinition);
//如果可能的话,为普通bean类名注册一个别名,为了向后兼容
//这是Spring 1.2/2.0给别名类添加类名后缀
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isTraceEnabled()) {
logger.trace("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}
catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
// 解析出错返回null
return null;
}
//Bean的注册过程
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// 获取解析BeanDefinition的名称
String beanName = definitionHolder.getBeanName();
// 向SpringIOC容器注册BeanDefinition
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// 如果解析的BeanDefinition有别名向Springioc容器注册别名
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
以上就是IOC容器创建过程,资源加载方式,资源读取过程,bean解析过程与bean注册等过程,但是这些都只是完成了IOC容器的初始化过程,还没有开始进行依赖注入的操作!但这只是配置IOC初始化的过程还有基于注解的初始化过程。