SpringBoot學習之路---自定義starter

好久沒有更新博客了，今天來記錄一下starter的內部依賴原理，並自定義一個starter

---

starter是個啥，之前我的博客中已經反覆提到了，簡單來看它是一個場景啓動器，一個又一個starter包含了我們所需要的一系列依賴。我們只需要導入它，剩下的一系列maven依賴&各種組件的配置等等，都不需要我們的擔心了。

這是爲什麼呢？

首先先來看看，每個starter內部都會或多或少依賴於別的maven座標，比如spring-boot-starter-jdbc這個場景啓動器，它內部依賴於：

<dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.2.6.RELEASE</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>com.zaxxer</groupId>
      <artifactId>HikariCP</artifactId>
      <version>3.4.2</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>5.2.5.RELEASE</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>

主要依賴於jdbc、hikariCP數據源、spring-boot-starter，最後面的這個spring-boot-starter是每個starter都會依賴到的，而前面兩個是數據庫操作時所需要用到的。

由此可以看出每個starter內部所依賴的maven座標都不盡相同，starter在這裏扮演一個"調用者"的角色,負責把其他的所依賴jar包導入進來，如果我們要自定義的話，我們可以根據要應用到的場景從而導入jar包。

而在現實的開發中，我們自定義的starter不僅要完成依賴導入的功能，還要做自動配置組件的工作，就是編寫一個自動配置類。這個往往是我們在另外編寫一個自動配置模塊(和自定義starter不在同一個模塊中)，之後我們自定義的starter依賴於編寫的自動配置模塊即可。

現在開始編寫代碼（starter的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.atguigu.starter</groupId>
    <artifactId>atguigu-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--啓動器-->
    <dependencies>

        <!--引入自動配置模塊-->
        <dependency>
            <groupId>com.leslie.starter</groupId>
            <artifactId>leslie-spring-boot-starter-autoconfigurer</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

</project>

自動配置模塊的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.atguigu.starter</groupId>
   <artifactId>atguigu-spring-boot-starter-autoconfigurer</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

   <name>atguigu-spring-boot-starter-autoconfigurer</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.10.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>

   <dependencies>

      <!--引入spring-boot-starter；所有starter的基本配置-->
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter</artifactId>
      </dependency>

   </dependencies>



</project>

因爲不需要太多功能，所以自動配置模塊只引入了一個spring-boot-starter，前期的maven依賴搞定後，我們需要編寫一個自動配置類，來幫容器中自動配置組件

該方法需要幾個步驟:

1. 編寫一個xxxProperties，並使用@ConfigurationProperties來綁定到全局配置文件。
2. 編寫一個方法，該方法可以根據全局配置文件所配置的屬性值來完成某些功能。
3. 編寫一個自動配置類(重點),在內部調用2編寫的方法，並使用@Bean註解加入到容器中。想要讓自動配置類生效，之前的博客記錄過自動配置的原理，需要幫我們編寫的自動配置類放到項目下的META-INF/spring.factories目錄下，類似

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
你自己編寫的自動配置類的全限定類名,\

我們就來編寫個簡單的功能，HelloProperties:

@ConfigurationProperties(prefix = "leslie.hello") //綁定到配置文件中
public class HelloProperties {

    private String prefix;
    private String suffix;

    public String getPrefix() {
        return prefix;
    }

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    public String getSuffix() {
        return suffix;
    }

    public void setSuffix(String suffix) {
        this.suffix = suffix;
    }
}

編寫一個方法，用於返回配置文件中所配置的屬性:

public class HelloService {

    HelloProperties helloProperties;

    public HelloProperties getHelloProperties() {
        return helloProperties;
    }

    public void setHelloProperties(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

    public String sayHellAtguigu(String name){
        return helloProperties.getPrefix()+"-" +name + helloProperties.getSuffix(); //調用該方法可以返回字符串
    }
}

之前的做完了，接下來我們需要讓編寫的HelloService類生效，我們編寫一個自動配置類

@Configuration
@ConditionalOnWebApplication //web應用才生效
@EnableConfigurationProperties(HelloProperties.class) //讓Helloproperties生效
public class HelloServiceAutoConfiguration {

    @Autowired
    HelloProperties helloProperties;
    
    //將HelloService註冊到容器中
    @Bean
    public HelloService helloService(){
        HelloService service = new HelloService();
        service.setHelloProperties(helloProperties);
        return service;
    }
}

最後再把HelloServiceAutoConfiguration配置到META-INF/spring.factories即可：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.leslie.starter.HelloServiceAutoConfiguration,\

之後在編寫一個Controller來測試一下既可，這裏略過。

記得有點雜亂，但還是很感謝你們的觀看🙏