Spring Cloud Config：配置变更后如何强制客户端自动刷新属性

Great question! Manually hitting /refresh every time your config changes is definitely a pain—let’s fix that with automatic, event-driven refreshes. Here’s the step-by-step solution using Spring Cloud’s official tools:

Core Solution: Spring Cloud Bus + Message Broker (RabbitMQ/Kafka) #

This is the most scalable approach for multi-client setups. Spring Cloud Bus uses a message broker to broadcast config change events from the Config Server to all connected clients, triggering automatic refreshes.

1. Add Required Dependencies #

First, add the necessary dependencies to both your Config Server and all client applications.

For Config Server (Maven example):

<dependencies>
    <!-- Core Config Server -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
    <!-- Spring Cloud Bus for event broadcasting (using RabbitMQ here) -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bus-amqp</artifactId>
    </dependency>
    <!-- Actuator for exposing management endpoints -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

For Client Applications (Maven example):

<dependencies>
    <!-- Config Client -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <!-- Spring Cloud Bus to listen for refresh events -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bus-amqp</artifactId>
    </dependency>
    <!-- Actuator (required for refresh mechanics) -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

2. Configure the Config Server #

Update your Config Server's application.yml (or application.properties) to enable the bus, connect to your message broker, and expose the bus refresh endpoint:

server:
  port: 8888

spring:
  cloud:
    config:
      server:
        git:
          uri: https://your-git-repo-url.git # Replace with your config repo
          search-paths: config-files # Optional: if your configs are in a subfolder
          label: main # Your Git branch
    bus:
      enabled: true # Enable Spring Cloud Bus
  rabbitmq:
    host: localhost # Your RabbitMQ host
    port: 5672
    username: guest
    password: guest

management:
  endpoints:
    web:
      exposure:
        include: busrefresh # Expose the bus refresh endpoint

3. Configure Client Applications #

In each client's bootstrap.yml (critical for early config loading), set up the Config Server connection, enable the bus, and connect to the message broker:

spring:
  cloud:
    config:
      uri: http://localhost:8888 # Your Config Server URL
      name: your-config-file # Name of your config file in Git
      profile: default # Your active profile
      label: main
    bus:
      enabled: true # Listen for bus events
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

management:
  endpoints:
    web:
      exposure:
        include: refresh # Expose refresh endpoint (optional but useful for testing)

Then, add @RefreshScope to any bean that needs to reload config properties when changes occur. This tells Spring to refresh the bean's values when a refresh event is received:

@RestController
@RefreshScope // This enables auto-refresh for this bean
public class ConfigController {

    @Value("${app.greeting}") // Your config property from Git
    private String greeting;

    @GetMapping("/greet")
    public String getGreeting() {
        return greeting;
    }
}

4. Set Up Git Webhook #

To trigger the refresh automatically when your Git config changes, set up a webhook in your Git repository (GitHub, GitLab, etc.):

• Go to your repo's Settings > Webhooks
• Add a new webhook with:
  • Payload URL: http://your-config-server-domain/actuator/busrefresh (replace with your Config Server's public URL)
  • Content Type: application/json
  • Trigger Event: Select "Just the push event" (so it fires when you push config changes)
• Save the webhook.

5. Verify the Flow #

1. Start your message broker (RabbitMQ/Kafka), Config Server, and client apps.
2. Update a config property in your Git repo and push the changes.
3. The Git webhook sends a POST request to the Config Server's /actuator/busrefresh endpoint.
4. The Config Server broadcasts a refresh event to all clients via the message broker.
5. Clients receive the event, reload their config properties, and update beans marked with @RefreshScope.
6. Test your client's endpoint (e.g., /greet) to confirm the new config value is active.

Alternative: Single-Client Manual Trigger (Not Scalable) #

If you only have one client and don't want to use a message broker, you can set up the Config Server to listen for Git events and call the client's /refresh endpoint directly. However, this isn't recommended for multi-client setups:

1. Add a Git event listener in the Config Server to detect config changes.
2. Use a REST template to send a POST request to the client's http://client-url/actuator/refresh endpoint when a change is detected.

But stick with Spring Cloud Bus for any production setup—it's designed for this exact use case.

内容的提问来源于stack exchange，提问作者Yaroslav Lukianenko