SpringBoot入门(二)自动配置原理
发布日期:2022-03-04 11:48:24 浏览次数:1 分类:技术文章

本文共 10726 字,大约阅读时间需要 35 分钟。

目录


第四章 自动配置原理入门

//@SpringBootApplication@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan("com.xxy.boot")public class MainApplication {//主程序类}

4.1 引导加载自动配置类

   @SpringBootApplication注解中的核心

@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan(excludeFilters = {@Filter(type = FilterType.CUSTOM,classes = {TypeExcludeFilter.class}),
 @Filter(type = FilterType.CUSTOM,classes = {AutoConfigurationExcludeFilter.class})})public @interface SpringBootApplication {}

4.1.1 @SpringBootConfiguration

   @SpringBootConfiguration注解的实现用到了注解@Configurantion。代表当前是一个配置类

@Configurationpublic @interface SpringBootConfiguration {}

4.1.2 @ComponentScan

   指定扫描哪些路径下的Spring注解。

4.1.3 @EnableAutoConfiguration

@AutoConfigurationPackage@Import({AutoConfigurationImportSelector.class})public @interface EnableAutoConfiguration {}

4.1.3.1 @AutoConfigurationPackage

   指定了默认的包规则。

import org.springframework.boot.autoconfigure.AutoConfigurationPackages.Registrar;@Import({Registrar.class})//给容器中导入一个组件public @interface AutoConfigurationPackage {}//利用Registrar给容器中导入一系列组件//将指定的一个包下的所有组件导入进来,即主程序类MainApplication所在的包下
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
Registrar() {
}
//给容器批量注册组件
//AnnotationMetadata表示注解的源信息,标在哪个类上,在这里就是标来MainApplication这个主程序类上
public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
//第二个参数就是指定了哪些包下的spring注解会被注册,这里写的就是主程序类的包下
AutoConfigurationPackages.register(registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0]));
}
public Set determineImports(AnnotationMetadata metadata) {
return Collections.singleton(new AutoConfigurationPackages.PackageImports(metadata));
}
}

4.1.3.2 @Import(AutoConfigurationImportSelector.class)

public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {
//这个类当中的一个方法
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return NO_IMPORTS;
} else {
AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
}}
protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
} else {
//会导入很多默认组件
AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
//configurations里面包括了那些默认组件
//getCandidateConfigurations获取所有的候选配置
List  configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
configurations = this.removeDuplicates(configurations);
Set  exclusions = this.getExclusions(annotationMetadata, attributes);
this.checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = this.getConfigurationClassFilter().filter(configurations);
this.fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
}}

protected List
   
     getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    
//SpringFactoriesLoader:spring工厂加载器
List  configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
return configurations;
}
public static List
   
     loadFactoryNames(Class
     factoryType, @Nullable ClassLoader classLoader) {
    
String factoryTypeName = factoryType.getName();
return (List)loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
}
//最后得到一个Map
   
    
     >private static Map
     
      
       > loadSpringFactories(@Nullable ClassLoader classLoader) {
       
MultiValueMap  result = (MultiValueMap)cache.get(classLoader);
if (result != null) {
return result;
} else {
try {
Enumeration  urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
LinkedMultiValueMap result = new LinkedMultiValueMap();
while(urls.hasMoreElements()) {
URL url = (URL)urls.nextElement();
UrlResource resource = new UrlResource(url);
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
Iterator var6 = properties.entrySet().iterator();
while(var6.hasNext()) {
Entry  entry = (Entry)var6.next();
String factoryTypeName = ((String)entry.getKey()).trim();
String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
int var10 = var9.length;
for(int var11 = 0; var11 < var10; ++var11) {
String factoryImplementationName = var9[var11];
result.add(factoryTypeName, factoryImplementationName.trim());
}
}
}
cache.put(classLoader, result);
return result;
} catch (IOException var13) {
throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
}
}
}

1、利用getAutoConfigurationEntry(annotationMetadata)方法给容器中批量导入一些组件

2、调用List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类

3、利用工厂加载 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader)方法得到所有的组件

4、从META-INF/spring.factories位置来加载一个文件。

        默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件

        spring-boot-autoconfigure-2.3.4.RELEASE.jar包里面也有META-INF/spring.factories(这个包内就有上面说到的configurations内的127个自动配置类)

        文件里面写死固定了spring-boot一启动就要给容器中加载的所有配置类

