SpringBoot的starter到底是什么？

admin 2024-11-15 16:23:4910 127

前言

我们都知道，Spring的功能非常强大，但也有些弊端。比如：我们需要手动去配置大量的参数，没有默认值，需要我们管理大量的jar包和它们的依赖。

为了提升Spring项目的开发效率，简化一些配置，Spring官方引入了SpringBoot。

当然，引入SpringBoot还有其他原因，在这里就不过多描述了。

本文重点跟大家一起聊聊SpringBoot的starter机制，因为它太重要了。

1为什么要用starter？

在SpringBoot还没有出来之前，我们使用Spring开发项目。如果程序需要连接数据库，我们一般会使用Hibernate或Mybatis等ORM框架，这里我以Mybatis为例，具体的操作步骤如下：

到maven仓库去找需要引入的mybatisjar包，选取合适的版本。

到maven仓库去找mybatis-spring整合的jar包，选取合适的版本。

在spring的文件中配置dataSource和mybatis相关信息。

当然有些朋友可能会指正，不是还需要引入数据库驱动包吗？

确实需要引入，但数据库驱动有很多，比如：mysql、oracle、sqlserver，这不属于mybatis的范畴，使用者可以根据项目的实际情况单独引入。

如果程序只是需要连接数据库这一个功能还好，按上面的步骤做基本可以满足需求。但是，连接数据库可能只是庞大的项目体系中一个环节，实际项目中往往更复杂，需要引入更多的功能，比如：连接redis、连接mongodb、使用rocketmq、使用excel功能等等。

引入这些功能的话，需要再把上面的步骤再重复一次，工作量无形当中增加了不少，而且有很多重复的工作。

另外，还是有个问题，每次到要到maven中找合适的版本，如果哪次找的包和包版本不兼容，程序不是会出现问题？

SpringBoot为了解决以上两个问题引入了starter机制。

2starter有哪些要素？

我们首先一起看看是如何定义的。

可以看到它的META-INF目录下只包含了：

配置maven所需的项目version、groupId和artifactId。

配置所依赖的jar包。

这个文件描述了该Jar文件的很多信息。

配置所依赖的artifactId，给IDE使用的，没有其他的作用。

注意一下，没有一行代码。

我们重点看一下，因为这个jar包里面除了这个没有啥重要的信息

?xmlversion="1.0"encoding="UTF-8"?projectxmlns=""xmlns:xsi=""xsi:schemaLocation=""//groupIdartifactIdmybatis-spring-boot//version/parentartifactIdmybatis-spring-boot-starter/artifactIdnamemybatis-spring-boot-starter//groupIdartifactIdspring-boot-starter/artifactId//groupIdartifactIdspring-boot-starter-jdbc/artifactId//groupIdartifactIdmybatis-spring-boot-autoconfigure/artifactId//groupIdartifactIdmybatis/artifactId//groupIdartifactIdmybatis-spring/artifactId/depency/depencies/project

从上面可以看出，文件中会引入一些jar包，其中除了引入spring-boot-starter，之外重点看一下：mybatis-spring-boot-autoconfigure。

我们找到文件，打开这个文件。

里面包含如下文件：

配置maven所需的项目version、groupId和artifactId

配置所依赖的jar包

手动添加IDE提示功能

这个文件描述了该Jar文件的很多信息

会读取的文件

系统自动生成的IDE提示功能

ConfigurationCustomizer自定义Configuration回调接口

MybatisAutoConfigurationmybatis配置类

MybatisPropertiesmybatis属性类

SpringBootVFS扫描嵌套的jar包中的类

和的功能差不多，我们在文件中输入spring时，会自动出现下面的配置信息可供选择，就是这个功能了。

来自灵魂的一问：这两个文件有什么区别?

答：如果中引入了spring-boot-configuration-processor包，则会自动生成。

如果需要手动修改里面的元数据，则可以在中编辑，最终两个文件中的元数据会合并到一起。

MybatisProperties类是属性实体类：

