1 profile功能

1.1 profile的生效規(guī)則

為了方便多環(huán)境適配，SpringBoot簡(jiǎn)化了profile功能，具體的使用規(guī)則如下： ①在resources文件夾下可以一次創(chuàng)建多個(gè)application-xxx.yaml配置文件，分別對(duì)應(yīng)著不同的生產(chǎn)、測(cè)試等環(huán)境，但是只有命名為application.yaml(或者后綴.properties的文件)文件會(huì)默認(rèn)加載，所以說(shuō)其他環(huán)境的配置文件中的配置信息都不會(huì)生效。

??②如果是想切換配置文件環(huán)境的話(huà)，就可以在默認(rèn)配置文件中配置

spring:
profiles:
active: test

??③當(dāng)不同配置文件的配置項(xiàng)產(chǎn)生沖突的時(shí)候，首先若是其他環(huán)境都沒(méi)有激活的話(huà)使用默認(rèn)配置文件的配置，若是在默認(rèn)配置文件中激活了其他環(huán)境的配置就按激活的配置

??④使用命令行運(yùn)行jar包期間可以不用重新修改配置文件再次打包，可以通過(guò)命令行參數(shù)配置進(jìn)行修改激活的環(huán)境。首先需要對(duì)項(xiàng)目進(jìn)行打包并打開(kāi)jar包的存儲(chǔ)位置

進(jìn)入dos窗口輸入命令修改環(huán)境并運(yùn)行jar包

java -jar test-profile-0.0.1-SNAPSHOT.jar --spring.profiles.active=test

⑤我們?cè)摽梢允褂聾Profile(“xxx”)注解標(biāo)注在類(lèi)、方法或參數(shù)綁定上，表示在指定環(huán)境下才會(huì)執(zhí)行該類(lèi)、方法或者進(jìn)行配置文件與POJO類(lèi)的綁定

1.2 外部配置源

??常用可以作為外部配置源的有：Java屬性文件、YAML文件、環(huán)境變量、命令行參數(shù)。其中配置文件的默認(rèn)掃描位置也不只單單一個(gè)，以下五個(gè)位置都能被SpringBoot默認(rèn)掃到，加載順序由高到低但是優(yōu)先級(jí)相反(也就是說(shuō)配置項(xiàng)相同的時(shí)候后面的可以覆蓋前面的)：(1) classpath 根路徑(2) classpath 根路徑下config目錄(3) 項(xiàng)目jar包同層級(jí)(4) 項(xiàng)目jar包同層級(jí)的config目錄(5) config目錄的直接子目錄

2 自定義starter

??SpringBoot的starter場(chǎng)景啟動(dòng)器想必大家都不陌生，在SpringBoot開(kāi)發(fā)的時(shí)候不管進(jìn)行什么開(kāi)發(fā)只要用到哪種技術(shù)第一都是引入它的starter場(chǎng)景啟動(dòng)器，接下來(lái)讓我們根據(jù)SpringBoot中的源碼自定義一個(gè)場(chǎng)景啟動(dòng)器。

第一步： 使用Spring Initializr創(chuàng)建一個(gè)SpringBoot項(xiàng)目作為autoconfiguration，構(gòu)建項(xiàng)目目錄如下：

封裝自定義starter業(yè)務(wù)的HelloService

/**
 * @author : mereign
 * @date : 2022/3/12 - 20:55
 * @desc : service組件，內(nèi)部定義了方法
 */
public class HelloService {

    @Autowired
    HelloProperties helloProperties;

    public String sayHello(String userName) {
        return helloProperties.getPrefix() + "：" + userName + "》" + helloProperties.getSuffix();
    }
}

封裝配置文件屬性的HelloProperties

/**
 * @author : mereign
 * @date : 2022/3/12 - 20:57
 * @desc :  配置文件的屬性封裝，默認(rèn)自動(dòng)導(dǎo)入容器中
 */
@ConfigurationProperties("com.xiaochen")
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;
    }
}

決定是否注冊(cè)組件的自動(dòng)配置類(lèi)HelloServiceAutoConfiguration

/**
 * @author : mereign
 * @date : 2022/3/12 - 21:04
 * @desc : 一個(gè)自動(dòng)配置類(lèi)，決定是否向容器中注冊(cè)service組件，以及配置文件綁定
 */

// 表明這是一個(gè)配置類(lèi)
@Configuration
// 配置文件綁定
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {

	// 如果容器中沒(méi)有這個(gè)組件就是用下面的方法進(jìn)行容器的helloService組件注入，如果有的話(huà)就用容器中的
	@ConditionalOnMissingBean(HelloService.class)
    // 容器注入組件
    @Bean
    public HelloService helloService() {
        HelloService helloService = new HelloService();
        return helloService;
    }
}

resources文件夾下創(chuàng)建MATE-INF目錄下spring.factories文件，這樣才能加載到指定的自動(dòng)配置類(lèi)

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.xiaochen.auto.HelloServiceAutoConfiguration

第二步： 創(chuàng)建一個(gè)maven項(xiàng)目作為自定義starter，只需要在它的pom文件中導(dǎo)入autoconfiguration的項(xiàng)目依賴(lài)

<dependencies>
    <dependency>
        <groupId>com.xiaochen</groupId>
        <artifactId>test-autoconfigure</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

第三步： 分別對(duì)兩個(gè)項(xiàng)目模塊在生命周期中選擇clean和install，將兩個(gè)模塊打成jar包

第四步： 創(chuàng)建測(cè)試項(xiàng)目，目錄結(jié)構(gòu)如下

pom文件中導(dǎo)入自定義的starter

<dependency>
    <groupId>com.xiaochen</groupId>
    <artifactId>test-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

創(chuàng)建一個(gè)測(cè)試使用的controller

@RestController
public class HelloController {

    @Autowired
    HelloService helloService;

    @GetMapping("/hel")
    public String sayHello() {
        return helloService.sayHello("張三");
    }
}

配置測(cè)試項(xiàng)目的配置文件

com.xiaochen.prefix=jaka
com.xiaochen.suffix=hafd

啟動(dòng)測(cè)試項(xiàng)目訪(fǎng)問(wèn)controller的請(qǐng)求映射

到此這篇關(guān)于SpringBoot2零基礎(chǔ)到精通之profile功能與自定義starter的文章就介紹到這了,更多相關(guān)SpringBoot2 profile內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論