4.2 按需开启自动配置项

   虽然我们127个场景的所有自动配置启动的时候默认全部加载。xxxxAutoConfiguration
   按照条件装配规则(@Conditional),最终会按需配置

4.3 实例展示

4.3.1 DispatcherServlet

   比如看这个DispatcherServletAutoConfiguration:

@AutoConfigureOrder(-2147483648)@Configuration(
proxyBeanMethods = false)@ConditionalOnWebApplication(
type = Type.SERVLET)@ConditionalOnClass({DispatcherServlet.class})@AutoConfigureAfter({ServletWebServerFactoryAutoConfiguration.class})public class DispatcherServletAutoConfiguration {
@Configuration(
proxyBeanMethods = false
)
@Conditional({DispatcherServletAutoConfiguration.DefaultDispatcherServletCondition.class})
@ConditionalOnClass({ServletRegistration.class})
@EnableConfigurationProperties({WebMvcProperties.class})
protected static class DispatcherServletConfiguration {
protected DispatcherServletConfiguration() {
}
@Bean(
name = {"dispatcherServlet"}
)
public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
DispatcherServlet dispatcherServlet = new DispatcherServlet();
dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
dispatcherServlet.setThrowExceptionIfNoHandlerFound(webMvcProperties.isThrowExceptionIfNoHandlerFound());
dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
return dispatcherServlet;
}
@Bean
@ConditionalOnBean({MultipartResolver.class})//容器中有这个类型的组件
@ConditionalOnMissingBean(
name = {"multipartResolver"}
)//容器中没有这个名字multipartResolver的组件
public MultipartResolver multipartResolver(MultipartResolver resolver) {//文件上传解析器
//给@Bean标注的方法传入了对象参数,这个参数的值就会从容器中找。
//SpringMVC配置时一定要叫multipartResolver。
//这里条件加上了不叫这个名字,也能找到这个文件上传解析器。防止有些用户配置的文件上传解析器不符合规范
//此时再重新返回,名字又注册为了multipartResolver,因为方法名就是id
// Detect if the user has created a MultipartResolver but named it incorrectly
return resolver;
}
}}

   第一个dispatcherServlet()方法就会在满足条件的情况下在容器中创建出一个DispatcherServlet的实例,并且这个实例的id就是dispatcherServlet。这样我们就不需要像springmvc一样自己在配置文件中手动配置,springboot的底层帮我们配置好了。

   第二个方法的条件针对用户配置的名字可能不符合规范,但是springboot底部能够读到这个对象并返回一个符合规范的id。

4.3.2 CharacterEncodingFilter

   再看看HttpEncodingAutoConfiguration:

@Configuration(
proxyBeanMethods = false)@EnableConfigurationProperties({ServerProperties.class})@ConditionalOnWebApplication(
type = Type.SERVLET)@ConditionalOnClass({CharacterEncodingFilter.class})@ConditionalOnProperty(
prefix = "server.servlet.encoding",
value = {"enabled"},
matchIfMissing = true)public class HttpEncodingAutoConfiguration {
@Bean
@ConditionalOnMissingBean//如果用户没有配置这个bean,springboot底层会自动配置
public CharacterEncodingFilter characterEncodingFilter() {
CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
filter.setEncoding(this.properties.getCharset().name());
filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));
return filter;
}}

   自动配置了字符过滤器CharacterEncodingFilter。

   SpringBoot默认会在底层配好所有的组件。但是如果用户自己配置了以用户的优先

4.4 总结

  • SpringBoot先加载所有的自动配置类 xxxxxAutoConfiguration
  • 每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值。xxxxProperties里面拿,xxxProperties和配置文件进行了绑定
  • 生效的配置类就会给容器中装配很多组件
  • 只要容器中有这些组件,相当于这些功能就有了
  • 定制化配置(修改默认实现)
    • 用户直接自己@Bean替换底层的组件
    • 用户去看这个组件是获取的配置文件什么值就去修改

   整体流程:

xxxxxAutoConfiguration ---> 组件 ---> xxxxProperties里面拿值 ----> application.properties

4.5 SpringBoot开发步骤

  • 引入场景依赖:
  • 查看自动配置了哪些(选做)
    • 自己分析,引入场景对应的自动配置一般都生效了
    • 配置文件application.properties中加入debug=true开启自动配置报告。Negative(不生效)\Positive(生效)
  • 是否需要修改
    • 参照文档修改配置项
      • 自己分析。xxxxProperties绑定了配置文件的哪些。
    • 自定义加入或者替换组件
      • @Bean、@Component...
    • 自定义器 XXXXXCustomizer

