SpringBoot詳解自定義Stater的應用

2022-07-15 14:05:55

1、SpringBoot starter機制

SpringBoot由眾多Starter組成（一系列的自動化設定的starter外掛），SpringBoot之所以流行，也是因為starter。starter是SpringBoot非常重要的一部分，可以理解為一個可拔插式的外掛，正是這些starter使得使用某個功能的開發者不需要關注各種依賴庫的處理，不需要具體的設定資訊，由Spring Boot自動通過classpath路徑下的類發現需要的Bean，並織入相應的Bean。

例如，你想使用Reids外掛，那麼可以使用spring-boot-starter-redis；如果想使用MongoDB，可以使用spring-boot-starter-data-mongodb

2、為什麼要自定義starter

開發過程中，經常會有一些獨立於業務之外的設定模組。如果我們將這些可獨立於業務程式碼之外的功能設定模組封裝成一個個starter，複用的時候只需要將其在pom中參照依賴即可，SpringBoot為我們完成自動裝配

3、自定義starter的命名規則

SpringBoot提供的starter以spring-boot-starter-xxx 的方式命名的。官方建議自定義的starter使用xxx-spring-boot-starter 命名規則。以區分SpringBoot生態提供的starter

整個過程分為兩部分：

自定義starter
使用starter

首先，先完成自定義starter

（1）新建maven jar工程，工程名為zdy-spring-boot-starter，匯入依賴：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <version>2.2.2.RELEASE</version>
    </dependency>
</dependencies>

（2）編寫javaBean

package com.lagou;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
@EnableConfigurationProperties(SimpleBean.class) // 開啟@ConfigurationProperties
@ConfigurationProperties(prefix = "simplebean")
public class SimpleBean {
    private int id;
    private String name;
    @Override
    public String toString() {
        return "SimpleBean{" +
                "id=" + id +
                ", name='" + name + ''' +
                '}';
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

（3）編寫設定類MyAutoConfiguration

package com.lagou.config;
import com.lagou.SimpleBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConditionalOnClass// 註解：當類路徑classpath下有指定類的情況，就會進行自動設定
public class MyAutoConfiguration {
    static {
        System.out.println("MyAutoConfiguration init....");
    }
    @Bean
    public SimpleBean simpleBean() {
        return new SimpleBean();
    }
}

（4）resources下建立/META-INF/spring.factories

注意：META-INF是自己手動建立的目錄，spring.factories也是手動建立的檔案,在該檔案中設定自己的自動設定類

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.lagou.config.MyAutoConfiguration

4、使用自定義starter

（1）匯入自定義starter的依賴

<dependency>
    <groupId>com.lagou</groupId>
    <artifactId>zdy-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

（2）在全域性組態檔中設定屬性值

simplebean.id=1
simplebean.name=自定義starter

（3）編寫測試方法

//測試自定義starter
@Autowired
private SimpleBean simpleBean;
@Test
public void zdyStarterTest(){
    System.out.println(simpleBean);
}

到此這篇關於SpringBoot詳解自定義Stater的應用的文章就介紹到這了,更多相關SpringBoot Stater內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

SpringBoot詳解自定義Stater的應用

目錄

1、SpringBoot starter機制

2、為什麼要自定義starter

3、自定義starter的命名規則

4、使用自定義starter

熱門文章