快捷導(dǎo)航

一文詳解SpringBoot3如何自定義starter

更新時間：2024年09月08日 11:43:31 作者：藍染-惣右介

在Spring Boot中,starter是一種特殊的依賴,它可以幫助開發(fā)人員快速引入和配置某個特定的功能模塊,我們在面試中通過會被問到SpringBoot3如何自定義starter,所以本文小編給大家詳細介紹了SpringBoot3自定義starter的步驟,需要的朋友可以參考下

1、創(chuàng)建autoconfigure的maven工程
2、創(chuàng)建starter的maven工程
3、在autoconfigure的pom文件中引入MyBatis的所需依賴
4、編寫自動配置類MyBatisAutoConfiguration
5、編寫imports配置文件
6、在starter的pom文件中引入autoconfigure的文件
7、測試自定義starter是否生效

一、自定義starter介紹

在Spring Boot中，starter是一種特殊的依賴，它可以幫助開發(fā)人員快速引入和配置某個特定的功能模塊。

Spring Boot的官方starter并不一定包含所有開發(fā)人員所需的功能，這時候就需要自定義starter來滿足特定項目的需求。

自定義starter是一種自包含的、可重用的模塊，它封裝了一組特定功能的依賴和配置，并提供了簡化配置的方式。通過自定義starter，開發(fā)人員可以將一些常用的功能封裝起來，使得在其他項目中引入這些功能變得更加簡單和方便。

二、自定義Starter的好處及優(yōu)勢

特點及優(yōu)勢	說明
模塊化	自定義Starter可以將特定的功能模塊化，使得開發(fā)人員可以更方便地管理和維護代碼。
簡化配置	通過自定義Starter，開發(fā)人員可以簡化配置，減少重復(fù)的配置工作，提高開發(fā)效率。
提高代碼重用性	自定義Starter可以封裝一組特定功能的依賴和配置，使得在其他項目中引入這些功能變得更加簡單和方便，從而提高代碼重用性。
自定義功能	如果Spring Boot的官方Starter不能滿足項目的需求，那么自定義Starter就可以發(fā)揮重要作用。開發(fā)人員可以根據(jù)項目需求自定義Starter，從而實現(xiàn)一些特定的功能。

三、自定義starter應(yīng)用場景

在我們的日常開發(fā)工作中，可能會需要開發(fā)一個通用模塊，以供其它工程復(fù)用。SpringBoot就為我們提供這樣的功能機制，我們可以把我們的通用模塊封裝成一個個starter，這樣其它工程復(fù)用的時候只需要在pom中引用依賴即可，由SpringBoot為我們完成自動裝配。

常見的應(yīng)用場景：

1）通用模塊-短信發(fā)送模塊

2）基于AOP技術(shù)實現(xiàn)日志切面

3）分布式雪花ID，Long轉(zhuǎn)String，解決精度問題

4）微服務(wù)項目的數(shù)據(jù)庫連接池配置

5）微服務(wù)項目的每個模塊都要訪問redis數(shù)據(jù)庫，每個模塊都要配置redisTemplate

四、自定義starter

我們可以先參考一下MyBatis的starter，一般情況下起步依賴會由兩個工程組成，一個是xxx-autoconfigure提供自動配置功能，另一個是xxx-starter提供依賴管理功能。同時會在starter中引入autoconfigure，將來使用者引入starter就可以了。

了解了自定義starter的套路后，我們來自定義一個MyBatis的starter。

1、創(chuàng)建autoconfigure的maven工程

創(chuàng)建一個maven工程，名字叫做dmybatis-spring-boot-autoconfigure，前面加d是為了和MyBatis官方的起步依賴區(qū)分開。

注意命名規(guī)范：springboot官方提供的starter一般以spring-boot-starter-xxxx方式命名，官方建議自定義的starter使用xxxx-spring-boot-starter命名。用來區(qū)分第三方的starter和springboot官方的starter。

2、創(chuàng)建starter的maven工程

再創(chuàng)建一個maven工程，名字叫做dmybatis-spring-boot-starter。

3、在autoconfigure的pom文件中引入MyBatis的所需依賴

首先我們觀察一下MyBatis的官方起步依賴包含哪些子依賴：

org.springframework.boot:spring-boot-starter:3.3.3
org.springframework.boot:spring-boot-starter-jdbc:3.3.3
org.mybatis.spring.boot:mybatis-spring-boot-autoconfigure:3.0.3
org.mybatis:mybatis:3.5.14
org.mybatis:mybatis-spring:3.0.3

其中org.mybatis.spring.boot:mybatis-spring-boot-autoconfigure:3.0.3依賴我們不需要引入，因為autoconfigure模塊由我們自定義。只需在autoconfigure的pom文件中引入其他的依賴：

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>3.3.3</version>
  </dependency>

  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
    <version>3.3.3</version>
  </dependency>

  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.14</version>
  </dependency>

  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>3.0.3</version>
  </dependency>
</dependencies>

4、編寫自動配置類MyBatisAutoConfiguration

@AutoConfiguration  // 表識當(dāng)前類是一個自動配置類
public class MyBatisAutoConfiguration {
    // SqlSessionFactoryBean
    @Bean
    public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource) {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean;
    }

    // MapperScannerConfigurer
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer(BeanFactory beanFactory) {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        // 掃描的包：啟動類所在的包及其子包
        List<String> packages = AutoConfigurationPackages.get(beanFactory); // 獲取啟動類所在的包名
        String basePackage = packages.get(0);   // 因為啟動類所在的包只有一個，直接獲取第一個
        mapperScannerConfigurer.setBasePackage(basePackage);    // 設(shè)置mapper的包掃描路徑
        // 掃描的注解：@Mapper
        mapperScannerConfigurer.setAnnotationClass(Mapper.class);
        return mapperScannerConfigurer;
    }
}

5、編寫imports配置文件

在autoconfigure項目的/resources/META-INF/spring目錄下創(chuàng)建org.springframework.boot.autoconfigure.AutoConfiguration.imports配置文件，注意存放路徑要嚴(yán)格遵循這個文件夾名和文件名，SpringBoot才會識別到配置文件。

在imports文件中，我們只需要填寫MyBatis的自動配置類的全類名即可：

com.aizen.config.MyBatisAutoConfiguration

6、在starter的pom文件中引入autoconfigure的文件

<dependencies>
  <dependency>
    <groupId>com.aizen</groupId>
    <artifactId>dmybatis-spring-boot-autoconfigure</artifactId>
    <version>1.0-SNAPSHOT</version>
  </dependency>
</dependencies>

7、測試自定義starter是否生效

在springboot-mybatis項目中，已經(jīng)配置了datasource數(shù)據(jù)源，并寫好了后端數(shù)據(jù)訪問接口。

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis
    username: root
    password: root

@Mapper
public interface UserMapper {
    @Select("select * from user where id = #{id}")
    User findById(Integer id);
}

在項目的pom文件中引入自定義MyBatis的starter依賴：

<!-- 自定義的mybatis起步依賴 -->
<dependency>
    <groupId>com.aizen</groupId>
    <artifactId>dmybatis-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

<!--mysql驅(qū)動依賴-->
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
</dependency>