Лекция 126: Интеграция Spring Cloud Config с микросервисами

Представьте что вы поддерживаете кучу микросервисов, и каждый сервис имеет свои собственные конфигурационные файлы. Один из сервисов поддерживает API, который работает на порту 8081, другой сервис общается с базой данных, а третий отвечает за обработку логов. И тут внезапно приходит запрос от вашей DevOps-команды: "Эй, нам нужно поменять порт API, обновить параметры базы данных и наконец-то настроить Elasticsearch. Сделайте это!"

Бегать по каждому сервису и вручную обновлять конфигурации? Ну уж нет! Это как передавать коллеге файлы проекта на дискете вместо использования Git'а в 2025 году. Интеграция с Config Server позволяет:

1. Обновлять конфигурации централизованно: изменения в одном месте распространяются автоматически для всех сервисов.
2. Обеспечивать согласованность настроек: все сервисы используют одну версию конфигураций.
3. Упростить управление конфиденциальными данными: секреты можно хранить безопасно в таких инструментах, как HashiCorp Vault, и предоставлять доступ только через Config Server.
4. Динамически менять параметры на лету (о да, никакого перезапуска!).

Основы интеграции Config Server с клиентами

Чтобы микросервис мог получать конфигурации из Config Server, он должен быть настроен как клиент. Для этого используются зависимости Spring Cloud Starter Config, которые позволяют автоматически связывать сервис с Config Server и "подтягивать" настройки.

1. Настройка Maven

Первым делом добавим нужные зависимости в pom.xml нашего микросервиса:

<dependencies>
    <!-- Основная зависимость Spring Cloud Config -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
</dependencies>

Убедитесь, что в файле bootstrap.properties (или bootstrap.yml) указаны параметры для подключения к Config Server. Помните: в Spring мир действительно устроен на "магии", и bootstrap файлы загружаются до всех остальных конфигураций.

2. Подключение клиента к Config Server

В bootstrap.yml клиента добавьте настройки для сервера конфигураций:

spring:
  application:
    name: my-awesome-service # Имя вашего микросервиса
  cloud:
    config:
      uri: http://localhost:8888 # Адрес Config Server
      fail-fast: true            # Если сервер недоступен, приложение сразу упадет

• application.name: это важно! Config Server будет искать файл с этим именем (например, my-awesome-service.properties или my-awesome-service.yml) в своем хранилище.
• spring.cloud.config.uri: указывает на адрес Config Server.
• fail-fast: true: параметр, заставляющий приложение "паниковать", если Config Server недоступен. В противном случае приложение будет ждать, пока сервер снова станет доступен, что может затянуть запуск.

3. Проверка работы клиента

После настройки клиента запустите микросервис. Если всё настроено верно, он подтянет конфигурации с Config Server. Вы можете увидеть соответствующие логи:

Fetching config from server at: http://localhost:8888
Located environment: name=my-awesome-service, profiles=[default], label=master

Приложение успешно загрузило конфигурации! Чтобы убедиться, что всё работает правильно, создайте REST-контроллер, который выведет значение переменной из вашего конфигурационного файла:

@RestController
public class ConfigTestController {

    @Value("${custom.property}")
    private String customProperty;

    @GetMapping("/config")
    public String getConfigProperty() {
        return "Value of custom.property: " + customProperty;
    }
}

Теперь добавьте в ваш my-awesome-service.yml на Config Server следующее:

custom:
  property: Hello from Config Server!

Запустите микросервис и перейдите по адресу http://localhost:8080/config. Если всё настроено правильно, вы должны увидеть:

Value of custom.property: Hello from Config Server!

Динамическое обновление конфигураций

Окей, мы настроили базовую интеграцию. Но что, если нам нужно динамически обновлять конфигурации? Использовать магическую кнопку "перезапустить всё"? Нет, давайте сделаем это красиво.

1. Добавляем зависимость Spring Boot Actuator

Добавьте в ваш pom.xml следующую зависимость:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

Spring Boot Actuator добавляет мощные эндпоинты мониторинга и управления приложением.

2. Обновляем параметры на лету с помощью @RefreshScope

Чтобы обновления применялись без перезапуска, используйте аннотацию @RefreshScope. Она "перезагружает" бины, если конфигурация обновилась.

Обновим наш контроллер:

@RestController
@RefreshScope
public class ConfigTestController {

    @Value("${custom.property}")
    private String customProperty;

    @GetMapping("/config")
    public String getConfigProperty() {
        return "Value of custom.property: " + customProperty;
    }
}

3. Вызов обновления через Actuator

Теперь вы можете обновлять конфигурации, делая POST-запрос к /actuator/refresh:

curl -X POST http://localhost:8080/actuator/refresh

После этого изменённые значения будут динамически применяться, без какого-либо перезапуска.

4. Консистентность конфигураций: Spring Cloud Bus

Для автоматической рассылки обновлений всем клиентам можно использовать Spring Cloud Bus. Этот инструмент позволяет расшаривать события изменения конфигураций между микросервисами через брокеры сообщений типа RabbitMQ или Kafka.

Пример настройки RabbitMQ:

spring:
  cloud:
    bus:
      enabled: true
    stream:
      bindings:
        input:
          destination: springCloudBus
        output:
          destination: springCloudBus
      rabbit:
        binder:
          environment:
            spring:
              rabbitmq:
                host: localhost
                port: 5672

Подходы к управлению версиями конфигураций

Никто не застрахован от ошибок в конфигурациях (да, и вы тоже). Вот почему важно управлять версиями конфигураций, чтобы иметь возможность откатиться обратно.

• Используйте Git как репозиторий для конфигураций. Это дает возможность откатов, истории изменений и работы с ветками. Например, для тестовой среды можно использовать ветку dev, а для продакшна — master.
• Добавьте параметр spring.cloud.config.label в bootstrap.yml для указания ветки:

spring:
  cloud:
    config:
      label: dev

Плюсы и минусы подхода

Плюсы:

1. Централизованное управление конфигурациями.
2. Возможность динамически обновлять на лету.
3. Простота интеграции с брокерами сообщений через Spring Cloud Bus.
4. Версионирование через Git.

Минусы:

1. Зависимость от Config Server (если он упадет, это может повлиять на клиенты).
2. Усложнение архитектуры (но без него в микросервисной системе никак).

Теперь вы знаете, как интегрировать Spring Cloud Config с вашими микросервисами, сохранять настройки централизованно, динамически обновлять параметры и избегать лишних перезапусков. Дальше вас ждет изучение механизмов защиты конфиденциальных параметров при помощи HashiCorp Vault!