第五章 开发小技巧

5.1 Lombok

   简化JavaBean开发。Lombok会自动帮我们在编译时实现get、set方法,不需要手动写了。

   引入依赖:

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
</dependency>

   在IDEA中安装lombok插件。之后直接使用注解即可。

@NoArgsConstructor //无参构造器@AllArgsConstructor //全参构造器@ToString //toString方法@Data //get、set方法不需要手动写了@EqualsAndHashCode //equals方法和hashCode方法@Component@ConfigurationProperties(prefix = "mycar")public class Car {
private String brand;
private Integer price;}

   还可以简化日志开发:

@Slf4j //日志@RestControllerpublic class HelloController {
@RequestMapping("/hello")
public String handle01(@RequestParam("name") String name){
log.info("请求进来了....");
return "Hello, Spring Boot 2!"+"你好:"+name;
}}

5.2 dev-tools

   实现热更新。Restart。

   引入依赖:

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <optional>true</optional>
</dependency>

   项目或者页面修改以后:Ctrl+F9

5.3 Spring Initailizr(项目初始化向导)

5.3.1 选择开发场景

5.3.2 目录形式

5.3.3 自动生成主程序类(主配置类)

5.3.4 根据场景选择自动导入依赖

PS:根据尚硅谷课程整理,如有侵权,联系删除

转载地址:https://blog.csdn.net/xxyneymar/article/details/122533107 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:SpringBoot入门(九)数据访问
下一篇:SpringBoot入门(三)yaml文件和静态资源访问及原理

发表评论

最新留言

很好
[***.36.148.201]2022年07月29日 09时10分22秒

关于作者

    喝酒易醉,品茶养心,人生如梦,品茶悟道,何以解忧?唯有杜康!
-- 愿君每日到此一游!

最新文章

Android手机按键不灵,手机按键不灵怎么办 手机按键修改教程【详细步骤】 2020-01-10 11:49:25
刷php程序,PHP刷CSDN博客脚本 2020-01-10 11:49:25
通信原理及matlab仿真实验指导书,通信原理实验指导书——2015.pdf 2020-01-10 11:49:25
修复win10的更新服务器,win10升级服务器异常怎么解决_win10升级服务器发生异常修复方法... 2020-01-10 11:49:23
ajax session更新,ajax请求session超时时解决办法 2020-01-10 11:49:23
微信免密支付服务器忙,微信免密支付 查询用户授权记录,调起商家预授权 都返回系统繁忙... 2020-01-10 11:49:23
对使用数据源显示信息的web服务器控件,使用数据源控件绑定到数据 2020-01-10 11:49:23
ubuntu系统服务器维护,Ubuntu Server系列各项服务的安装和维护 Apache部分 2020-01-10 11:49:23
软件测试跟踪需求矩阵,测试管理之从需求到跟踪操作实务 2020-01-10 11:49:21
计算机跨专业保研数学,保研生跨专业很容易吗 2020-01-10 11:49:22
大连中考计算机分值,2019大连中考总分多少分及各科目分值设置 2020-01-10 11:49:22
为什么王者荣耀总是服务器中断,王者荣耀有史以来游戏时间最长的对局!服务器多次崩溃!破纪录!... 2020-01-10 11:49:22
css 加载 500错误,express中加载css和js时候出现500错误 2020-01-10 11:49:22
mysql where排除,MySQL'WHERE'子句排除子查询中的结果 2020-01-10 11:49:20
启动计算机管理服务,是哪一个启动项控制了计算机管理--服务下的wireless zero configuration无法开机自行启动!如何解决,为盼... 2020-01-10 11:49:21
java voidfunction,使用`std :: function&lt; void(...)&gt;`来调用非void函数 2020-01-10 11:49:21
冯偌依曼计算机的基本原理是,03级计算机专业《计算机组成原理》试卷A 2020-01-10 11:49:21
python中search,django python中的search_fields 2020-01-10 11:49:21
restclient发送json,如何使用javax.ws.rs.client.WebTarget从REST客户端发送json对象 2020-01-10 11:49:21
java eclipse6.6,使用Eclipse编译java 7 for java 6 2020-01-10 11:49:21