文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringBoot2入门自动配置原理源码分析

2023-06-30 17:01

关注

这篇文章主要介绍“SpringBoot2入门自动配置原理源码分析”,在日常操作中,相信很多人在SpringBoot2入门自动配置原理源码分析问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”SpringBoot2入门自动配置原理源码分析”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

SpringBoot自动配置

之前为什么会去了解一些底层注解,其实就是为了后续更好的了解 springboot 底层的一些原理,比如自动配置原理。

一、@SpringBootApplication

从 MainApplication 中的@SpringBootApplication开始。

SpringBoot2入门自动配置原理源码分析

进入@SpringBootApplication,可以看到这是一个合成注解(红框中是要关注的)。

SpringBoot2入门自动配置原理源码分析

1. @SpringBootConfiguration

这个注解干嘛的?

直接点进去,发现有一个@Configuration注解,那这不就是个配置类嘛。

SpringBoot2入门自动配置原理源码分析

进而也说明了,MainApplication 也是一个配置类。

2. @ComponentScan

这个已经很熟悉了,可以指定扫描哪些 Spring 注解。

只不过这里,加了一些其他的过滤条件,暂时不关注。

3. @EnableAutoConfiguration

这个是最重要的注解了,听名字就不一般,开启自动配置。

点进去,发现也是一个合成注解(红框需要关注)。

SpringBoot2入门自动配置原理源码分析

(1)@AutoConfigurationPackage

听名字像是自动配置包?依旧点进去。

SpringBoot2入门自动配置原理源码分析

可以看到原来是导入了一个叫Registrar的组件,继续点进 Registrar

SpringBoot2入门自动配置原理源码分析

这里是利用Registrar()给容器中导入一系列组件,也就是批量注册组件

在这里打个断点,debug 启动一下。

SpringBoot2入门自动配置原理源码分析

registerBeanDefinitions()方法中有个传参:

metadata,是注解的元信息,可以看到这个注解是被标注在com.pingguo.boot.MainApplication

而在registerBeanDefinitions()方法体内,new 了一个AutoConfigurationPackages.PackageImports(),里面传入的是元注解,通过getPackageNames()获取到包名。

AutoConfigurationPackages.register(    registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0]));

