Spring Boot配置中心使用Consul

Spring Boot 配置中心使用 Consul 可以幫助你集中管理應用程序的配置，提高配置的可維護性和可擴展性。以下是使用 Consul 作為 Spring Boot 配置中心的步驟：

1. 添加依賴

首先，在你的 pom.xml 文件中添加 Spring Cloud Consul 和 Consul 的依賴。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Cloud Consul Starter -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-consul-config</artifactId>
    </dependency>

    <!-- Spring Boot Starter Test -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 配置 Consul

在你的 application.yml 或 application.properties 文件中配置 Consul 的相關信息。

application.yml

spring:
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        enabled: true
      config:
        enabled: true
        format: yaml
        defaultContext: application
        watch: true
        delay: 5000

application.properties

spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500
spring.cloud.consul.discovery.enabled=true
spring.cloud.consul.config.enabled=true
spring.cloud.consul.config.format=yaml
spring.cloud.consul.config.defaultContext=application
spring.cloud.consul.config.watch=true
spring.cloud.consul.config.delay=5000

3. 啟用配置中心

在你的 Spring Boot 主類上添加 @EnableDiscoveryClient 和 @EnableConfigServer 注解，以啟用服務發現和配置中心功能。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.config.server.EnableConfigServer;

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

4. 配置客戶端

在你的 Spring Boot 客戶端應用中，添加 @EnableDiscoveryClient 注解以啟用服務發現功能，并配置 bootstrap.yml 文件以連接到 Consul 配置中心。

bootstrap.yml

spring:
  application:
    name: my-client-app
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        enabled: true
      config:
        enabled: true
        uri: http://localhost:8888/configserver

5. 使用配置

在你的 Spring Boot 客戶端應用中，你可以通過 @Value 注解或 @ConfigurationProperties 注解來使用從 Consul 配置中心獲取的配置。

使用 @Value 注解

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyConfig {
    @Value("${my.config.property}")
    private String myConfigProperty;

    public String getMyConfigProperty() {
        return myConfigProperty;
    }

    public void setMyConfigProperty(String myConfigProperty) {
        this.myConfigProperty = myConfigProperty;
    }
}

使用 @ConfigurationProperties 注解

首先，創建一個配置類并使用 @ConfigurationProperties 注解。

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

@Component
@ConfigurationProperties(prefix = "my.config")
public class MyConfigProperties {
    private String property;

    public String getProperty() {
        return property;
    }

    public void setProperty(String property) {
        this.property = property;
    }
}

然后在你的 Spring Boot 客戶端應用中使用該配置類。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyService {
    @Autowired
    private MyConfigProperties myConfigProperties;

    public void doSomething() {
        System.out.println("My Config Property: " + myConfigProperties.getProperty());
    }
}

通過以上步驟，你就可以在 Spring Boot 應用中使用 Consul 作為配置中心了。