Spring Cloud Config로 프로퍼티를 외부 서버에서 관리하기 - 1

Spring Cloud Config로 프로퍼티를 외부 서버에서 관리하기

Spring Cloud Config는 분산 시스템에서 외부화된 구성에 대한 서버 측 및 클라이언트 측 지원을 제공합니다. Config Server를 사용하면 모든 환경에서 애플리케이션의 외부 속성을 관리할 수 있는 중앙 위치를 가집니다. Spring Cloud Config는 많은 방식들을 지원하는 것 같습니다. 저는 이번에는 GitHub와 함께 사용해볼건데요. 더 자세하고 다양한 방법들은 Docs를 확인하면 될 것 같습니다.

https://velog.io/@pjh612/Spring-Cloud-Config%EB%A1%9C-%ED%94%84%EB%A1%9C%ED%8D%BC%ED%8B%B0%EB%A5%BC-%EC%99%B8%EB%B6%80-%EC%84%9C%EB%B2%84%EC%97%90%EC%84%9C-%EA%B4%80%EB%A6%AC%ED%95%98%EA%B8%B0

Spring Cloud Config

준비

• Github Repository를 준비합니다. 저는 scc-test라고 이름지었습니다.

• Spring Boot Application을 두 개 준비합니다. 애플리케이션 이름은 저는 scc-server, scc-client로 준비했습니다. scc-server는 Github와 직접 통신해 설정 정보들을 읽어들여 scc-client로 보내주는 역할을 합니다.

SCC-SERVER 준비

• build.gradle 의존성 추가

ext {
  set('springCloudVersion', "2021.0.3")
}

dependencies {
  implementation 'org.springframework.cloud:spring-cloud-config-server'
}

dependencyManagement {
  imports {
      mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
  }

- application.yml
```yml
server:
 port: 8888

spring:
 cloud:
   config:
     server:
       git:
         uri: GitHub Repository 주소
         search-paths: scc-client
       encrypt:
         enabled: false

• scc-client-dev.yml 간단한 몇가지 프로퍼티들만 scc-client-dev.yml에 담겠습니다. DB 계정정보, JWT Secret Key를 담아볼게요.

db:
  username : root
  password : password
jwt:
 client-secret: EENY5W0eegTf1naQB2eDeyCLl5kRS2b8xa5c4qLdS0hmVjtbvo8tOyhPMcAmtPuQ

이제 Server사이드 준비는 완료 되었습니다. 다음은 Client 사이드 준비를 해볼게요.

## SCC-Client 준비
- build.gradle 의존성 추가
 ```java
 ext {
   set('springCloudVersion', "2021.0.3")
 }

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter- web'
    implementation 'org.springframework.cloud:spring-cloud-config- client'
}

dependencyManagement {
    imports {
        mavenBom  "org.springframework.cloud:spring-cloud- dependencies:${springCloudVersion}"
    }
 }

• application.yml

spring:
 application:
   name: ssc-client
 profiles:
  active: dev
 config:
   import: "configserver:<http://localhost:8888/>"
 cloud:
   config:
     name: scc-client
     profile: default
management:
 endpoints:
   web:
     exposure:
       include: refresh

• 프로필을 dev로 지정해줍니다.

• import부분에는 Spring Cloud Config Server와 통신할 수 있는 도메인 주소를 입력해줍니다.

• cloud.config.name에는 깃헙 레포 내의 ssc-client 폴더 내에 위치한 불러올 파일의 prefix를 입력합니다. (scc-client-dev.yml -> scc-client)

• cloud.config.profile을 default로 지정해두면 spring.application.profile.active에서 지정한 profile인 dev로 찾게 됩니다.

실행

• JwtProperties.java

@ConstructorBinding
@ConfigurationProperties(prefix = "jwt")
public record JwtProperties(String clientSecret, String issuer) {

}

• PropertiesConfig.java

@EnableConfigurationProperties(JwtProperties.class)
@Configuration
public class PropertiesConfig {

}

• HelloRestController.java

@RestController
public class HelloRestController {

   private final JwtProperties jwtProperties;

   @Value("${jwt.client-secret}")
   private String secret;

   public HelloRestController(JwtProperties jwtProperties) {
   	this.jwtProperties = jwtProperties;
   }

   @GetMapping("/hello")
   public String hello() {
   	return jwtProperties.clientSecret();
   }

   @GetMapping("/hello2")
   public String hello2() {
   	return secret;
   }

        @GetMapping("/hello3")
   public JwtProperties hello3(){
   	return jwtProperties;
   }
}

결론