SpringBoot手寫(xiě)自定義starter源碼

更新時(shí)間：2023年10月25日 09:53:08 作者：刻苦的樊同學(xué)

這篇文章主要介紹了SpringBoot手寫(xiě)自定義starter源碼,SpringBoot擁有很多方便使用的starter,比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等,各自都代表了一個(gè)相對(duì)完整的功能模塊,需要的朋友可以參考下

1，前言

（1）SpringBoot的優(yōu)點(diǎn)

SpringBoot是新一代流行的Spring應(yīng)用開(kāi)發(fā)框架，它具有更多的優(yōu)點(diǎn)：

創(chuàng)建獨(dú)立的Spring應(yīng)用
內(nèi)嵌Tomcat、Jetty或Undertow（無(wú)需部署war包）
提供自用的starter來(lái)簡(jiǎn)化構(gòu)建配置
提供指標(biāo)監(jiān)控、運(yùn)行狀況檢查和外部化配置
沒(méi)有代碼生成，也不需要XML配置（約定大于配置）

（2）SpringBoot-starter的作用

SpringBoot擁有很多方便使用的starter（Spring提供的starter命名規(guī)范spring-boot-starter-xxx.jar，第三方提供的starter命名規(guī)范xxx-spring-boot-starter.jar），比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等，各自都代表了一個(gè)相對(duì)完整的功能模塊。

SpringBoot-starter是一個(gè)集成接合器，完成兩件事：

引入模塊所需的相關(guān)jar包
自動(dòng)配置各自模塊所需的屬性

2，為什么要自定義starter？

在我們的日常開(kāi)發(fā)工作中，經(jīng)常會(huì)有一些獨(dú)立于業(yè)務(wù)之外的配置模塊，我們經(jīng)常將其放到一個(gè)特定的包下，然后如果另一個(gè)工程需要復(fù)用這塊功能的時(shí)候，需要將代碼硬拷貝到另一個(gè)工程，重新集成一遍，麻煩至極。如果我們將這些可獨(dú)立于業(yè)務(wù)代碼之外的功配置模塊封裝成一個(gè)個(gè)starter，復(fù)用的時(shí)候只需要將其在pom中引用依賴(lài)即可，SpringBoot為我們完成自動(dòng)裝配，簡(jiǎn)直不要太爽。

3，自定義starter的實(shí)現(xiàn)方式

首先新建一個(gè)maven工程，切記，只是一個(gè)maven工程而已，并非springboot工程！

（1）引入自動(dòng)配置依賴(lài)和自動(dòng)提示依賴(lài)

自動(dòng)提示就是在properties或yml配置文件中輸入時(shí)自動(dòng)提示！

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.0.3.RELEASE</version>
        </dependency>
        <!--輸入properties或yml會(huì)自動(dòng)提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>

（2）寫(xiě)一個(gè)TestBean，裝載信息

public class TestBean {
    private String msg;
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    @Override
    public String toString() {
        return "TestBean{" +
                "msg='" + msg + '\'' +
                '}';
    }
}

（3）寫(xiě)一個(gè)Properties類(lèi)

該類(lèi)上面的注解@ConfigurationProperties(prefix = "hello")是獲取配置文件的配置前綴為hello的值，然后賦值給msg變量

@ConfigurationProperties(prefix = "hello")
public class HelloServiceProperties {
    private static final String MSG="hello world";
    private String msg=MSG;
    public static String getMSG() {
        return MSG;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

（4）寫(xiě)一個(gè)自動(dòng)配置類(lèi) MyAutoConfiguration

引用定義好的配置信息；在A(yíng)utoConfiguration中實(shí)現(xiàn)所有starter應(yīng)該完成的操作，并且把這個(gè)類(lèi)加入spring.factories配置文件中進(jìn)行聲明

@Configuration
@ConditionalOnClass({TestBean.class})//判斷當(dāng)前classpath下是否存在指定類(lèi)，若是則將當(dāng)前的配置裝載入spring容器
@EnableConfigurationProperties(HelloServiceProperties.class)//激活自動(dòng)配置（指定文件中的配置）
public class MyAutoConfiguration {
    @Autowired
    HelloServiceProperties helloServiceProperties;//注入測(cè)試的配置信息類(lèi)
    @Bean
    @ConditionalOnMissingBean(TestBean.class) //當(dāng)前上下文中沒(méi)有TestBean實(shí)例時(shí)創(chuàng)建實(shí)例
    public TestBean getTestService(){
        TestBean testBean=new TestBean();
        testBean.setMsg(helloServiceProperties.getMsg());
        return testBean;
    }
}

完成上面的操作還不夠，最重要的一步是接下來(lái)的一步在resources文件夾下新建文件夾META-INF/spring.factories，將上面的自定義配置類(lèi)MyAutoConfiguration的全路徑名+類(lèi)名配置到該文件中（遵循spring.factories的格式），這樣隨著項(xiàng)目的啟動(dòng)就可以實(shí)現(xiàn)自動(dòng)裝配！文件內(nèi)容

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.ftx.tomcat.bean.MyAutoConfiguration

（5）把本maven項(xiàng)目打包，上傳到maven私服

使用maven構(gòu)建工具打包自定義starter項(xiàng)目

mvn clean install

然后上傳到maven私服上，再新建一個(gè)springboot項(xiàng)目，把私服和starter項(xiàng)目的maven依賴(lài)配置到pom文件中

<dependency>
            <groupId>com.ftx.starter</groupId>
            <artifactId>write-starter</artifactId>
            <version>1.3</version>
        </dependency>
<repositories>
        <repository>
            <id>nexus</id>
            <name>nexus</name>
            <url>http://nexus.tiger2.cn/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

可以找到對(duì)應(yīng)的jar包

在這里插入圖片描述

（6）測(cè)試

在新建的springboot項(xiàng)目中寫(xiě)一個(gè)TestController進(jìn)行測(cè)試注入TestBean，并使用TestBean

@RestController
@RequestMapping("/test")
public class TestController {
    @Autowired
    TestBean testBean;
    @RequestMapping("/user")
    public String user(){
        User user=new User();
        user.setName(testBean.getMsg());
        return user.toString();
    }
}

然后啟動(dòng)項(xiàng)目，訪(fǎng)問(wèn)//localhost:8080/test/user

在這里插入圖片描述