在 idea 中可以单独执行下片段代码(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames()

SpringBoot2入门自动配置原理源码分析

选中右击,再点击 Evaluate。

SpringBoot2入门自动配置原理源码分析

得到的结果就是com.pingguo.boot。为什么是这个?因为注解标注在MainApplication类,而这个类就属于com.pingguo.boot

拿到包名之后,封装到数组里,也就是上述代码片段中的toArray(new String[0]),最后注册进去。

所以,这里的Registrar()就是把指定的包下的所有组件批量注册到容器中。

(2)@Import(AutoConfigurationImportSelector.class)

上面指定好默认包规则之后,就需要去导入需要的包了,利用的是AutoConfigurationImportSelector,继续点进去看。

SpringBoot2入门自动配置原理源码分析

这里有个selectImports方法,这个方法决定了要具体导入哪些,返回的是一个数组。

方法体内,又是调用了getAutoConfigurationEntry()方法来获取配置入口,进而再通过getConfigurations()方法获取具体配置,最终转成数组返回。

显然getAutoConfigurationEntry()是个重点。

往下翻一点,就是getAutoConfigurationEntry()的实现,在这里打个断点(把上面的断点取消掉)。

SpringBoot2入门自动配置原理源码分析

debug重新运行一下,往下走到getCandidateConfigurations()

SpringBoot2入门自动配置原理源码分析

这里是获取所有候选配置,目前可以看到这里是共有 127 个。

SpringBoot2入门自动配置原理源码分析

为什么是这 127 个?其实是在配置文件里写死了,在 springboot 启动时候,给容器加载的所有场景的配置类。

定义的位置是在这:\spring-boot-autoconfigure\2.3.4.RELEASE\spring-boot-autoconfigure-2.3.4.RELEASE.jar!\META-INF\spring.factories

SpringBoot2入门自动配置原理源码分析

虽然这些一股脑的在启动时候会去加载到容器,但是最终会按需开启配置。

SpringBoot2入门自动配置原理源码分析

比如点开aop,看到@ConditionalOnClass({Advice.class})这个条件,是当存在Advice类时候才导入组件,但实际上这里并没有Advice

这就是基于 springboot 的按条件装配@Conditional,根据规则最终实现按需装配。

二、自动配置示例

分别用最终未生效、和生效的自动配置来加深理解。

1. 未生效的自动配置

比如 cache。

SpringBoot2入门自动配置原理源码分析

可以看到CacheAutoConfiguration上是加了几个条件装配的。

SpringBoot2入门自动配置原理源码分析

(1)@ConditionalOnClass({CacheManager.class})

在 idea 中使用ctrl+N搜索一下CacheManager,发现是存在的,那么这个条件满足。

SpringBoot2入门自动配置原理源码分析

(2)@ConditionalOnBean({CacheAspectSupport.class})

这个条件是要求容器中存在CacheAspectSupport这个组件才可以。

现在来判断一下是否存在这个组件,在 main 方法里增加测试代码:

... ...      String[] beanNamesForType = run.getBeanNamesForType(CacheAspectSupport.class);      System.out.println("==CacheAspectSupport类型组件的数量==" + beanNamesForType.length);... ...

运行查看输出。

SpringBoot2入门自动配置原理源码分析

发现数量等于 0,也就是不存在该类型的组件。

也就是说@ConditionalOnBean({CacheAspectSupport.class})这个条件不满足,所以整个类CacheAutoConfiguration里的配置都不生效。

2. 生效的自动配置

之前写过 web 的demo,那么 web 相关的配置自然是生效的,找到它。

SpringBoot2入门自动配置原理源码分析

这里有不少后缀是**AutoConfiguration的配置,直接来看DispatcherServletAutoConfiguration

SpringBoot2入门自动配置原理源码分析

@Configuration(proxyBeanMethods = false):表示是一个配置类。

@ConditionalOnWebApplication(type = Type.SERVLET):条件是否为一个 web 应用,而且是原生 SERVLET 类型的(因为springboot2还有webflux),当前满足条件。

@ConditionalOnClass({DispatcherServlet.class}):条件是否导入了DispatcherServlet类,这里也是有的。

SpringBoot2入门自动配置原理源码分析

还有 2 个注解直接没见过,这里不用太多关注,了解一下:

@AutoConfigureOrder:这个配置类的配置优先级顺序。@AutoConfigureAfter:表示在xx之后才配置这个类,这里就是在配置完ServletWebServerFactoryAutoConfiguration.class后,再配置当前的类。

所以,类上的几个条件都是满足的,就可以进一步到类中了,继续往下找:

SpringBoot2入门自动配置原理源码分析

看到DispatcherServletConfiguration类上也有条件:

@Conditional({DispatcherServletAutoConfiguration.DefaultDispatcherServletCondition.class}):

别看这么长,其实就是上面的一个类

@ConditionalOnClass({ServletRegistration.class}): 这个也存在。

SpringBoot2入门自动配置原理源码分析

@EnableConfigurationProperties({WebMvcProperties.class}):

这个很熟悉了,使用前面刚学习完不久,它并不是条件装配,而是用来绑定外部配置文件的,点进去。

SpringBoot2入门自动配置原理源码分析

可以看到,会与配置文件中前缀是spring.mvc的所有属性进行绑定。

另外,还可以自动把组件注册到容器中去。

这里可以试一下,在 main 方法里增加输出:

String[] beanNamesForType1 = run.getBeanNamesForType(WebMvcProperties.class);    System.out.println("==WebMvcProperties类型组件的数量==" + beanNamesForType1.length);

运行一下,果然是有一个:

SpringBoot2入门自动配置原理源码分析

到此,说明DispatcherServletConfiguration这个配置类也是生效的。

继续往下就看到方法dispatcherServlet(),而且是加了@Bean注解,就是给容器中注册DispatcherServlet类型的组件。

SpringBoot2入门自动配置原理源码分析

这里的经过是:

new 一个DispatcherServlet()对象dispatcherServlet。接着对dispatcherServlet一通 set 设置。最后返回这个对象dispatcherServlet

在之前学习 springMVC 时候,还要手动去设置关于DispatcherServlet的一堆东西。而在 springboot 里已经在底层设置好了,并且注册到容器中去了,所以我们能直接使用。

到此,关于“SpringBoot2入门自动配置原理源码分析”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注编程网网站,小编会继续努力为大家带来更多实用的文章!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