SpringBoot详细分析自动装配原理并实现starter

目录
  • 约定优于配置
  • 自动装配
  • 手写一个starter组件

约定优于配置

SpringBoot的预定优于配置主要体现在以下几个方面:

maven的目录结构:

  • 配置文件默认存放在resources目录下
  • 项目编译后的文件存放在target目录下
  • 项目默认打包成jar格式

配置文件默认为application.ymlapplication.yamlapplication.properties

默认通过 spring.profiles.active 属性来决定运行环境时的配置文件。

自动装配

相对于传统的Spring项目的繁琐配置,SpringBoot项目只需要使用一个@SpringBootApplication注解就可以成功运行,哪有什么岁月静好,只不过是有人在替我们负重前行。让我们来看一看在@SpringBootApplication注解的背后SpringBoot为我们做了哪些事情。

可以看到@SpringBootApplication是一个组合注解,上面四个不用看,因为是定义一个注解必须的,关键在于下面的@SpringBootConfiguration``@EnableAutoConfiguration``@ComponentScan三个注解。也就是说我们不用@SpringBootApplication,使用下这三个注解也可以成功运行一个SpringBoot应用。

@SpringBootConfiguration注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

点进源码可以发现,它实际上就是一个@Configuration注解,@Configuration大家应该都很熟悉了,加上这个注解后当前类就会被Spring所管理 。

@ComponentScan注解

这个注解用于定义Spring的扫描路径,等价于<context:component-scan>,如果没有配置扫描路径,那么SpringBoot会默认扫描当前类的包及其子包中所有标注了需要被管理的类。

@EnableAutoConfiguration

这个注解才是SpringBoot自动装配的关键,这也是一个组合注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
	Class<?>[] exclude() default {};
	String[] excludeName() default {};
}

@AutoConfigurationPackage其实也是一个@Import注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}

@Import注解

@Configuration标注的Class上可以使用@Import引入其它的配置类,其实它还可以引入org.springframework.context.annotation.ImportSelector实现类。ImportSelector接口只定义了一个selectImports(),用于指定需要注册为bean的Class名称。当在@Configuration标注的Class上使用@Import引入了一个ImportSelector实现类后,会把实现类中返回的Class名称都定义为bean。

@EnableAutoConfiguration@Import主要就是为了导入一个AutoConfigurationImportSelector,下面我们分析一下这个类:

AutoConfigurationImportSelector类

AutoConfigurationImportSelect类实现了ImportSelector接口,所以我们清楚只需关注selectImports()方法的返回结果即可:

	@Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
				.loadMetadata(this.beanClassLoader);
		AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
				annotationMetadata);
		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
	}

该方法返回的是要注册到IOC容器中的对象的类型的全路径名称的字符串数组,所以我们要分析一下这个数组是从哪里来的?

进入到getAutoConfigurationEntry方法中:

	protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
			AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return EMPTY_ENTRY;
		}
        // 获取注解的属性信息
		AnnotationAttributes attributes = getAttributes(annotationMetadata);
        // 获取候选配置
		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
		configurations = removeDuplicates(configurations);
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		checkExcludedClasses(configurations, exclusions);
		configurations.removeAll(exclusions);
		configurations = filter(configurations, autoConfigurationMetadata);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}

通过DEBUG可以看到,在getCandidateConfigurations方法中获取到了很多java类全路径

进入getCandidateConfigurations方法,可以看到有一个断言:如果configurations为空的话,会提示No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct(在META-INF/spring.factories中找不到自动配置类。如果您使用的是自定义打包,请确保该文件正确无误)

由此我们可以推测:自动配置的类名数组在META-INF/spring.factories文件中,并且我们可以通过在正确的路径下面添加这个文件来自定义包来适配SpringBoot

	protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
		List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
				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;
	}

进入这个文件可以看到,这里配置了大量的需要自动装配的类,当我们启动Springboot项目的时候,SpringBoot会扫描所有jar包下面的META-INF/spring.factories文件,并根据key进行读取,在经过一系列的操作来完成自动装配。

