springboot自定義starter啟動器的具體使用實踐

Posted on by

第一步、創建 xxx-spring-boot-starter 的spring Initializr模塊

在這裡插入圖片描述

填寫group 和 artifact其它默認即可

在這裡插入圖片描述

在這裡插入圖片描述

第二步、刪除不需要的內容（啟動類、除下面spring-boot-starter的其它依賴，maven編譯插件）

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

如下是完整的pom.xml
實際上如果當前starter需要引用其它依賴加入到dependences裡面即可,這裡隻做演示項目

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>top.huashengshu</groupId>
    <artifactId>my-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>my-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>11</java.version>
    </properties>

    <dependencies>
        <!--   保留這個依賴即可，其它依賴都刪除     -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

    </dependencies>
</project>

項目結構截圖

在這裡插入圖片描述

第三步、寫代碼，對外提供一些自己寫的類

創建HelloProperties.java,直接復制下面代碼，然後選擇包進行粘貼，Idea會自動創建對應類代碼設置好包名

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "hello") // 對外提供的前綴，相當於其它引入當前starter在properties文件使用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;
    }
}

創建HelloService.java直接復制下面代碼，選擇包進行粘貼即可生成

public class HelloService {

    HelloProperties helloProperties;

    public HelloProperties getHelloProperties() {
        return helloProperties;
    }

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

    public String sayHello(String name){
        return helloProperties.getPrefix() +" "+name +" "+helloProperties.getSuffix();
    }
}

創建配置類(和前面一樣復制粘貼即可)HelloServiceAutoConfiguration.java，將HelloService註入到IOC容器中

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnWebApplication    // 條件配置類，該註解表示在web環境下才生效，相關的其它條件可以使用@ConditionXXX
@EnableConfigurationProperties(HelloProperties.class) // 表示HelloProperties作為配置類使用
public class HelloServiceAutoConfiguration {

    @Autowired
    HelloProperties helloProperties;	// 作為配置類目的就是想在sayHello方法返會的字符串加上前綴和後綴

    @Bean
    public HelloService helloService() { // 將HelloService註入到IOC容器
        HelloService service = new HelloService();
        service.setHelloProperties(helloProperties);
        return service;
    }
}

第四步、在resources資源文件夾下創建一個META-INF文件夾,並創建一個spring.factories文件

如下面截圖

在這裡插入圖片描述

內容則是將@Configuration配置類加入，目的是將配置加入到外部的IOC容器中

org.springframework.boot.autoconfigure.EnableAutoConfiguration=

idea中右鍵copy–》copy reference，將復制的值填入上面=右邊

註意：如果有多個AutoConfiguration則用逗號分開，還有回車小心前面的空格，最好沒有其它字符。

在這裡插入圖片描述

例如:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
top.huashengshu.myspringbootstarter.HelloServiceAutoConfiguration,\
top.yumbo.music.starter.configuration.YumboMusicAutoConfiguration

第五步、將該項目發佈的maven倉庫，或者安裝到本地倉庫中讓其它項目能使用的到

本地安裝為例：

在這裡插入圖片描述

成功後即可

在這裡插入圖片描述

第六步、測試自己定義的啟動器使用有效

創建一個springboot項目
勾選web模塊即可，然後加入自定義啟動器的gav依賴
在啟動類中加入內部類（這裡為瞭方便演示不按照規范創建包）
如下示例代碼

啟動類

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import top.huashengshu.myspringbootstarter.HelloService;

@SpringBootApplication
public class DemoApplication {
	
    @RestController
    public class HelloController {

        @Autowired
        HelloService helloService; // 註入HelloService

        @GetMapping("/hello") // 暴露一個/hello 請求路徑對外提供服務
        public String hello(){
            return helloService.sayHello("zhang san"); // 返回帶有前綴和後綴中間是 "zhang san"的字符串
        }

    }
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

properties文件

因為使用瞭@ConfigurationProperties(prefix = "hello")註解所以在當前項目的properties文件中使用hello前綴調用即可對成員屬性賦值

在這裡插入圖片描述

如下

hello.prefix=HUASHENGSHU
hello.suffix=Hello World

運行當前項目，訪問/hello驗證是否有效

如下：

在這裡插入圖片描述

說明自定義starter成功。

其它業務代碼，根據自己的需求自己加入依賴，也就是說可以自己定義starter提供給其它人用！

到此這篇關於springboot自定義starter啟動器的具體使用實踐的文章就介紹到這瞭,更多相關springboot自定義starter啟動器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：