<kbd id="afajh"><form id="afajh"></form></kbd>
<strong id="afajh"><dl id="afajh"></dl></strong>
    <del id="afajh"><form id="afajh"></form></del>
        1. <th id="afajh"><progress id="afajh"></progress></th>
          <b id="afajh"><abbr id="afajh"></abbr></b>
          <th id="afajh"><progress id="afajh"></progress></th>

          天天用SpringBoot寫代碼,結(jié)果連Starter是什么都不知道?

          共 36052字,需瀏覽 73分鐘

           ·

          2022-11-29 12:53

          點(diǎn)擊上方“Java技術(shù)江湖”,選擇“設(shè)為星標(biāo)

          回復(fù)”666“獲取全網(wǎng)最熱的Java核心知識點(diǎn)整理



          前言



          我們都知道,Spring的功能非常強(qiáng)大,但也有些弊端。比如:我們需要手動去配置大量的參數(shù),沒有默認(rèn)值,需要我們管理大量的jar包和它們的依賴。

          為了提升Spring項(xiàng)目的開發(fā)效率,簡化一些配置,Spring官方引入了SpringBoot。

          當(dāng)然,引入SpringBoot還有其他原因,在這里就不過多描述了。

          本文重點(diǎn)跟大家一起聊聊SpringBootstarter機(jī)制,因?yàn)樗匾恕?img class="rich_pages wxw-img" data-ratio="0.3597222222222222" src="https://filescdn.proginn.com/6b5604f2b6dec64c46968674159a6ecd/0e29f23a7ae73a29930a4a0bde42afbf.webp" data-type="png" data-w="1440" style="display: block;margin-right: auto;margin-left: auto;border-radius: 4px;margin-bottom: 25px;">


          1 為什么要用starter?





          SpringBoot還沒有出來之前,我們使用Spring開發(fā)項(xiàng)目。如果程序需要連接數(shù)據(jù)庫,我們一般會使用HibernateMybatisORM框架,這里我以Mybatis為例,具體的操作步驟如下:

          1. 到maven倉庫去找需要引入的mybatis jar包,選取合適的版本。
          2. 到maven倉庫去找mybatis-spring整合的jar包,選取合適的版本。
          3. 在spring的applicationContext.xml文件中配置dataSource和mybatis相關(guān)信息。

          當(dāng)然有些朋友可能會指正,不是還需要引入數(shù)據(jù)庫驅(qū)動包嗎?

          確實(shí)需要引入,但數(shù)據(jù)庫驅(qū)動有很多,比如:mysql、oracle、sqlserver,這不屬于mybatis的范疇,使用者可以根據(jù)項(xiàng)目的實(shí)際情況單獨(dú)引入。

          如果程序只是需要連接數(shù)據(jù)庫這一個(gè)功能還好,按上面的步驟做基本可以滿足需求。但是,連接數(shù)據(jù)庫可能只是龐大的項(xiàng)目體系中一個(gè)環(huán)節(jié),實(shí)際項(xiàng)目中往往更復(fù)雜,需要引入更多的功能,比如:連接redis、連接mongodb、使用rocketmq、使用excel功能等等。

          引入這些功能的話,需要再把上面的步驟再重復(fù)一次,工作量無形當(dāng)中增加了不少,而且有很多重復(fù)的工作

          另外,還是有個(gè)問題,每次到要到maven中找合適的版本,如果哪次找的mybatis.jar包 和 mybatis-spring.jar包版本不兼容,程序不是會出現(xiàn)問題?

          SpringBoot為了解決以上兩個(gè)問題引入了starter機(jī)制



          2 starter有哪些要素?





          我們首先一起看看mybatis-spring-boot-starter.jar是如何定義的。

          可以看到它的META-INF目錄下只包含了:

          • pom.protperties  配置maven所需的項(xiàng)目version、groupId和artifactId。
          • pom.xml  配置所依賴的jar包。
          • MANIFEST.MF 這個(gè)文件描述了該Jar文件的很多信息。
          • spring.provides 配置所依賴的artifactId,給IDE使用的,沒有其他的作用。

          注意一下,沒有一行代碼。

          我們重點(diǎn)看一下pom.xml,因?yàn)檫@個(gè)jar包里面除了這個(gè)沒有啥重要的信息

          <?xml version="1.0" encoding="UTF-8"?>
          <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
            <modelVersion>4.0.0</modelVersion>
            <parent>
              <groupId>org.mybatis.spring.boot</groupId>
              <artifactId>mybatis-spring-boot</artifactId>
              <version>1.3.1</version>
            </parent>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <name>mybatis-spring-boot-starter</name>
            <dependencies>
              <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
              </dependency>
              <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
              </dependency>
              <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-autoconfigure</artifactId>
              </dependency>
              <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
              </dependency>
              <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
              </dependency>
            </dependencies>
          </project>

          從上面可以看出,pom.xml文件中會引入一些jar包,其中除了引入spring-boot-starter,之外重點(diǎn)看一下:mybatis-spring-boot-autoconfigure

          我們找到mybatis-spring-boot-autoconfigure.jar文件,打開這個(gè)文件。

          里面包含如下文件:

          • pom.properties  配置maven所需的項(xiàng)目version、groupId和artifactId
          • pom.xml  配置所依賴的jar包
          • additional-spring-configuration-metadata.json  手動添加IDE提示功能
          • MANIFEST.MF 這個(gè)文件描述了該Jar文件的很多信息
          • spring.factories SPI會讀取的文件
          • spring-configuration-metadata.json 系統(tǒng)自動生成的IDE提示功能
          • ConfigurationCustomizer 自定義Configuration回調(diào)接口
          • MybatisAutoConfiguration mybatis配置類
          • MybatisProperties mybatis屬性類
          • SpringBootVFS 掃描嵌套的jar包中的類

          spring-configuration-metadata.jsonadditional-spring-configuration-metadata.json的功能差不多,我們在applicationContext.properties文件中輸入spring時(shí),會自動出現(xiàn)下面的配置信息可供選擇,就是這個(gè)功能了。

          來自靈魂的一問:這兩個(gè)文件有什么區(qū)別?

          答:如果pom.xml中引入了spring-boot-configuration-processor包,則會自動生成spring-configuration-metadata.json

          如果需要手動修改里面的元數(shù)據(jù),則可以在additional-spring-configuration-metadata.json中編輯,最終兩個(gè)文件中的元數(shù)據(jù)會合并到一起。

          MybatisProperties類是屬性實(shí)體類:

          @ConfigurationProperties(prefix = MybatisProperties.MYBATIS_PREFIX)
          public class MybatisProperties {

            public static final String MYBATIS_PREFIX = "mybatis";
            private String configLocation;
            private String[] mapperLocations;
            private String typeAliasesPackage;
            private String typeHandlersPackage;
            private boolean checkConfigLocation = false;
            private ExecutorType executorType;
            private Properties configurationProperties;
            @NestedConfigurationProperty
            private Configuration configuration;

            public String getConfigLocation() {
              return this.configLocation;
            }

            public void setConfigLocation(String configLocation) {
              this.configLocation = configLocation;
            }

            @Deprecated
            public String getConfig() {
              return this.configLocation;
            }

            @Deprecated
            public void setConfig(String config) {
              this.configLocation = config;
            }

            public String[] getMapperLocations() {
              return this.mapperLocations;
            }

            public void setMapperLocations(String[] mapperLocations) {
              this.mapperLocations = mapperLocations;
            }
            
            public String getTypeHandlersPackage() {
              return this.typeHandlersPackage;
            }

            public void setTypeHandlersPackage(String typeHandlersPackage) {
              this.typeHandlersPackage = typeHandlersPackage;
            }

            public String getTypeAliasesPackage() {
              return this.typeAliasesPackage;
            }

            public void setTypeAliasesPackage(String typeAliasesPackage) {
              this.typeAliasesPackage = typeAliasesPackage;
            }

            public boolean isCheckConfigLocation() {
              return this.checkConfigLocation;
            }

            public void setCheckConfigLocation(boolean checkConfigLocation) {
              this.checkConfigLocation = checkConfigLocation;
            }

            public ExecutorType getExecutorType() {
              return this.executorType;
            }

            public void setExecutorType(ExecutorType executorType) {
              this.executorType = executorType;
            }

            public Properties getConfigurationProperties() {
              return configurationProperties;
            }

            public void setConfigurationProperties(Properties configurationProperties) {
              this.configurationProperties = configurationProperties;
            }

            public Configuration getConfiguration() {
              return configuration;
            }

            public void setConfiguration(Configuration configuration) {
              this.configuration = configuration;
            }

            public Resource[] resolveMapperLocations() {
              ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
              List<Resource> resources = new ArrayList<Resource>();
              if (this.mapperLocations != null) {
                for (String mapperLocation : this.mapperLocations) {
                  try {
                    Resource[] mappers = resourceResolver.getResources(mapperLocation);
                    resources.addAll(Arrays.asList(mappers));
                  } catch (IOException e) {
                    // ignore
                  }
                }
              }
              return resources.toArray(new Resource[resources.size()]);
            }
          }

          可以看到Mybatis初始化所需要的很多屬性都在這里,相當(dāng)于一個(gè)JavaBean

          下面重點(diǎn)看一下MybatisAutoConfiguration的代碼:

          @org.springframework.context.annotation.Configuration
          @ConditionalOnClass({ SqlSessionFactory.classSqlSessionFactoryBean.class })
          @ConditionalOnBean(DataSource.class)
          @EnableConfigurationProperties(MybatisProperties.class)
          @AutoConfigureAfter(DataSourceAutoConfiguration.class)
          public class MybatisAutoConfiguration 
          {

            private static final Logger logger = LoggerFactory.getLogger(MybatisAutoConfiguration.class);
            private final MybatisProperties properties;
            private final Interceptor[] interceptors;
            private final ResourceLoader resourceLoader;
            private final DatabaseIdProvider databaseIdProvider;
            private final List<ConfigurationCustomizer> configurationCustomizers;
            public MybatisAutoConfiguration(MybatisProperties properties,
                                            ObjectProvider<Interceptor[]> interceptorsProvider,
                                            ResourceLoader resourceLoader,
                                            ObjectProvider<DatabaseIdProvider> databaseIdProvider,
                                            ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider)
           
          {
              this.properties = properties;
              this.interceptors = interceptorsProvider.getIfAvailable();
              this.resourceLoader = resourceLoader;
              this.databaseIdProvider = databaseIdProvider.getIfAvailable();
              this.configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
            }

            @PostConstruct
            public void checkConfigFileExists() {
              if (this.properties.isCheckConfigLocation() && StringUtils.hasText(this.properties.getConfigLocation())) {
                Resource resource = this.resourceLoader.getResource(this.properties.getConfigLocation());
                Assert.state(resource.exists(), "Cannot find config location: " + resource
                    + " (please add config file or check your Mybatis configuration)");
              }
            }

            @Bean
            @ConditionalOnMissingBean
            public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
              SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
              factory.setDataSource(dataSource);
              factory.setVfs(SpringBootVFS.class);
              if (StringUtils.hasText(this.properties.getConfigLocation())) {
                factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
              }
              Configuration configuration = this.properties.getConfiguration();
              if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
                configuration = new Configuration();
              }
              if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
                for (ConfigurationCustomizer customizer : this.configurationCustomizers) {
                  customizer.customize(configuration);
                }
              }
              factory.setConfiguration(configuration);
              if (this.properties.getConfigurationProperties() != null) {
                factory.setConfigurationProperties(this.properties.getConfigurationProperties());
              }
              if (!ObjectUtils.isEmpty(this.interceptors)) {
                factory.setPlugins(this.interceptors);
              }
              if (this.databaseIdProvider != null) {
                factory.setDatabaseIdProvider(this.databaseIdProvider);
              }
              if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
                factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
              }
              if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
                factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
              }
              if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
                factory.setMapperLocations(this.properties.resolveMapperLocations());
              }

              return factory.getObject();
            }

            @Bean
            @ConditionalOnMissingBean
            public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
              ExecutorType executorType = this.properties.getExecutorType();
              if (executorType != null) {
                return new SqlSessionTemplate(sqlSessionFactory, executorType);
              } else {
                return new SqlSessionTemplate(sqlSessionFactory);
              }
            }

            public static class AutoConfiguredMapperScannerRegistrar
                implements BeanFactoryAwareImportBeanDefinitionRegistrarResourceLoaderAware 
          {
              private BeanFactory beanFactory;
              private ResourceLoader resourceLoader;

              @Override
              public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

                ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
                try {
                  if (this.resourceLoader != null) {
                    scanner.setResourceLoader(this.resourceLoader);
                  }

                  List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
                  if (logger.isDebugEnabled()) {
                    for (String pkg : packages) {
                      logger.debug("Using auto-configuration base package '{}'", pkg);
                    }
                  }

                  scanner.setAnnotationClass(Mapper.class);
                  scanner.registerFilters();
                  scanner.doScan(StringUtils.toStringArray(packages));
                } catch (IllegalStateException ex) {
                  logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.", ex);
                }
              }

              @Override
              public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
                this.beanFactory = beanFactory;
              }

              @Override
              public void setResourceLoader(ResourceLoader resourceLoader) {
                this.resourceLoader = resourceLoader;
              }
            }

            @org.springframework.context.annotation.Configuration
            @Import({ AutoConfiguredMapperScannerRegistrar.class })
            @ConditionalOnMissingBean(MapperFactoryBean.class)
            public static class MapperScannerRegistrarNotFoundConfiguration 
          {
            
              @PostConstruct
              public void afterPropertiesSet() {
                logger.debug("No {} found.", MapperFactoryBean.class.getName());
              }
            }
          }

          這個(gè)類就是一個(gè)Configuration(配置類),它里面定義很多bean,其中最重要的就是SqlSessionFactory的bean實(shí)例,該實(shí)例是Mybatis的核心功能,用它創(chuàng)建SqlSession,對數(shù)據(jù)庫進(jìn)行CRUD操作。

          除此之外,MybatisAutoConfiguration類還包含了:

          • @ConditionalOnClass 配置了只有包含SqlSessionFactory.class和SqlSessionFactoryBean.class,該配置類才生效。
          • @ConditionalOnBean 配置了只有包含dataSource實(shí)例時(shí),該配置類才生效。
          • @EnableConfigurationProperties 該注解會自動填充MybatisProperties實(shí)例中的屬性。
          • AutoConfigureAfter 配置了該配置類在DataSourceAutoConfiguration類之后自動配置。

          這些注解都是一些輔助功能,決定Configuration是否生效,當(dāng)然這些注解不是必須的。

          接下來,重點(diǎn)看看spring.factories文件有啥內(nèi)容:

          org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
          org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

          里面只有一行配置,即keyEnableAutoConfigurationvalueMybatisAutoConfiguration

          好了,介紹了這么多東西,現(xiàn)在我們來總結(jié)一下,

          starter幾個(gè)要素如下圖所示:那么,編寫starter需要哪些步驟?

          • 1.需要定義一個(gè)名稱為xxx-spring-boot-starter的空項(xiàng)目,里面不包含任何代碼,可以有pom.xml和pom.properties文件。
          • 2.pom.xml文件中包含了名稱為xxx-spring-boot-autoconfigure的項(xiàng)目。
          • 3.xxx-spring-boot-autoconfigure項(xiàng)目中包含了名稱為xxxAutoConfiguration的類,該類可以定義一些bean實(shí)例。當(dāng)然,Configuration類上可以打一些如:ConditionalOnClass、ConditionalOnBean、EnableConfigurationProperties等注解。
          • 4.需要在spring.factories文件中增加key為EnableAutoConfiguration,value為xxxAutoConfiguration。

          我們試著按照這四步,自己編寫一個(gè)starter看看能否成功,驗(yàn)證一下總結(jié)的內(nèi)容是否正確。



          3 如何定義自己的starter?






          3.1 先創(chuàng)建一個(gè)空項(xiàng)目


          該項(xiàng)目名稱為id-generate-starter,注意為了方便我把項(xiàng)目重命名了,原本應(yīng)該是叫id-generate-spring-boot-starter的,如下圖所示:

          pom.xml文件定義如下:

          <?xml version="1.0" encoding="UTF-8"?>
          <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
              <modelVersion>4.0.0</modelVersion>
              <version>1.3.1</version>
              <groupId>com.sue</groupId>
              <artifactId>id-generate-spring-boot-starter</artifactId>
              <name>id-generate-spring-boot-starter</name>
              <dependencies>
                  <dependency>
                      <groupId>com.sue</groupId>
                      <artifactId>id-generate-spring-boot-autoconfigure</artifactId>
                      <version>1.3.1</version>
                  </dependency>
              </dependencies>
          </project>

          我們看到,它只引入了id-generate-spring-boot-autoconfigure。當(dāng)然如果有需要這里還可以引入多個(gè)autoconfigure或者多個(gè)其他jar包或者。


          3.2 創(chuàng)建id-generate-autoconfigure


          同樣為了方便我把項(xiàng)目重命名了,原本是叫id-generate-spring-boot-autoconfigure,如下圖所示:

          該項(xiàng)目當(dāng)中包含:pom.xml、spring.factories、IdGenerateAutoConfiguration、IdGenerateService 和 IdProperties 這5個(gè)關(guān)鍵文件,下面我們逐一看看。

          先從pom.xml

          <?xml version="1.0" encoding="UTF-8"?>
          <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
              <parent>
                  <groupId>org.springframework.boot</groupId>
                  <artifactId>spring-boot-starter-parent</artifactId>
                  <version>2.0.4.RELEASE</version>
              </parent>
              <modelVersion>4.0.0</modelVersion>
              <version>1.3.1</version>
              <groupId>com.sue</groupId>
              <artifactId>id-generate-spring-boot-autoconfigure</artifactId>
              <name>id-generate-spring-boot-autoconfigure</name>

              <dependencies>
                  <dependency>
                      <groupId>org.springframework.boot</groupId>
                      <artifactId>spring-boot-starter</artifactId>
                  </dependency>
                  <dependency>
                      <groupId>org.springframework.boot</groupId>
                      <artifactId>spring-boot-autoconfigure</artifactId>
                  </dependency>
                  <dependency>
                      <groupId>org.springframework.boot</groupId>
                      <artifactId>spring-boot-configuration-processor</artifactId>
                      <optional>true</optional>
                  </dependency>
              </dependencies>

              <build>
                  <plugins>
                      <plugin>
                          <groupId>org.apache.maven.plugins</groupId>
                          <artifactId>maven-compiler-plugin</artifactId>
                          <configuration>
                              <source>1.8</source>
                              <target>1.8</target>
                          </configuration>
                      </plugin>
                  </plugins>
              </build>
          </project>

          我們可以看到,這個(gè)文件比較簡單就引入了:

          • spring-boot-starter:springboot的相關(guān)jar包。
          • spring-boot-autoconfigure:springboot自動配置相關(guān)jar包。
          • spring-boot-configuration-processor:springboot生成IDE提示功能相關(guān)jar包。

          重點(diǎn)看看spring.factories文件:

          org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.sue.IdGenerateAutoConfiguration

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

          再重點(diǎn)看一下IdGenerateAutoConfiguration

          @ConditionalOnClass(IdProperties.class)
          @EnableConfigurationProperties(IdProperties.class)
          @Configuration
          public class IdGenerateAutoConfiguration 
          {
              @Autowired
              private IdProperties properties;
              @Bean
              public IdGenerateService idGenerateService() {
                  return new IdGenerateService(properties.getWorkId());
              }
          }

          該類是一個(gè)使用了@Configuration注解標(biāo)記為了配置類,生效的條件是@ConditionalOnClass注解中檢測到包含IdProperties.class。并且使用@EnableConfigurationProperties注解會自動注入IdProperties的實(shí)例。

          此外,最關(guān)鍵的點(diǎn)是該類里面創(chuàng)建了idGenerateService的bean實(shí)例,這是自動配置的精髓。

          再看看IdGenerateService

          public class IdGenerateService {
              private Long workId;
              public IdGenerateService(Long workId) {
                  this.workId = workId;
              }

              public Long generate() {
                  return new Random().nextInt(100) + this.workId;
              }
          }

          我們可以看到它是一個(gè)普通的類,甚至都沒有使用@Service注解,里面有個(gè)generate方法,根據(jù)workId的值和隨機(jī)數(shù)動態(tài)生成id。

          最后看看IdProperties

          @ConfigurationProperties(prefix = IdProperties.PREFIX)
          public class IdProperties {
              public static final String PREFIX = "sue";
              private Long workId;
              public Long getWorkId() {
                  return workId;
              }
              public void setWorkId(Long workId) {
                  this.workId = workId;
              }
          }

          它是一個(gè)配置實(shí)體類,里面包含了相關(guān)的配置文件。使用@ConfigurationProperties注解,會自動把application.properties文件中以sue開通的,參數(shù)名稱跟IdProperties中一樣的參數(shù)值,自動注入到IdProperties對象中。


          3.3 創(chuàng)建id-generate-test


          這個(gè)項(xiàng)目主要用于測試。

          該項(xiàng)目里面包含:pom.xml、application.properties、Application 和 TestRunner 文件。

          先看看pom.xml文件

          <?xml version="1.0" encoding="UTF-8"?>
          <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

              <modelVersion>4.0.0</modelVersion>
              <version>1.3.1</version>
              <groupId>com.sue</groupId>
              <artifactId>spring-boot-id-generate-test</artifactId>
              <name>spring-boot-id-generate-test</name>
              <dependencies>
                  <dependency>
                      <groupId>com.sue</groupId>
                      <artifactId>id-generate-spring-boot-starter</artifactId>
                      <version>1.3.1</version>
                  </dependency>
              </dependencies>
          </project>

          由于只測試剛剛定義的id生成功能,所以只引入的id-generate-spring-boot-starter jar包。

          application.properties配置資源文件

          sue.workId=123

          只有一行配置,因?yàn)槲覀兊腎dProperties中目前只需要這一個(gè)參數(shù)。

          Application是測試程序啟動類

          @SpringBootApplication
          public class Application {
              public static void main(String[] args) {
                  SpringApplication.run(Application.classargs);
              }
          }

          很簡單,就是一個(gè)普通的springboot啟動類

          TestRunner是我們的測試類

          @Component
          public class TestRunner implements ApplicationRunner {
              @Autowired
              private IdGenerateService idGenerateService;
              public void run(ApplicationArguments args) throws Exception {
                  Long sysNo = idGenerateService.generate();
                  System.out.println(sysNo);
              }
          }

          它實(shí)現(xiàn)了ApplicationRunner接口,所以在springboot啟動的時(shí)候會調(diào)用該類的run方法。

          好了,所有自定義starter的代碼和測試代碼都已經(jīng)就緒。接下,運(yùn)行一下Application類的main方法。

          運(yùn)行結(jié)果:

          176

          完美,驗(yàn)證成功了。

          接下來,我們分析一下starter的底層實(shí)現(xiàn)原理。



          4 starter的底層原理是什么?





          通過上面編寫自己的starter的例子,相信大家對starter的認(rèn)識更進(jìn)一步了,現(xiàn)在跟大家一起看看starter的底層是如何實(shí)現(xiàn)的。

          id-generate-starter.jar其實(shí)是一個(gè)空項(xiàng)目,依賴于id-generate-autoconfiguration.jar。

          id-generate-starter.jar是一個(gè)入口,我們給他取一個(gè)更優(yōu)雅的名字:門面模式,其他業(yè)務(wù)系統(tǒng)想引入相應(yīng)的功能,必須要通過這個(gè)門面。

          我們重點(diǎn)分析一下 id-generate-autoconfiguration.jar

          該jar包核心內(nèi)容是:IdGenerateConfiguration,這個(gè)配置類中創(chuàng)建了IdGenerateService對象,IdGenerateService是我們所需要自動配置的具體功能。

          接下來一個(gè)最重要的問題:IdGenerateConfiguration為什么會自動加載的呢?

          還記得我們定義的spring.factories文件不?

          org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.sue.IdGenerateAutoConfiguration

          它里面只包含一行配置,其中keyEnableAutoConfigurationvalueIdGenerateAutoConfiguration

          要搞明白這個(gè)過程,要從Application類的@SpringBootApplication注解開始:

          @Target(ElementType.TYPE)
          @Retention(RetentionPolicy.RUNTIME)
          @Documented
          @Inherited
          @SpringBootConfiguration
          @EnableAutoConfiguration
          @ComponentScan(excludeFilters = {
              @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
              @Filter(type 
          = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
          public @interface SpringBootApplication 
          {

            @AliasFor(annotation = EnableAutoConfiguration.class)
            Class<?>[] exclude() default 
          {};

            @AliasFor(annotation = EnableAutoConfiguration.class)
            String[] excludeName() default 
          {};

            @AliasFor(annotation = ComponentScan.classattribute "basePackages")
            String[] scanBasePackages() default {};
            
            @AliasFor(annotation = ComponentScan.classattribute "basePackageClasses")
            Class<?>[] scanBasePackageClasses() default {};
          }

          從上面可以看出該注解里面包含了@EnableAutoConfiguration注解。

          @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 {};
          }

          @EnableAutoConfiguration注解會引入AutoConfigurationImportSelector類。

          該類的selectImports方法一個(gè)關(guān)鍵方法:

          @Override
            public String[] selectImports(AnnotationMetadata annotationMetadata) {
              //配置有沒有配置spring.boot.enableautoconfiguration開關(guān),默認(rèn)為true
              //如果為false,則不執(zhí)行自動配置的功能,直接返回
              if (!isEnabled(annotationMetadata)) {
                return NO_IMPORTS;
              }
              //找spring-autoconfigure-metadata.properties中的元素
              AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
                  .loadMetadata(this.beanClassLoader);
              //獲取EnableAutoConfiguration注解中的屬性 
              AnnotationAttributes attributes = getAttributes(annotationMetadata);
              //獲取工程下所有配置key為EnableAutoConfiguration的值,即IdGenerateConfiguration等類。
              List<String> configurations = getCandidateConfigurations(annotationMetadata,
                  attributes);
              //刪除重復(fù)的值    
              configurations = removeDuplicates(configurations);
              //獲取需要排除的規(guī)則列表
              Set<String> exclusions = getExclusions(annotationMetadata, attributes);
              //檢查
              checkExcludedClasses(configurations, exclusions);
              //刪除需要排除的值
              configurations.removeAll(exclusions);
              //根據(jù)配置文件中配置的開關(guān),過濾一部分不滿足條件的值
              configurations = filter(configurations, autoConfigurationMetadata);
              fireAutoConfigurationImportEvents(configurations, exclusions);
              return StringUtils.toStringArray(configurations);
            }

          這里就是starter能夠自動配置的秘密

          此外,有些朋友看其他人定義的springboot starter可能會有疑惑。

          先看看druid-spring-boot-starter

          alibaba定義的druid-spring-boot-starter只有xxx-spring-boot-starter.jar文件,而沒有xxx-spring-boot-autoconfigure.jar文件。

          再看看spring-boot-starter-jdbc

          更神奇的是這個(gè)文件中連pom.xml都沒有,一臉懵逼。。。。。。。

          是不是我講錯(cuò)了?

          答:其實(shí)沒有。

          SpringBoot的原則是約定優(yōu)于配置

          從spring-boot-starter-jdbc內(nèi)部空實(shí)現(xiàn)來看,它的約定是要把xxx-spring-boot-starter.jar和xxx-spring-boot-autoconfigure.jar區(qū)分開的。個(gè)人認(rèn)為,alibaba定義得并不好,沒有遵照springboot的約定,雖然功能不受影響。(這個(gè)地方歡迎一起探討一下)

          而springboot自己定義的spring-boot-starter-jdbc為什么連pom.xml文件也沒有呢?

          它不需要依賴xxx-spring-boot-autoconfigure.jar文件嗎?

          因?yàn)閟pringboot把所有的自動配置的類都統(tǒng)一放到spring-boot-autoconfigure.jar下面了:

          spring.factories文件內(nèi)容如下:

          SpringBoot這樣集中管理自動配置,而不需要從各個(gè)子包中遍歷,我個(gè)人認(rèn)為是為了查找效率。

          我們最后再看看spring-cloud-starter-openfegin明顯看到,它是遵循了我們說的原則的。

          除此之外,還有一個(gè)原則一順便提一下。

          SpringBootSpringCloud系列定義jar包的名稱是:

          • spring-boot-starter-xxx.jar
          • spring-cloud-starter-xxx.jar

          而我們自己的項(xiàng)目定義的jar應(yīng)該是:

          • xxx-spring-boot-starter.jar

          Java 后端有哪些不用學(xué)的技術(shù)?勸退。。。


          Java 中九種 Map 的遍歷方式,你一般用的是哪種呢?


          MySQL模糊查詢再也用不著 like+% 了!


          關(guān)注公眾號【Java技術(shù)江湖】后回復(fù)“PDF”即可領(lǐng)取200+頁的《Java工程師面試指南》

          強(qiáng)烈推薦,幾乎涵蓋所有Java工程師必知必會的知識點(diǎn),不管是復(fù)習(xí)還是面試,都很實(shí)用。



          瀏覽 69
          點(diǎn)贊
          評論
          收藏
          分享

          手機(jī)掃一掃分享

          分享
          舉報(bào)
          評論
          圖片
          表情
          推薦
          點(diǎn)贊
          評論
          收藏
          分享

          手機(jī)掃一掃分享

          分享
          舉報(bào)
          <kbd id="afajh"><form id="afajh"></form></kbd>
          <strong id="afajh"><dl id="afajh"></dl></strong>
            <del id="afajh"><form id="afajh"></form></del>
                1. <th id="afajh"><progress id="afajh"></progress></th>
                  <b id="afajh"><abbr id="afajh"></abbr></b>
                  <th id="afajh"><progress id="afajh"></progress></th>
                  国产精品久久久爽爽爽麻豆色哟哟 | 国产欧美日韩一级片 | 日本精品一区二区三区视频 | 亚洲AV无码成人精品区大猫 | 丁香五香天堂网 |