Spring Boot Config Server enables centralized configuration management for distributed applications, allowing dynamic configuration updates without requiring service restarts. This guide covers how to set up and use Spring Boot Config Server efficiently.
In this section, we clarify Why Use Config Server? and summarize the key points you will apply in implementation.
Ensure you have the following:
Add the necessary dependencies for Spring Cloud Config Server.
Maven:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency>
Gradle:
implementation 'org.springframework.cloud:spring-cloud-config-server'
Create an application.yml file to specify the Git repository for storing configurations.
server: port: 8888 spring: cloud: config: server: git: uri: https://github.com/example/config-repo default-label: main
Note: Replace
https://github.com/example/config-repowith your actual Git repository.
In your Git repository (e.g., config-repo), create an application.yml file with the following content:
config.key: 'Hello from Config Server!'
Commit and push the file to the repository:
git add application.yml git commit -m "Add config properties" git push origin main
Start the Config Server application:
./mvnw spring-boot:run
or using Gradle:
gradle bootRun
Verify it is running by accessing:
curl -X GET http://localhost:8888/application/default
Expected Output:
{ "name": "application", "profiles": ["default"], "propertySources": [ { "name": "https://github.com/example/config-repo/application.yml", "source": { "config.key": "Hello from Config Server!" } } ] }
In this section, we clarify Step 5: Configure a Client Application and summarize the key points you will apply in implementation.
First, include the Config Client starter so this service can pull centralized configuration during bootstrap.
Maven:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency>
Gradle:
implementation 'org.springframework.cloud:spring-cloud-starter-config'
In the client's bootstrap.yml, add the following:
spring: application: name: config-client cloud: config: uri: http://localhost:8888
The sample below provides a minimal client implementation so you can validate the server integration end to end.
Run the Config Client application:
./mvnw spring-boot:run
or using Gradle:
gradle bootRun
Retrieve the configuration from Config Server:
curl -X GET http://localhost:8080/config
Expected Output:
Config Value: Hello from Config Server!
You now have a practical Spring Boot Config Server implementation with a clear, production-friendly Spring Boot structure. As a next step, adapt configuration and tests to your own domain, then validate behavior under realistic traffic and failure scenarios.
package com.example.configserver; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.config.server.EnableConfigServer; @SpringBootApplication @EnableConfigServer public class ConfigServerApplication { public static void main(String[] args) { SpringApplication.run(ConfigServerApplication.class, args); } }
package com.example.configserver import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.cloud.config.server.EnableConfigServer @SpringBootApplication @EnableConfigServer class ConfigServerApplication fun main(args: Array<String>) { runApplication<ConfigServerApplication>(*args) }
package com.example.configclient; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.springframework.beans.factory.annotation.Value; @SpringBootApplication @RestController @RequestMapping("/config") public class ConfigClientApplication { @Value("${config.key:not found}") private String configValue; @GetMapping public String getConfigValue() { return "Config Value: " + configValue; } public static void main(String[] args) { SpringApplication.run(ConfigClientApplication.class, args); } }
package com.example.configclient import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController import org.springframework.beans.factory.annotation.Value @SpringBootApplication @RestController @RequestMapping("/config") class ConfigClientApplication { @Value("\${config.key:not found}") lateinit var configValue: String @GetMapping fun getConfigValue(): String { return "Config Value: \$configValue" } } fun main(args: Array<String>) { runApplication<ConfigClientApplication>(*args) }
