Java培訓：學會寫Starter-你就懂了SpringBoot自動配置

　　一、為什么要寫Starter

　　 目前是微服務開發(fā)時代，微服務架構，最新編寫單元，一定是基于SpringBoot技術，即使不是微服務，目前也基本使用SpringBoot單體應用去掉SSM開發(fā)。故在面試中，必問SpringBoot相關技術，其中自動配置是也是必問知識點。當然開發(fā)時間越久，開發(fā)級別越高，也肯定會在項目中，開發(fā)一些自己的組件，所有自己動手寫Starter是必備技能。

　　二、了解Starter的構成

　　1. starter包含哪些內(nèi)容

　　1. 提供所需要的依賴，解決依賴直接的沖突

　　2. 提供自定義配置所需要的類及配置文件

　　為了讓大家清楚starter的構成，我們來看`mybatis-spring-boot-starter`包含了哪些內(nèi)容，如下是mybatis starter的依賴坐標：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.4</version>
</dependency>

　　這個mybatis-spring-boot-starter包含了如下內(nèi)容：

　　其中xxx-jdbc、mybatis、mybatis-spring是mybatis關鍵依賴，其中xxx-autoconfigure就是自動配置相關的jar包，里面包含內(nèi)容如下：

　　其中XXXAutoConfiguration是自動配置類，MybatisProperties是Mybatis的屬性配置類(在springboot的yaml文件中，對mybatis寫的配置信息就是此類提供編寫的規(guī)范，此類進行自動讀取)。

　　META-INF/spring.factories提供的自動配置加載的類列表，內(nèi)容如下：

```properties
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
```

　　2. starter的命名規(guī)范

　　在自定義starter時，我們還需要遵循命名的規(guī)范，讓使用者一眼能看出是官方和非官方開發(fā)的。

　　官方的starter寫法：`spring-boot-starter-*`，感興趣的可以去官方看看[常用的starters有哪些?](https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/html/using-boot-build-systems.html#using-boot-starter)

　　非官方的starter寫法：`thirdpartyproject-spring-boot-starter`

　　結論：只要不是spring官方發(fā)布的，我們都按非官方的要求編寫，都要以-spring-boot-starter結尾。

　　三、開始動手寫Starter

1. 自定義什么starter
   

   
   

　　 在操作數(shù)據(jù)庫的項目中，我們都會選用一些高性能的數(shù)據(jù)庫連接池產(chǎn)品，比如DruidDataSource，官方也提供了整合的starter，比如 "druid-spring-boot-starter"。在這里，我們?yōu)榱藢W習自定義starter,準備使用c3p0，因為c3p0的官方?jīng)]有提供相應的starter，今天帶著大家寫一個c3p0的starter，通過自定義starter,來學習一下starter的自動配置，要求如下：

　　1. 自動配置名字：c3p0-spring-boot-autoconfigure

　　2. starter名字： c3p0-spring-boot-starter

　　3. 提供使用c3p0的數(shù)據(jù)庫連接屬性(讓使用者在yaml文件中對連接進行基本配置)

　　4. 啟動時實現(xiàn)自動裝配，實例化一個DataSource，采用c3p0作為連接池

　　2. 寫starter的步驟

　　1. 創(chuàng)建一個空項目springboot-starter，把其它模塊放在此項目中管理

　　2. 創(chuàng)建c3p0-spring-boot-autoconfigure獨立模塊，提供自動配置需要的相關類**[autoconfigure模塊]**

　　3. 創(chuàng)建c3p0-spring-boot-starter模塊，引入autoconfigure模塊 **[starter模塊]**

　　4. 創(chuàng)建spring-boot-test-c3p0模塊,依賴c3p0-spring-boot-starter的模塊 **[測試自定義starter]**

　　3. 實現(xiàn)starter的過程

　　3.1創(chuàng)建空項目springboot-starter

　　3.2創(chuàng)建 c3p0-spring-boot-autoconfigure

　　1)導入依賴坐標

<?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>
    <groupId>com.itheima</groupId>
    <artifactId>c3p0-spring-boot-autoconfigure</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <spring-boot-version>2.4.4</spring-boot-version>
        <c3p0.version>0.9.1.2</c3p0.version>
    </properties>
    <packaging>jar</packaging>

    <dependencies>
        <!--c3p0需要的依賴庫-->
        <dependency>
            <groupId>c3p0</groupId>
            <artifactId>c3p0</artifactId>
            <version>${c3p0.version}</version>
            <scope>provided</scope>
        </dependency>
        <!--自動配置需要的依賴庫-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>${spring-boot-version}</version>
        </dependency>
        <!--配置文件處理依賴庫-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>${spring-boot-version}</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>
