深入淺出 Spring Boot 多重設定檔管裡 (Spring Profiles)

小灰灰 2024-05-23 22:02 45阅读 0赞

在任何一套開發框架中， **多環境管裡** 通常是重要的核心功能之一，當然在 Spring 框架中也不例外，這裡我們稱為 [Spring Profiles][] 設定檔。這個功能說起來簡單，但實作起來卻很容易會不小心亂掉，這篇文章我打算來好好的梳理一番，把觀念搞懂，管裡才不會亂掉。

![36392f0077274c6ab614a33741de747f.png][]

#### 建立範例應用程式 ####

1.  使用 Spring Boot CLI 快速建立專案 (也可以用 [Spring Initializr][] 建立)
    
        spring init --dependencies=web --groupId=com.duotify sbprofile1
    
    使用 Visual Studio Code 開啟該專案
    
        code sbprofile1
2.  加入一個 `HomeController` 控制器
    
    檔名路徑: `src/main/java/com/duotify/sbprofile1/controllers/HomeController.java`
    
        package com.duotify.sbprofile1.controllers;
        
        import org.springframework.web.bind.annotation.GetMapping;
        import org.springframework.web.bind.annotation.RestController;
        
        @RestController
        public class HomeController {
            @GetMapping("/")
            public String home() {
                return "Hello World";
            }
        }
3.  測試執行
    
        mvn clean spring-boot:run
    
    補充說明: 你可以在 `pom.xml` 的 `<build>` 底下新增一個 `<defaultGoal>spring-boot:run</defaultGoal>` 設定，未來就只要打 `mvn` 就會自動啟動 Spring Boot 執行喔！ :+1:
    
    使用 cURL 測試
    
        $ curl localhost:8080
        Hello World

#### 理解設定檔(Profiles)的真正含意 ####

由於 Spring 框架有一大堆抽象概念，不好好花點時間研究，就會有很多魔鬼般的細節無法理解。本文所提到的 Spring Profiles 原本是一個很簡單的概念，但是在寫 Spring Boot 的時候卻有非常多種變化，多到可以讓你腦袋打結那種。

我們先從最簡單、最抽象的概念開始講起。

所謂 **Profile** (設定檔) 通常有個 **名字** (Profile Name)，這個 **名字** 代表一組 **應用程式配置** 。你可以透過一個簡單的 **設定名稱** (Profile Name)，快速的切換 **應用程式配置** ，就這麼簡單！

其中 **應用程式配置** 包含了兩層含意：

1.  組態配置(Configuration)
    
    所謂 **組態配置** 其實就是像 `src/main/resources/application.properties` 這種屬性定義檔。
2.  應用程式元件組合(Components combination)
    
    所謂 **應用程式元件組合** 就是指應用程式中有哪些「元件」要啟用，你可以在 **執行時期** 透過簡單的參數，決定本次執行要用什麼 **Profile** 來啟動應用程式。

使用 **Profile** 來管裡 **應用程式配置** ，最常見的例子，就是用在「多環境」部署上，例如你有公司內部的「測試環境」與客戶提供的「正式環境」，兩者的組態設定通常都不太一樣，但也有些一樣的地方。此時，我們就可以透過多個 **Profile** 來管裡這些差異，抽象化之後，我們只要知道 **設定名稱** (Profile Name)就可以切換不同環境。

#### 如何使用應用程式屬性(Application Properties) ####

在理解如何 **管裡多個設定檔** 之前，應該要先瞭解 **應用程式屬性** (Application Properties)應該怎麼用。

體驗的步驟如下：

1.  編輯 `src/main/resources/application.properties` 屬性檔
    
    加入一個 `my.profile` 屬性值
    
        my.profile=dev
2.  調整 `HomeController` 控制器，加入一個私有欄位(Private Field)，並透過 `@Value` 標注來注入一個 `my.profile` 屬性值
    
    檔名路徑: `src/main/java/com/duotify/sbprofile1/controllers/HomeController.java`
    
        package com.duotify.sbprofile1.controllers;
        
        import org.springframework.beans.factory.annotation.Value;
        import org.springframework.web.bind.annotation.GetMapping;
        import org.springframework.web.bind.annotation.RestController;
        
        @RestController
        public class HomeController {
        
            @Value("${my.profile}")
            private String myProfile;
        
            @GetMapping("/")
            public String home() {
                return "Hello World: " + this.myProfi

[Spring Profiles]: https://www.baeldung.com/spring-profiles
[36392f0077274c6ab614a33741de747f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/00f2f2bfb7ad4f4892538e24d94455a1.png
[Spring Initializr]: https://start.spring.io/