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://127.0.0.1:8888 配置服务器。

application.properties

spring.application.name = config-client
spring.config.import=optional:configserver:https://127.0.0.1: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://127.0.0.1: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://127.0.0.1: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://127.0.0.1:8888/

现在点击 URL,https://127.0.0.1:8080/ 欢迎消息从配置服务器加载。

Spring Cloud Config Server

现在,转到配置服务器更改属性值,然后点击执行器端点 POST URL https://127.0.0.1:8080/refresh,并在 URL https://127.0.0.1:8080/ 中查看新的配置属性值。

广告