需要注意的是:上图中的 spring.factories 文件是在 spring-boot-autoconfigure 包下面,这个包记录了官方提供的 stater 中几乎所有需要的自动装配类,所以并不是每一个官方的 starter 下都会有 spring.factories 文件。

@AutoConfigurationPackage注解

@AutoConfigurationPackage注解的主要作用就是将主程序类所在包及所有子包下的组件到扫描到spring容器中。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}

这个注解实际上是导入了AutoConfigurationPackages的一个内部类Registrar,这个类的作用就是读取到最外层@SpringBootApplication注解中配置的扫描路径(没有配置默认当前所在包),将该路径下所有文件扫描,并分析注册bean。

	static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
		@Override
		public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
			register(registry, new PackageImport(metadata).getPackageName());
		}
		@Override
		public Set<Object> determineImports(AnnotationMetadata metadata) {
			return Collections.singleton(new PackageImport(metadata));
		}
	}

手写一个starter组件

上面提到在自己的包中添加META-INF/spring.factories文件就可以适配SpringBoot实现自动配置,这其实是一种SPI的思想。

SPI,Service Provider Interface。即:接口服务的提供者。就是说我们应该面向接口(抽象)编程,而不是面向具体的实现来编程,这样一旦我们需要切换到当前接口的其他实现就无需修改代码。

starter的命名规范:

官方的starter命名格式为spring-boot-starter-{xxx},例如:spring-boot-starter-web

自定义starter命名格式一般为{xxx}-spring-boot-starter,例如mybatis的mybatis-spring-boot-starter

\1) 新建一个springboot项目myself-spring-boot-starter

\2) 新建自己的业务类

public class MyselfService {
    private String myself;
    // ……省略 getter setter
    public String doBusiness(Object obj){
        return myself+obj.toString();
    }
}

3)业务需要的一些属性值

@ConfigurationProperties("myself")
public class MysefProperties {
    private String myself;
    // ……省略 getter setter
}

4)新建自动装配类,把自己的业务交给Spring管理

@Configuration
@EnableConfigurationProperties(MysefProperties.class)
public class MyselfAutoConfiguration {
    @Autowired
    MysefProperties mysefProperties;
    @Bean
    @ConditionalOnMissingBean(MyselfService.class)
    public MyselfService myselfService(){
        MyselfService myselfService = new MyselfService();
        myselfService.setMyself(mysefProperties.getMyself());
        return myselfService;
    }
}

5)在resources/META-INF下新建spring.factories,配置starter中配置类的位置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.yy.autoconfigure.MyselfAutoConfiguration

6)mvn install将自己的包打到自己仓库中,在另外的项目直接引用即可

7)测试

mybatis-plus-boot-starter

我们可以学习一下其他第三方的成熟的starter,会发现其实套路是很相似的