@ConfigurationProperties(prefix=_PREFIX)publicclassMybatisProperties{publicstaticfinalStringMYBATIS_PREFIX="mybatis";privateStringconfigLocation;privateString[]mapperLocations;privateStringtypeAliasesPackage;privateStringtypeHandlersPackage;privatebooleancheckConfigLocation=false;privateExecutorTypeexecutorType;privatePropertiesconfigurationProperties;@NestedConfigurationPropertyprivateConfigurationconfiguration;publicStringgetConfigLocation(){;}publicvoidsetConfigLocation(StringconfigLocation){=configLocation;}@DeprecatedpublicStringgetConfig(){;}@DeprecatedpublicvoidsetConfig(Stringconfig){=config;}publicString[]getMapperLocations(){;}publicvoidsetMapperLocations(String[]mapperLocations){=mapperLocations;}publicStringgetTypeHandlersPackage(){;}publicvoidsetTypeHandlersPackage(StringtypeHandlersPackage){=typeHandlersPackage;}publicStringgetTypeAliasesPackage(){;}publicvoidsetTypeAliasesPackage(StringtypeAliasesPackage){=typeAliasesPackage;}publicbooleanisCheckConfigLocation(){;}publicvoidsetCheckConfigLocation(booleancheckConfigLocation){=checkConfigLocation;}publicExecutorTypegetExecutorType(){;}publicvoidsetExecutorType(ExecutorTypeexecutorType){=executorType;}publicPropertiesgetConfigurationProperties(){returnconfigurationProperties;}publicvoidsetConfigurationProperties(PropertiesconfigurationProperties){=configurationProperties;}publicConfigurationgetConfiguration(){returnconfiguration;}publicvoidsetConfiguration(Configurationconfiguration){=configuration;}publicResource[]resolveMapperLocations(){ResourcePatternResolverresourceResolver=newPathMatchingResourcePatternResolver();ListResourceresources=newArrayListResource();if(!=null){for(StringmapperLocation:){try{Resource[]mappers=(mapperLocation);((mappers));}catch(IOExceptione){//ignore}}}(newResource[()]);}}

可以看到Mybatis初始化所需要的很多属性都在这里，相当于一个JavaBean。

下面重点看一下MybatisAutoConfiguration的代码：

@@ConditionalOnClass({,})@ConditionalOnBean()@EnableConfigurationProperties()@AutoConfigureAfter()publicclassMybatisAutoConfiguration{privatestaticfinalLoggerlogger=();privatefinalMybatisPropertiesproperties;privatefinalInterceptor[]interceptors;privatefinalResourceLoaderresourceLoader;privatefinalDatabaseIdProviderdatabaseIdProvider;privatefinalListConfigurationCustomizerconfigurationCustomizers;publicMybatisAutoConfiguration(MybatisPropertiesproperties,ObjectProviderInterceptor[]interceptorsProvider,ResourceLoaderresourceLoader,ObjectProviderDatabaseIdProviderdatabaseIdProvider,ObjectProviderListConfigurationCustomizerconfigurationCustomizersProvider){=properties;=();=resourceLoader;=();=();}@PostConstructpublicvoidcheckConfigFileExists(){if(()(())){Resourceresource=(());((),"Cannotfindconfiglocation:"+resource+"(pleaseaddconfigfileorcheckyourMybatisconfiguration)");}}@Bean@ConditionalOnMissingBeanpublicSqlSessionFactorysqlSessionFactory(DataSourcedataSource)throwsException{SqlSessionFactoryBeanfactory=newSqlSessionFactoryBean();(dataSource);();if((())){((()));}Configurationconfiguration=();if(configuration==null!(())){configuration=newConfiguration();}if(configuration!=null!()){for(ConfigurationCustomizercustomizer:){(configuration);}}(configuration);if(()!=null){(());}if(!()){();}if(!=null){();}if((())){(());}if((())){(());}if(!(())){(());}();}@Bean@ConditionalOnMissingBeanpublicSqlSessionTemplatesqlSessionTemplate(SqlSessionFactorysqlSessionFactory){ExecutorTypeexecutorType=();if(executorType!=null){returnnewSqlSessionTemplate(sqlSessionFactory,executorType);}else{returnnewSqlSessionTemplate(sqlSessionFactory);}}publicstaticclassAutoConfiguredMapperScannerRegistrarimplementsBeanFactoryAware,ImportBeanDefinitionRegistrar,ResourceLoaderAware{privateBeanFactorybeanFactory;privateResourceLoaderresourceLoader;@OverridepublicvoidregisterBeanDefinitions(AnnotationMetadataimportingClassMetadata,BeanDefinitionRegistryregistry){ClassPathMapperScannerscanner=newClassPathMapperScanner(registry);try{if(!=null){();}ListStringpackages=();if(()){for(Stringpkg:packages){("Usingauto-configurationbasepackage'{}'",pkg);}}();();((packages));}catch(IllegalStateExceptionex){("Couldnotdetermineauto-configurationpackage,automaticmapperscanningdisabled.",ex);}}@OverridepublicvoidsetBeanFactory(BeanFactorybeanFactory)throwsBeansException{=beanFactory;}@OverridepublicvoidsetResourceLoader(ResourceLoaderresourceLoader){=resourceLoader;}}@@Import({})@ConditionalOnMissingBean()publicstaticclassMapperScannerRegistrarNotFoundConfiguration{@PostConstructpublicvoidafterPropertiesSet(){("No{}found.",());}}}

这个类就是一个Configuration（配置类），它里面定义很多bean，其中最重要的就是SqlSessionFactory的bean实例，该实例是Mybatis的核心功能，用它创建SqlSession，对数据库进行CRUD操作。

除此之外，MybatisAutoConfiguration类还包含了：

@ConditionalOnClass配置了只有包含和，该配置类才生效。

@ConditionalOnBean配置了只有包含dataSource实例时，该配置类才生效。

@EnableConfigurationProperties该注解会自动填充MybatisProperties实例中的属性。

AutoConfigureAfter配置了该配置类在DataSourceAutoConfiguration类之后自动配置。

这些注解都是一些辅助功能，决定Configuration是否生效，当然这些注解不是必须的。

接下来，重点看看文件有啥内容：

=\

里面只有一行配置，即key为EnableAutoConfiguration，value为MybatisAutoConfiguration。

好了，介绍了这么多东西，现在我们来总结一下，

starter几个要素如下图所示：那么，编写starter需要哪些步骤?

1.需要定义一个名称为xxx-spring-boot-starter的空项目，里面不包含任何代码，可以有和文件。

2.文件中包含了名称为xxx-spring-boot-autoconfigure的项目。

3.xxx-spring-boot-autoconfigure项目中包含了名称为xxxAutoConfiguration的类，该类可以定义一些bean实例。当然，Configuration类上可以打一些如：ConditionalOnClass、ConditionalOnBean、EnableConfigurationProperties等注解。

4.需要在文件中增加key为EnableAutoConfiguration，value为xxxAutoConfiguration。

我们试着按照这四步，自己编写一个starter看看能否成功，验证一下总结的内容是否正确。

3如何定义自己的starter？3.1先创建一个空项目

该项目名称为id-generate-starter，注意为了方便我把项目重命名了，原本应该是叫id-generate-spring-boot-starter的，如下图所示：

文件定义如下：

?xmlversion="1.0"encoding="UTF-8"?projectxmlns=""xmlns:xsi=""xsi:schemaLocation=""///groupIdartifactIdid-generate-spring-boot-starter/artifactIdnameid-generate-spring-boot-starter//groupIdartifactIdid-generate-spring-boot-autoconfigure//version/depency/depencies/project

我们看到，它只引入了id-generate-spring-boot-autoconfigure。当然如果有需要这里还可以引入多个autoconfigure或者多个其他jar包或者。

3.2创建id-generate-autoconfigure

同样为了方便我把项目重命名了，原本是叫id-generate-spring-boot-autoconfigure，如下图所示：

该项目当中包含：、、IdGenerateAutoConfiguration、IdGenerateService和IdProperties这5个关键文件，下面我们逐一看看。

先从

?xmlversion="1.0"encoding="UTF-8"?projectxmlns=""xmlns:xsi=""xsi:schemaLocation=""/groupIdartifactIdspring-boot-starter-parent//version////groupIdartifactIdid-generate-spring-boot-autoconfigure/artifactIdnameid-generate-spring-boot-autoconfigure//groupIdartifactIdspring-boot-starter/artifactId//groupIdartifactIdspring-boot-autoconfigure/artifactId//groupIdartifactIdspring-boot-configuration-processor/artifactIdoptionaltrue/optional/depency//groupIdartifactIdmaven-compiler-plugin///target/configuration/plugin/plugins/build/project

我们可以看到，这个文件比较简单就引入了：

spring-boot-starter：springboot的相关jar包。

spring-boot-autoconfigure：springboot自动配置相关jar包。

spring-boot-configuration-processor：springboot生成IDE提示功能相关jar包。

重点看看文件：

它里面只包含一行配置，其中key是EnableAutoConfiguration，value是IdGenerateAutoConfiguration。

再重点看一下IdGenerateAutoConfiguration

@ConditionalOnClass()@EnableConfigurationProperties()@ConfigurationpublicclassIdGenerateAutoConfiguration{@AutowiredprivateIdPropertiesproperties;@BeanpublicIdGenerateServiceidGenerateService(){returnnewIdGenerateService(());}}

该类是一个使用了@Configuration注解标记为了配置类，生效的条件是@ConditionalOnClass注解中检测到包含。并且使用@EnableConfigurationProperties注解会自动注入IdProperties的实例。

此外，最关键的点是该类里面创建了idGenerateService的bean实例，这是自动配置的精髓。

再看看IdGenerateService

publicclassIdGenerateService{privateLongworkId;publicIdGenerateService(LongworkId){=workId;}publicLonggenerate(){returnnewRandom().nextInt(100)+;}}

我们可以看到它是一个普通的类，甚至都没有使用@Service注解，里面有个generate方法，根据workId的值和随机数动态生成id。

最后看看IdProperties

@ConfigurationProperties(prefix=)publicclassIdProperties{publicstaticfinalStringPREFIX="sue";privateLongworkId;publicLonggetWorkId(){returnworkId;}publicvoidsetWorkId(LongworkId){=workId;}}

它是一个配置实体类，里面包含了相关的配置文件。使用@ConfigurationProperties注解，会自动把文件中以sue开通的，参数名称跟IdProperties中一样的参数值，自动注入到IdProperties对象中。

3.3创建id-generate-test

这个项目主要用于测试。

该项目里面包含：、、Application和TestRunner文件。

先看看文件

?xmlversion="1.0"encoding="UTF-8"?projectxmlns=""xmlns:xsi=""xsi:schemaLocation=""///groupIdartifactIdspring-boot-id-generate-test/artifactIdnamespring-boot-id-generate-test//groupIdartifactIdid-generate-spring-boot-starter//version/depency/depencies/project

由于只测试刚刚定义的id生成功能，所以只引入的id-generate-spring-boot-starterjar包。

配置资源文件

=123

只有一行配置，因为我们的IdProperties中目前只需要这一个参数。

Application是测试程序启动类

@SpringBootApplicationpublicclassApplication{publicstaticvoidmain(String[]args){(,args);}}

很简单，就是一个普通的springboot启动类

TestRunner是我们的测试类

@ComponentpublicclassTestRunnerimplementsApplicationRunner{@AutowiredprivateIdGenerateServiceidGenerateService;publicvoidrun(ApplicationArgumentsargs)throwsException{LongsysNo=();(sysNo);}}

它实现了ApplicationRunner接口，所以在springboot启动的时候会调用该类的run方法。

好了，所有自定义starter的代码和测试代码都已经就绪。接下，运行一下Application类的main方法。

运行结果：

完美，验证成功了。

接下来，我们分析一下starter的底层实现原理。

4starter的底层原理是什么？

通过上面编写自己的starter的例子，相信大家对starter的认识更进一步了，现在跟大家一起看看starter的底层是如何实现的。

其实是一个空项目，依赖于。

是一个入口，我们给他取一个更优雅的名字：门面模式，其他业务系统想引入相应的功能，必须要通过这个门面。

我们重点分析一下

该jar包核心内容是：IdGenerateConfiguration，这个配置类中创建了IdGenerateService对象，IdGenerateService是我们所需要自动配置的具体功能。

接下来一个最重要的问题：IdGenerateConfiguration为什么会自动加载的呢？

还记得我们定义的文件不？

它里面只包含一行配置，其中key是EnableAutoConfiguration，value是IdGenerateAutoConfiguration。

要搞明白这个过程，要从Application类的@SpringBootApplication注解开始：

@Target()@Retention()@Documented@Inherited@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan(excludeFilters={@Filter(type=,classes=),@Filter(type=,classes=)})public@interfaceSpringBootApplication{@AliasFor(annotation=)Class?[]exclude()default{};@AliasFor(annotation=)String[]excludeName()default{};@AliasFor(annotation=,attribute="basePackages")String[]scanBasePackages()default{};@AliasFor(annotation=,attribute="basePackageClasses")Class?[]scanBasePackageClasses()default{};}

从上面可以看出该注解里面包含了@EnableAutoConfiguration注解。

@Target()@Retention()@Documented@Inherited@AutoConfigurationPackage@Import()public@interfaceEnableAutoConfiguration{StringENABLED_OVERRIDE_PROPERTY="";Class?[]exclude()default{};String[]excludeName()default{};}

@EnableAutoConfiguration注解会引入AutoConfigurationImportSelector类。

该类的selectImports方法一个关键方法：

@OverridepublicString[]selectImports(AnnotationMetadataannotationMetadata){//配置有没有配置开关，默认为true//如果为false，则不执行自动配置的功能，直接返回if(!isEnabled(annotationMetadata)){returnNO_IMPORTS;}//找中的元素AutoConfigurationMetadataautoConfigurationMetadata=();//获取EnableAutoConfiguration注解中的属性AnnotationAttributesattributes=getAttributes(annotationMetadata);//获取工程下所有配置key为EnableAutoConfiguration的值，即IdGenerateConfiguration等类。ListStringconfigurations=getCandidateConfigurations(annotationMetadata,attributes);//删除重复的值configurations=removeDuplicates(configurations);//获取需要排除的规则列表SetStringexclusions=getExclusions(annotationMetadata,attributes);//检查checkExcludedClasses(configurations,exclusions);//删除需要排除的值(exclusions);//根据配置文件中配置的开关，过滤一部分不满足条件的值configurations=filter(configurations,autoConfigurationMetadata);fireAutoConfigurationImportEvents(configurations,exclusions);(configurations);}

这里就是starter能够自动配置的秘密。

此外，有些朋友看其他人定义的springbootstarter可能会有疑惑。

先看看druid-spring-boot-starter