plugins {
    id 'org.springframework.boot' version '2.7.5'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'java'
}

group = 'com.example'
version = '1.0.0'
sourceCompatibility = '11'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
}

testImplementation 'org.springframework.boot:spring-boot-starter-test'

這里的org.springframework.boot插件用于支持 Spring Boot 項(xiàng)目的構(gòu)建，spring-boot-starter-web依賴與 Maven 中的作用相同 。

3.2 配置文件詳解

Spring Boot 的配置文件主要有application.yml和application.properties兩種格式，它們的作用是相同的，只是語(yǔ)法格式不同。這里以application.yml為例進(jìn)行介紹。

配置文件的作用
配置文件主要用于定義和管理應(yīng)用的各種配置項(xiàng)，如數(shù)據(jù)庫(kù)連接、日志設(shè)置、服務(wù)器端口、Spring Boot 的自動(dòng)配置選項(xiàng)等。通過配置文件，我們可以輕松地對(duì)應(yīng)用進(jìn)行定制化，而無需修改代碼。

常見配置項(xiàng)

1. 服務(wù)器端口配置：可以通過server.port配置項(xiàng)來指定應(yīng)用的啟動(dòng)端口。例如：

server:
  port: 8081

這樣，應(yīng)用啟動(dòng)時(shí)就會(huì)使用 8081 端口，而不是默認(rèn)的 8080 端口。
2. 數(shù)據(jù)源配置：如果項(xiàng)目需要連接數(shù)據(jù)庫(kù)，就需要配置數(shù)據(jù)源相關(guān)信息。以 MySQL 數(shù)據(jù)庫(kù)為例，配置如下：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb?useSSL=false&serverTimezone=UTC
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

這里配置了數(shù)據(jù)庫(kù)的連接 URL、用戶名、密碼以及驅(qū)動(dòng)類名。Spring Boot 會(huì)根據(jù)這些配置自動(dòng)創(chuàng)建數(shù)據(jù)源，并進(jìn)行數(shù)據(jù)庫(kù)連接。
3. 日志配置：可以通過配置文件來設(shè)置日志的級(jí)別、輸出路徑等。例如：

logging:
  level:
    org.springframework: INFO
    com.example: DEBUG
  file:
    name: app.log

上述配置中，org.springframework包下的日志級(jí)別設(shè)置為INFO，com.example包下的日志級(jí)別設(shè)置為DEBUG，日志輸出到app.log文件中。

3.3 自定義自動(dòng)配置

在實(shí)際開發(fā)中，Spring Boot 的默認(rèn)自動(dòng)配置可能無法滿足所有需求，這時(shí)我們就需要進(jìn)行自定義自動(dòng)配置。下面通過一個(gè)實(shí)例來演示如何創(chuàng)建自定義的自動(dòng)配置類。

1. 創(chuàng)建自定義配置屬性類：首先，創(chuàng)建一個(gè)類來綁定配置文件中的屬性。假設(shè)我們要自定義一個(gè)名為MyProperties的配置屬性類，用于配置一些自定義的參數(shù)。

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

@ConfigurationProperties(prefix = "my.custom")
public class MyProperties {
    private String name;
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

在這個(gè)類中，使用@ConfigurationProperties注解，并指定prefix = "my.custom"，表示從配置文件中讀取以my.custom開頭的屬性。例如，在application.yml文件中可以這樣配置：

my.custom:
  name: "張三"
  age: 25

1. 創(chuàng)建自定義自動(dòng)配置類：接下來，創(chuàng)建自定義自動(dòng)配置類MyAutoConfiguration。

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

@Configuration
@ConditionalOnClass(MyService.class)
@EnableConfigurationProperties(MyProperties.class)
public class MyAutoConfiguration {

    @Autowired
    private MyProperties myProperties;

    @Bean
    @ConditionalOnProperty(name = "my.custom.enabled", havingValue = "true")
    public MyService myService() {
        return new MyService(myProperties.getName(), myProperties.getAge());
    }
}

在這個(gè)自動(dòng)配置類中：

• @Configuration注解表明這是一個(gè)配置類。

• @ConditionalOnClass(MyService.class)表示只有當(dāng)MyService類在類路徑中存在時(shí)，這個(gè)自動(dòng)配置類才會(huì)生效。

• @EnableConfigurationProperties(MyProperties.class)用于啟用前面定義的MyProperties配置屬性類，使其能夠讀取配置文件中的屬性。

• @Bean注解定義了一個(gè)名為myService的 Bean。

• @ConditionalOnProperty(name = "my.custom.enabled", havingValue = "true")表示只有當(dāng)配置文件中my.custom.enabled屬性的值為true時(shí)，這個(gè) Bean 才會(huì)被創(chuàng)建 。

1. 創(chuàng)建自定義服務(wù)類：創(chuàng)建MyService類，用于演示自動(dòng)配置的效果。

public class MyService {
    private String name;
    private int age;