到此这篇关于SpringBoot详细分析自动装配原理并实现starter的文章就介绍到这了,更多相关SpringBoot自动装配原理内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • SpringBoot自动装配原理详解

    首先对于一个SpringBoot工程来说,最明显的标志的就是 @SpringBootApplication它标记了这是一个SpringBoot工程,所以今天的 SpringBoot自动装配原理也就是从它开始说起. 自动装配流程 首先我们来看下@SpringBootApplication 这个注解的背后又有什么玄机呢,我们按下 ctrl + 鼠标左键,轻轻的点一下,此时见证奇迹的时刻.. 我们看到如下优雅的代码: 这其中有两个比较容易引起我们注意的地方,一个是@SpringBootConfigur

  • springboot自动装配原理初识

    运行原理 为了研究,我们正常从父项目的pom.xml开始进行研究. pom.xml 父依赖 spring-boot-starter-parent主要用来管理项目的资源过滤和插件 <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.5.RELEASE<

  • 浅谈springboot自动装配原理

    一.SpringBootApplication @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFi

  • Java Springboot自动装配原理详解

    目录 Debug路线图 让我们从run说起 归属 小结 run 再说说注解 总结 Debug路线图 说多都是泪,大家看图. 让我们从run说起 用了这么多年的的Springboot,这个 run() 方法到底做了些什么事呢? @SpringBootApplication public class SpringbootDemoApplication { public static void main(String[] args) { SpringApplication.run(Springboot

  • SpringBoot自动装配原理小结

    约定优于配置(Convention Over Configuration)是一种软件设计范式,目的在于减少配置的数量或者降低理解难度,从而提升开发效率. 先总结一下结论: springboot通过spring.factories能把main方法所在类路径以外的bean自动加载,其目的就是为了帮助自动配置bean,减轻配置量 springboot autoconfig的一些实验 一个springboot工程,springbootautoconfig.test.config这个包和启动类的包不再同一

  • Java SpringBoot自动装配原理详解及源码注释

    目录 一.pom.xml文件 1.父依赖 2.启动器: 二.主程序: 剖析源码注解: 三.结论: 一.pom.xml文件 1.父依赖 主要是依赖一个父项目,管理项目的资源过滤以及插件! 资源过滤已经配置好了,无需再自己配置 在pom.xml中有个父依赖:spring-boot-dependencies是SpringBoot的版本控制中心! 因为有这些版本仓库,我们在写或者引入一些springboot依赖的时候,不需要指定版本! 2.启动器: 启动器也就是Springboot的启动场景; 比如sp

  • SpringBoot启动及自动装配原理过程详解

    一.servlet2(老spring-mvc) 配置文件: web.xml:主要配置项目启动项 application-context.xml:主要配置项目包扫描.各种bean.事务管理 springMVC.xml:主要配置controller包扫描.视图解析器.参数解析器 启动过程: 每一个spring项目启动时都需要初始化spring-context,对于非web项目可以在程序main方法中触发这个context的初始化过程. 由于web项目的启动入口在容器,所以开发者不能直接触发sprin

  • SpringBoot详细分析自动装配原理并实现starter

    目录 约定优于配置 自动装配 手写一个starter组件 约定优于配置 SpringBoot的预定优于配置主要体现在以下几个方面: maven的目录结构: 配置文件默认存放在resources目录下 项目编译后的文件存放在target目录下 项目默认打包成jar格式 配置文件默认为application.yml或application.yaml或application.properties 默认通过 spring.profiles.active 属性来决定运行环境时的配置文件. 自动装配 相对于

  • 深入了解Java SpringBoot自动装配原理

    目录 自动装配原理 SpringBootApplication EnableAutoConfiguration AutoConfigurationImportSelector 总结 在使用springboot时,很多配置我们都没有做,都是springboot在帮我们完成,这很大一部分归功于springboot自动装配,那springboot的自动装配的原理是怎么实现的呢? 自动装配原理 springboot 版本:2.4.3 SpringBootApplication springboot启动类

  • 最新springboot中必须要了解的自动装配原理

    目录 1.pom.xml 2.启动器 3.主程序 3.1注解 3.2 spring.factories 4. 结论 1.pom.xml 父 依 赖 \textcolor{orange}{父依赖} 父依赖 spring-boot-dependencies:核心依赖都在父工程中 这里ctrl+左键,点击之后我们可以看到父依赖 这个里面主要是管理项目的资源过滤及插件,我们发现他还有一个父依赖 看看下面这个,熟悉吗? 再点进去,我们发现有很多的依赖.这就是SpringBoot的版本控制中心. 这个地方才

  • SpringBoot超详细讲解自动配置原理

    目录 SpringBoot自动配置原理 SpringBoot特点 1.依赖管理 A.父项目做依赖管理 B.开发导入starter场景启动器 C.可以修改默认版本号 2.自动配置 A.自动配好Tomcat B.自动配好SpringMVC C.默认的包结构 D.各种配置拥有默认值 E.按需要加载所有自动配置项 SpringBoot自动配置原理 了解SpringBoot自动配置原理 1.SpringBoot特点 2.容器功能 3.自动配置原理入门 4.开发技巧 SpringBoot特点 1.依赖管理

随机推荐