Centraliserad konfiguration med Config Server

I en mikrotjänstarkitektur kan du ha många tjänster, var och en med sina egna konfigurationsfiler. Att hantera dessa filer separat kan bli en stor utmaning.

Föreställ dig att uppdatera en databasanslutningssträng i 20 olika tjänster! Det är både felkänsligt och tidskrävande.

• Decentraliserade konfigurationer: Svåra att hantera i stor skala.
• Inkonsistenta konfigurationer: Olika tjänster kan ha något varierande inställningar.
• Manuella uppdateringar: Omständliga och riskfyllda.

Spring Cloud Config Server tillhandahåller en centraliserad, extern konfigurationstjänst för distribuerade system. Den är byggd på Spring Boot och kan enkelt integreras med olika alternativ för backend-lagring.

Se den som ett centralt nav där alla applikationens inställningar finns. Dina tjänster (klienter) hämtar sedan sina konfigurationer från detta nav.

• Centraliserad lagring: En plats för alla konfigurationer.
• Versionshanterad: Konfigurationerna lagras i Git (eller motsvarande).
• Miljöspecifik: Hantera enkelt konfigurationer för olika miljöer (utveckling, produktion).

För att skapa en Config Server konfigurerar du först en grundläggande Spring Boot-applikation och lägger till beroendet spring-cloud-config-server. Därefter aktiverar du den med annoteringen @EnableConfigServer.

Här är huvudklassen för vår Config Server:

Config Server måste veta var konfigurationsfilerna finns. Vanligtvis lagras de i ett Git-repositorium.

Du konfigurerar Git-repositoriets URI och sökvägar i filen application.properties eller application.yml:

server.port=8888
spring.cloud.config.server.git.uri=https://github.com/your-org/config-repo.git
spring.cloud.config.server.git.search-paths=configs

Detta anger att servern ska köras på port 8888 och hämta konfigurationer från det angivna Git-repositoriet genom att söka i mappen 'configs'.

I ditt Git-repositorium (till exempel config-repo.git) skapar du konfigurationsfiler för varje tjänst. Namngivningskonventionen är {application-name}-{profile}.yml eller .properties.

För vår Spring Cloud Gateway antar vi att dess spring.application.name är gateway-service. En grundläggande konfigurationsfil i ditt Git-repo (till exempel configs/gateway-service.yml) kan se ut så här:

spring:
  cloud:
    gateway:
      routes:
        - id: example_route
          uri: http://example.org
          predicates:
            - Path=/example/**

Nu konfigurerar vi vår Spring Cloud Gateway så att den fungerar som klient och hämtar sina konfigurationer från Config Server. Du behöver beroendet spring-cloud-starter-config.

I stället för application.properties använder klienten bootstrap.properties (eller .yml) för att ansluta till Config Server *innan* huvudprogrammets kontext läses in.

spring.application.name=gateway-service
spring.cloud.config.uri=http://localhost:8888

spring.application.name hjälper Config Server att hitta rätt konfigurationsfil (till exempel gateway-service.yml).

När konfigurationen är klar ansluter din Gateway-tjänst automatiskt till Config Server vid uppstart, hämtar konfigurationerna (till exempel routes, predicates och filter) och tillämpar dem.

Det innebär att du kan definiera alla Gatewayens routingregler, globala filter och andra inställningar i Git-repositoriet, som hanteras av Config Server, i stället för direkt i Gatewayens kod.

En route som definieras i gateway-service.yml i ditt Git-repo kommer till exempel att tillämpas av din Gateway.

Config Server är särskilt bra på att hantera miljöspecifika konfigurationer. Du kan skapa filer som gateway-service-dev.yml eller gateway-service-prod.yml i ditt Git-repo.

Gateway-klienten kan sedan ange sin aktiva profil i bootstrap.properties:

spring.application.name=gateway-service
spring.cloud.config.uri=http://localhost:8888
spring.profiles.active=dev

Config Server prioriterar gateway-service-dev.yml och skriver över eventuella egenskaper i basfilen gateway-service.yml.

En kraftfull funktion är möjligheten att uppdatera konfigurationer utan att starta om din Gateway-tjänst. Detta uppnås med Spring Cloud Actuator och annoteringen @RefreshScope.

1. Lägg till beroendet spring-boot-starter-actuator i din Gateway.

2. Aktivera slutpunkten /actuator/refresh i application.properties:

management.endpoints.web.exposure.include=refresh

3. Annotera alla beans i din Gateway som använder konfigurationsegenskaper med @RefreshScope.

När du har uppdaterat din Git-konfiguration och skickat upp ändringarna kan du skicka en POST-begäran till /actuator/refresh på din Gateway, så hämtar den de nya konfigurationerna!

Ni har lärt er hur Spring Cloud Config Server hanterar utmaningen med att administrera konfigurationer i distribuerade system. Det fungerar som ett centralt nav, vanligtvis med stöd av ett Git-repository, för att lagra och tillhandahålla konfigurationer.

Viktiga lärdomar:

• Config Server: En Spring Boot-app med @EnableConfigServer.
• Config Client: Er Gateway (eller andra tjänster) som ansluter via bootstrap.properties.
• Git-integrering: Konfigurationer lagras som {application}-{profile}.yml.
• Dynamisk uppdatering: Uppdatera konfigurationer direkt med Actuators /refresh-endpoint och @RefreshScope.

Detta centraliserade tillvägagångssätt skapar ordning och effektivitet i hanteringen av er mikrotjänstekonfiguration!