    public MyService(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public void sayHello() {
        System.out.println("大家好，我叫 " + name + "，今年 " + age + " 歲。");
    }
}

1. 測(cè)試自定義自動(dòng)配置：在 Spring Boot 應(yīng)用的主類中，添加一個(gè)測(cè)試方法來驗(yàn)證自定義自動(dòng)配置是否生效。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringBootAutoConfigDemoApplication implements CommandLineRunner {

    @Autowired
    private MyService myService;

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

    @Override
    public void run(String... args) throws Exception {
        myService.sayHello();
    }
}

運(yùn)行 Spring Boot 應(yīng)用，如果配置正確，控制臺(tái)會(huì)輸出：“大家好，我叫 張三，今年 25 歲。”，這表明自定義自動(dòng)配置生效了 。

四、自動(dòng)配置高級(jí)應(yīng)用與問題解決

4.1 條件注解的高級(jí)使用

在 Spring Boot 中，@Conditional系列注解為我們提供了根據(jù)不同條件進(jìn)行靈活配置的強(qiáng)大功能。除了前面提到的基本用法，它們還有許多高級(jí)應(yīng)用場(chǎng)景，能夠滿足各種復(fù)雜的業(yè)務(wù)需求 。

4.1.1 @ConditionalOnClass 的深度應(yīng)用

@ConditionalOnClass注解用于判斷類路徑中是否存在指定類，只有當(dāng)指定類存在時(shí)，被注解的配置類或 Bean 才會(huì)生效。在實(shí)際開發(fā)中，我們可以利用它來實(shí)現(xiàn)對(duì)第三方庫(kù)的靈活依賴管理。

假設(shè)我們的項(xiàng)目中可能會(huì)使用到Jackson庫(kù)來處理 JSON 數(shù)據(jù)，但并非所有模塊都需要這個(gè)功能。我們可以創(chuàng)建一個(gè)配置類，只有當(dāng)Jackson庫(kù)在類路徑中存在時(shí)，才配置相關(guān)的 JSON 處理 Bean 。

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnClass(ObjectMapper.class)
public class JsonConfig {

    @Bean
    public ObjectMapper objectMapper() {
        return new ObjectMapper();
    }
}

在這個(gè)例子中，@ConditionalOnClass(ObjectMapper.class)確保只有當(dāng)ObjectMapper類（Jackson庫(kù)的核心類之一）存在于類路徑中時(shí)，JsonConfig配置類才會(huì)生效，其中定義的objectMapper Bean 才會(huì)被創(chuàng)建。這樣，當(dāng)我們?cè)谀承┠K中不需要Jackson庫(kù)時(shí)，只需不引入相關(guān)依賴，就不會(huì)創(chuàng)建這些與Jackson相關(guān)的 Bean，從而減少不必要的資源消耗 。

4.1.2 @ConditionalOnProperty 的復(fù)雜條件設(shè)置

@ConditionalOnProperty注解允許根據(jù)配置文件中的屬性值來決定是否加載某個(gè) Bean 或配置類。除了基本的屬性匹配，它還支持設(shè)置多個(gè)屬性以及使用 SpEL 表達(dá)式來實(shí)現(xiàn)更復(fù)雜的條件判斷。

我們可以通過設(shè)置多個(gè)屬性來控制一個(gè)配置類的生效條件。假設(shè)我們有一個(gè)支付功能的配置類，只有當(dāng)feature.payment.enable屬性為true且feature.payment.type屬性為"online"時(shí)，這個(gè)配置類才生效 。

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnProperty(prefix = "feature.payment", name = {"enable", "type"}, havingValue = "true", matchIfMissing = false)
public class PaymentConfig {

