Spring Boot - 雲配置客戶端



某些應用程式可能需要配置屬性,這些屬性可能需要更改,開發人員可能需要將其關閉或重新啟動應用程式以執行此操作。但是,這可能會導致生產環境中出現停機時間,並且需要重新啟動應用程式。Spring Cloud 配置伺服器允許開發人員在不重新啟動應用程式且沒有任何停機時間的情況下載入新的配置屬性。

使用 Spring Cloud 配置客戶端

首先,從 https://start.spring.io/ 下載 Spring Boot 專案,並選擇 Spring Cloud Config Client 依賴項。

Creating Spring Cloud Configuration Client

它將在您的構建配置檔案中新增 Spring Cloud Starter Config 依賴項。

Maven 使用者可以將以下依賴項新增到 pom.xml 檔案中。

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

Gradle 使用者可以將以下依賴項新增到 build.gradle 檔案中。

compile('org.springframework.cloud:spring-cloud-starter-config')

現在,您需要將 @RefreshScope 註解新增到您的主要 Spring Boot 應用程式中。@RefreshScope 註解用於從 Config 伺服器載入配置屬性值。

package com.tutorialspoint.configclient;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.context.config.annotation.RefreshScope;

@SpringBootApplication
@RefreshScope
public class ConfigclientApplication {
   public static void main(String[] args) {
      SpringApplication.run(ConfigclientApplication.class, args);
   }
}

現在,在您的 application.properties 檔案中新增 config 伺服器 URL 並提供您的應用程式名稱。

注意 - 在啟動 config 客戶端應用程式之前,應執行 https://:8888 配置伺服器。

application.properties

spring.application.name = config-client
spring.config.import=optional:configserver:https://:8888/

下面給出了編寫簡單 REST 端點以從配置伺服器讀取歡迎訊息的程式碼 -

ConfigclientApplication.java

package com.tutorialspoint.configclient;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RefreshScope
@RestController
public class ConfigclientApplication {
   @Value("${welcome.message}")
   String welcomeText;
   
   public static void main(String[] args) {
      SpringApplication.run(ConfigclientApplication.class, args);
   }
   @GetMapping(value = "/")
   public String welcomeText() {
      return welcomeText;
   }
}

編譯和執行

您可以建立一個可執行的 JAR 檔案,並使用以下 Maven 或 Gradle 命令執行 Spring Boot 應用程式 -

對於 Maven,您可以使用以下所示的命令 -

mvn clean install

“BUILD SUCCESS”後,您可以在 target 目錄下找到 JAR 檔案。

對於 Gradle,您可以使用以下所示的命令 -

gradle clean build

“BUILD SUCCESSFUL”後,您可以在 build/libs 目錄下找到 JAR 檔案。

現在,使用此處顯示的命令執行 JAR 檔案

java –jar <JARFILE> 

現在,應用程式已在 Tomcat 埠 8080 上啟動,如下所示 -

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/

[32m :: Spring Boot :: [39m              [2m (v3.3.3)[0;39m

[2m2024-09-12T13:19:17.562+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mc.t.c.ConfigclientApplication           [0;39m [2m:[0;39m Starting ConfigclientApplication using Java 21.0.3 with PID 10964 (E:\Dev\configclient\target\classes started by Tutorialspoint in E:\Dev\configclient)
[2m2024-09-12T13:19:17.565+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mc.t.c.ConfigclientApplication           [0;39m [2m:[0;39m No active profile set, falling back to 1 default profile: "default"
[2m2024-09-12T13:19:17.618+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.s.c.c.c.ConfigServerConfigDataLoader  [0;39m [2m:[0;39m Fetching config from server at : https://:8888/
[2m2024-09-12T13:19:17.618+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.s.c.c.c.ConfigServerConfigDataLoader  [0;39m [2m:[0;39m Located environment: name=config-client, profiles=[default], label=null, version=8081e552232ca5b1af29cef56e6acc6e1a5bd2e3, state=null
[2m2024-09-12T13:19:18.231+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.s.cloud.context.scope.GenericScope    [0;39m [2m:[0;39m BeanFactory id=ab070e4d-4225-30e3-b1c0-b54af129a3cc
[2m2024-09-12T13:19:18.509+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.s.b.w.embedded.tomcat.TomcatWebServer [0;39m [2m:[0;39m Tomcat initialized with port 8080 (http)
[2m2024-09-12T13:19:18.528+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.apache.catalina.core.StandardService  [0;39m [2m:[0;39m Starting service [Tomcat]
[2m2024-09-12T13:19:18.528+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.apache.catalina.core.StandardEngine   [0;39m [2m:[0;39m Starting Servlet engine: [Apache Tomcat/10.1.28]
[2m2024-09-12T13:19:18.727+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.a.c.c.C.[Tomcat].[localhost].[/]      [0;39m [2m:[0;39m Initializing Spring embedded WebApplicationContext
[2m2024-09-12T13:19:18.728+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mw.s.c.ServletWebServerApplicationContext[0;39m [2m:[0;39m Root WebApplicationContext: initialization completed in 1107 ms
[2m2024-09-12T13:19:19.140+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.s.b.w.embedded.tomcat.TomcatWebServer [0;39m [2m:[0;39m Tomcat started on port 8080 (http) with context path '/'
[2m2024-09-12T13:19:19.159+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mc.t.c.ConfigclientApplication           [0;39m [2m:[0;39m Started ConfigclientApplication in 2.528 seconds (process running for 3.334)

您可以在控制檯視窗中看到日誌;config-client 應用程式正在從 https://:8888 獲取配置。

[2m2024-09-12T13:19:17.618+05:30[0;39m [32m INFO[0;39m [35m10964[0;39m [2m---[0;39m [2m[config-client] [           main][0;39m [2m[0;39m[36mo.s.c.c.c.ConfigServerConfigDataLoader  [0;39m [2m:[0;39m Fetching config from server at : https://:8888/

現在點選 URL,https://:8080/ 歡迎訊息從配置伺服器載入。

Spring Cloud Config Server

現在,轉到配置伺服器更改屬性值,然後點選執行器端點 POST URL https://:8080/refresh,並在 URL https://:8080/ 中檢視新的配置屬性值。

廣告