```

　　
       scope：provided，打包時不包含此依賴，一般autoconfigure模塊中，僅包含配置類相關。

　　2)創(chuàng)建C3p0DataSourceProperties配置文件

@ConfigurationProperties(prefix = "spring.datasource.c3p0")
public class C3p0DataSourceProperties {
    private String driverClassName;
    private String url;
    private String username;
    private String password;
    // 當前僅做測試，其它屬性暫時使用默認值
    // 提供Setter/Getter方法
    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
}

　　
      @ConfigurationProperties： 將從yaml文件讀取的屬性之前賦值給當前屬性配置類對象。

　　prefix：要求寫yaml文件是必須有此前綴。

　　3)創(chuàng)建C3p0DatasourceAutoConfigure自動配置類

@Configuration
@EnableConfigurationProperties(C3p0DataSourceProperties.class)
public class C3p0DatasourceAutoConfigure {

    @Autowired
    private C3p0DataSourceProperties dataSourceProperties;
    /**
     * 提供基于c3p0配置的DataSource實例
     * @return
     */
    @Bean
    public DataSource c3p0DataSource(){
        ComboPooledDataSource dataSource = new ComboPooledDataSource();
        try {
            dataSource.setDriverClass(dataSourceProperties.getDriverClassName());
            dataSource.setJdbcUrl(dataSourceProperties.getUrl());
            dataSource.setUser(dataSourceProperties.getUsername());
            dataSource.setPassword(dataSourceProperties.getPassword());
            return dataSource;
        } catch (PropertyVetoException e) {
            e.printStackTrace();
            new RuntimeException(e.getMessage());
            return null;
        }
    }
}

　　4)定義META-INF/spring.factories 文件

　　在resource目錄下創(chuàng)建META-INF文件夾并創(chuàng)建spring.factories

　　注意：”\ “是換行使用的

　　```properties

　　org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

　　com.itheima.c3p0.autoconfigure.C3p0DatasourceAutoConfigure

　　```

　　5)安裝到本地倉庫

　　如果在idea中，執(zhí)行maven插件中的install。

　　3.3創(chuàng)建 c3p0-spring-boot-stater

　　stater主要導入autoconfigure模塊和相關依賴，不需要編寫任何的代碼。

　　1)編寫pom文件

<?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>
    <groupId>com.itheima</groupId>
    <artifactId>c3p0-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
    <dependencies>
        <dependency>
            <groupId>com.itheima</groupId>
            <artifactId>c3p0-spring-boot-autoconfigure</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--c3p0需要的依賴庫-->
        <dependency>
            <groupId>c3p0</groupId>
            <artifactId>c3p0</artifactId>
            <version>0.9.1.2</version>
        </dependency>
    </dependencies>
</project>

　　c3p0是這個starter必須的依賴，一般是在Starter中正式引入，這樣做的目的是，未來可以在這里進行依賴庫的升級，不需要去更新autoconfigure模塊。

　　2)安裝到本地倉庫

　　如果在idea中，執(zhí)行maven插件中的install。

　　4. 使用c3p0-starter

　　創(chuàng)建 spring-boot-test-c3p0 模塊,依賴c3p0-spring-boot-starter模塊**

　　 1) pom文件中導入spring-boot及數(shù)據(jù)庫相關依賴，包含c3p0-starter依賴。

<!--springboot項目必須的依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!--數(shù)據(jù)庫驅(qū)動-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--自定義c3p0-starter-->
        <dependency>
            <groupId>com.itheima</groupId>
            <artifactId>c3p0-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

　　2)在yaml文件中，配置數(shù)據(jù)源

spring:
  datasource:
    c3p0:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/study_springboot?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
      username: root
      password: root

　　
       2) 在單元測試類中注入數(shù)據(jù)源，測試獲取數(shù)據(jù)庫連接，并測試連接數(shù)據(jù)庫是否成功

　　此時的數(shù)據(jù)源實例，就是基于c3p0的實例

@SpringBootTest
class SpringBootTestC3p0ApplicationTests {

    // 注入c3p0DataSource Bean
    @Autowired
    private DataSource c3p0DataSource;
    @Test
    void testC3p0(){
        try {
            // 直接通過數(shù)據(jù)源獲取數(shù)據(jù)庫連接，并測試連接是否成功
            Connection connection = c3p0DataSource.getConnection();
            PreparedStatement preparedStatement = connection.prepareStatement("SELECT  * from t_user");
            ResultSet resultSet = preparedStatement.executeQuery();
            while (resultSet.next()){
                System.out.println(resultSet.getObject(1)+" "+resultSet.getObject(2));
            }
            connection.close();
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

　　
       四、結束語

　　 通過以上案例的學習，你是否對SpringBoot自動配置有了清晰的理解。正式開發(fā)中，自動配置的情況可能比較復雜，實例化的時候，可能需要很多條件的判斷，判斷某個類是否存在，判斷某個對象是否已經(jīng)存在。如果要實現(xiàn)這些需求，需要用到Condition，這個是在Spring4.0 增加的條件判斷功能，通過這個功能可以實現(xiàn)選擇性的執(zhí)行配置操作(一般就是創(chuàng)建Bean)。感興趣的同學，先學會最基本的自動配置，然后再進一步學習Condition吧。