    @Bean
    public PaymentService paymentService() {
        return new PaymentService();
    }
}

在這個(gè)例子中，@ConditionalOnProperty注解指定了多個(gè)屬性，只有當(dāng)feature.payment.enable為true且feature.payment.type為"online"時(shí)，PaymentConfig配置類才會(huì)生效，paymentService Bean 才會(huì)被創(chuàng)建。

此外，@ConditionalOnProperty還可以結(jié)合 SpEL 表達(dá)式來實(shí)現(xiàn)更靈活的條件判斷。比如，我們可以根據(jù)配置文件中的屬性值來決定是否啟用某個(gè)功能模塊 。

import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnExpression("${feature.new-feature.enabled} and ${feature.new-feature.version > 1.0}")
public class NewFeatureConfig {

    @Bean
    public NewFeatureService newFeatureService() {
        return new NewFeatureService();
    }
}

在這個(gè)例子中，@ConditionalOnExpression注解使用了 SpEL 表達(dá)式，只有當(dāng)feature.new-feature.enabled為true且feature.new-feature.version大于1.0時(shí)，NewFeatureConfig配置類才會(huì)生效，newFeatureService Bean 才會(huì)被創(chuàng)建 。

4.2 配置文件加載優(yōu)先級(jí)

在 Spring Boot 應(yīng)用中，配置文件的加載優(yōu)先級(jí)是一個(gè)非常重要的概念。了解不同配置文件的加載順序以及如何利用優(yōu)先級(jí)解決配置沖突問題，對(duì)于確保應(yīng)用的正確運(yùn)行和靈活配置至關(guān)重要 。

4.2.1 優(yōu)先級(jí)順序詳解

Spring Boot 加載配置文件的優(yōu)先級(jí)從高到低依次為：

1. 命令行參數(shù)：通過--前綴傳遞的命令行參數(shù)擁有最高優(yōu)先級(jí)。例如，在啟動(dòng)應(yīng)用時(shí)使用java -jar app.jar --server.port=8081，這個(gè)--server.port=8081參數(shù)會(huì)直接覆蓋其他所有配置源中關(guān)于server.port的配置 。

2. Java 系統(tǒng)屬性：通過-D設(shè)置的 JVM 系統(tǒng)參數(shù)，如java -Dspring.profiles.active=prod -Dlogging.level.root=WARN -jar app.jar。這些系統(tǒng)屬性會(huì)在命令行參數(shù)之后，環(huán)境變量之前被加載 。

3. 操作系統(tǒng)環(huán)境變量：Spring Boot 會(huì)自動(dòng)將形如SPRING_DATASOURCE_URL的大寫下劃線格式環(huán)境變量轉(zhuǎn)換為標(biāo)準(zhǔn)配置項(xiàng)，如spring.datasource.url。在云原生環(huán)境中，這種方式常用于從容器環(huán)境變量中獲取配置信息 。

4. Jar 包外的配置文件：包括config/application.properties（或.yml/.yaml）和application.properties（或.yml/.yaml）。這兩個(gè)位置的配置文件優(yōu)先級(jí)高于 Jar 包內(nèi)的配置文件 。

5. Jar 包內(nèi)的配置文件：BOOT-INF/classes/config/application.properties（或.yml/.yaml）和BOOT-INF/classes/application.properties（或.yml/.yaml）。這些配置文件是項(xiàng)目打包時(shí)包含在 Jar 包內(nèi)的默認(rèn)配置 。

6. @PropertySource 注解：通過@PropertySource注解加載的配置文件，其優(yōu)先級(jí)相對(duì)較低。例如，@PropertySource("classpath:custom.properties")用于加載指定路徑下的配置文件 。

4.2.2 利用優(yōu)先級(jí)解決配置沖突

在實(shí)際開發(fā)中，可能會(huì)出現(xiàn)不同配置文件中存在相同配置項(xiàng)但值不同的情況，這就需要利用配置文件的加載優(yōu)先級(jí)來解決配置沖突問題。

假設(shè)我們的項(xiàng)目中有一個(gè)application.properties文件，其中配置了server.port=8080，同時(shí)在application-dev.yml文件中也配置了server.port=8081。如果我們?cè)趩?dòng)應(yīng)用時(shí)沒有指定任何命令行參數(shù)或其他高優(yōu)先級(jí)的配置，那么最終生效的端口號(hào)將是8081，因?yàn)?code>application-dev.yml文件的優(yōu)先級(jí)高于application.properties文件 。

但是，如果我們?cè)趩?dòng)應(yīng)用時(shí)使用命令行參數(shù)--server.port=8082，那么最終生效的端口號(hào)將是8082，因?yàn)槊钚袇?shù)的優(yōu)先級(jí)最高，會(huì)覆蓋其他所有配置源中的server.port配置 。

通過合理利用配置文件的加載優(yōu)先級(jí)，我們可以在不同環(huán)境下靈活地配置應(yīng)用，同時(shí)避免配置沖突帶來的問題。例如，在開發(fā)環(huán)境中，我們可以在application-dev.yml文件中配置一些開發(fā)專用的參數(shù)，如數(shù)據(jù)庫(kù)連接信息、日志級(jí)別等；而在生產(chǎn)環(huán)境中，我們可以通過命令行參數(shù)或環(huán)境變量來覆蓋這些配置，以確保應(yīng)用在生產(chǎn)環(huán)境中的安全性和性能 。

4.3 常見自動(dòng)配置問題及解決方案

在使用 Spring Boot 自動(dòng)配置的過程中，可能會(huì)遇到各種問題，下面列舉一些常見問題及對(duì)應(yīng)的解決方案 。

4.3.1 依賴沖突問題

問題描述：由于項(xiàng)目中使用了多個(gè)起步依賴，這些依賴可能包含相同庫(kù)的不同版本，從而引發(fā)依賴沖突。比如，某個(gè)依賴需要 A 庫(kù)的 1.0 版本，而另一個(gè)依賴需要 A 庫(kù)的 2.0 版本，這就會(huì)造成類加載錯(cuò)誤或運(yùn)行時(shí)異常 。

解決方案：

1. 使用依賴分析工具：借助 Maven 的dependency:tree命令或者 Gradle 的dependencies任務(wù)，查看項(xiàng)目的依賴樹，找出沖突的依賴。例如，在 Maven 項(xiàng)目中，在命令行中執(zhí)行mvn dependency:tree，可以查看項(xiàng)目所有依賴的層級(jí)結(jié)構(gòu)，從而發(fā)現(xiàn)沖突的依賴 。

2. 排除沖突依賴：在pom.xml（Maven）或build.gradle（Gradle）中，使用exclusions標(biāo)簽排除不需要的依賴版本。例如，在 Maven 中，如果example-library依賴與另一個(gè)依賴存在沖突，可以這樣排除沖突依賴：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>example-library</artifactId>
    <version>1.0.0</version>
    <exclusions>
        <exclusion>
            <groupId>conflicting-group</groupId>
            <artifactId>conflicting-artifact</artifactId>
        </exclusion>
    </exclusions>
</dependency>

1. 強(qiáng)制指定版本：通過dependencyManagement（Maven）或resolutionStrategy（Gradle）強(qiáng)制使用特定版本的依賴。例如，在 Maven 的dependencyManagement中，可以指定某個(gè)依賴的版本，這樣所有依賴該庫(kù)的模塊都會(huì)使用指定的版本 。

4.3.2 配置不生效問題

問題描述：配置文件中的某些配置項(xiàng)沒有生效，導(dǎo)致應(yīng)用的行為不符合預(yù)期。例如，修改了application.yml文件中的server.port配置，但應(yīng)用啟動(dòng)時(shí)仍然使用默認(rèn)端口 。

解決方案：

1. 檢查配置文件路徑和命名：確保配置文件位于正確的路徑下，并且命名符合 Spring Boot 的規(guī)范。例如，application.properties和application.yml文件應(yīng)該位于src/main/resources目錄下，或者按照配置文件加載優(yōu)先級(jí)的順序放置在其他指定位置 。

2. 確認(rèn)配置文件加載順序：了解不同配置文件的加載優(yōu)先級(jí)，檢查是否有高優(yōu)先級(jí)的配置覆蓋了當(dāng)前配置?？梢酝ㄟ^在配置文件中添加一些特殊的配置項(xiàng)，然后查看應(yīng)用啟動(dòng)日志，確認(rèn)配置文件的加載順序和實(shí)際生效的配置 。

3. 檢查配置屬性綁定：如果配置項(xiàng)是通過@ConfigurationProperties注解綁定到 Java 類中的，確保綁定的類和屬性名稱正確，并且在配置文件中使用了正確的前綴。例如，在application.yml文件中配置my.custom.name，對(duì)應(yīng)的@ConfigurationProperties(prefix = "my.custom")注解的 Java 類中應(yīng)該有name屬性 。

五、總結(jié)與展望

5.1 知識(shí)點(diǎn)總結(jié)

本文深入探討了 Spring Boot 自動(dòng)配置這一核心特性。首先介紹了 Spring Boot 在 Java 開發(fā)中的重要地位，以及自動(dòng)配置的概念和重要性，它通過 “約定優(yōu)于配置” 的理念，大大簡(jiǎn)化了開發(fā)過程，提高了開發(fā)效率 。

在核心原理部分，我們剖析了@EnableAutoConfiguration注解作為自動(dòng)配置的核心觸發(fā)點(diǎn)，它借助AutoConfigurationImportSelector類和 Spring Factories 機(jī)制，實(shí)現(xiàn)了自動(dòng)配置類的加載和條件評(píng)估。AutoConfigurationImportSelector通過讀取META-INF/spring.factories文件，篩選出符合條件的自動(dòng)配置類，并將其導(dǎo)入到 Spring 上下文中 。

實(shí)戰(zhàn)演練環(huán)節(jié)，我們通過創(chuàng)建 Spring Boot 項(xiàng)目，詳細(xì)講解了配置文件的作用、常見配置項(xiàng)以及自定義自動(dòng)配置的實(shí)現(xiàn)方法。配置文件用于管理應(yīng)用的各種配置，而自定義自動(dòng)配置則讓我們能夠根據(jù)實(shí)際需求對(duì)默認(rèn)配置進(jìn)行定制化 。

在高級(jí)應(yīng)用與問題解決部分，我們深入探討了條件注解的高級(jí)使用，如@ConditionalOnClass和@ConditionalOnProperty的深度應(yīng)用，以及配置文件加載優(yōu)先級(jí)和常見自動(dòng)配置問題的解決方案，這些知識(shí)對(duì)于解決復(fù)雜的開發(fā)場(chǎng)景和問題非常關(guān)鍵 。

5.2 知識(shí)擴(kuò)展

Spring Boot 自動(dòng)配置在微服務(wù)架構(gòu)中發(fā)揮著重要作用。它與 Spring Cloud 等微服務(wù)框架結(jié)合，能夠?qū)崿F(xiàn)服務(wù)的自動(dòng)配置、注冊(cè)與發(fā)現(xiàn)、負(fù)載均衡等功能。例如，在基于 Spring Cloud 的微服務(wù)項(xiàng)目中，Spring Boot 的自動(dòng)配置可以幫助我們快速搭建 Eureka 服務(wù)注冊(cè)中心、Ribbon 客戶端負(fù)載均衡器等組件，使得微服務(wù)之間的通信和協(xié)作更加便捷 。

在云原生開發(fā)領(lǐng)域，Spring Boot 自動(dòng)配置也有廣闊的應(yīng)用前景。它可以與容器編排工具（如 Kubernetes）、云服務(wù)提供商（如 AWS、Azure、阿里云）的服務(wù)相結(jié)合，實(shí)現(xiàn)應(yīng)用的自動(dòng)化部署、彈性伸縮和配置管理。通過自動(dòng)配置，我們可以輕松地將 Spring Boot 應(yīng)用部署到容器中，并利用云原生技術(shù)的優(yōu)勢(shì)，提高應(yīng)用的性能和可靠性 。

5.3 推薦閱讀資料

1. Spring Boot 官方文檔：這是最權(quán)威的學(xué)習(xí)資料，詳細(xì)介紹了 Spring Boot 的各種特性和用法，包括自動(dòng)配置的原理和配置選項(xiàng)。地址：https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ 。

2. 《Spring Boot 實(shí)戰(zhàn)》：這本書由 Craig Walls 撰寫，是學(xué)習(xí) Spring Boot 的經(jīng)典書籍，深入講解了 Spring Boot 的核心概念和實(shí)踐應(yīng)用，包括自動(dòng)配置、起步依賴等內(nèi)容。

3. Spring Boot 官方博客：官方博客會(huì)發(fā)布 Spring Boot 的最新動(dòng)態(tài)、特性介紹和使用案例，有助于我們及時(shí)了解 Spring Boot 的發(fā)展趨勢(shì)和最佳實(shí)踐。地址：https://spring.io/why-spring 。

總結(jié)

到此這篇關(guān)于JAVA進(jìn)階之Spring Boot自動(dòng)配置的文章就介紹到這了,更多相關(guān)SpringBoot自動(dòng)配置詳解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！