🤔 스프링 클라우드 시리즈!

스프링 클라우드 컨피그 서버를 세팅하고 확인해보자

스프링 클라우드 컨피그 서버는 무엇인가?

클라우드 네이티브의 12 factor (https://12factor.net/ko/ ) 요소 중 하나가 설정을 코드에서 엄격하게 분리하는 것 이다

스프링 클라우드 컨피그는 이 기능을 스프링 부트 프레임워크 기반에서 제공하는 것이다. 따라서 MSA 환경에서 여러 서버에 대한 설정을 공통으로 관리하며 코드 중복을 줄여준다.

"Config Server" 와 "Config Client", 설정 파일(주로 깃에 관리한다) 구성되어 있으며, git에 올린 설정 파일을 Config Server가 끌어와 띄워주고, 우리가 작성한 애플리케이션은 ( Config Client) 는 띄워진 설정 파일을 가져와 사용한다.

이제 코드를 작성해보자!

Config Server

먼저, Config Server 를 세팅해보자!

Application 생성

스프링 부트 스타터에서 https://start.spring.io/ 에서 아래와 같이 만들어 줬다.

gradle
java 11
springboot version : 2.5.6
packaging : jar
dependency : web

Gradle

gradle 의존성을 세팅해주자

plugins {
	id 'org.springframework.boot' version '2.5.6'
	id 'io.spring.dependency-management' version '1.0.11.RELEASE'
	id 'java'
}

group = 'com.springcloud'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'


apply plugin: 'io.spring.dependency-management'

repositories {
	mavenCentral()
}


ext {
	set('springCloudVersion', "2020.0.4")
}
apply plugin: "io.spring.dependency-management"
dependencyManagement {
	imports {
		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
	}
}


dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'

	//actuator
	implementation 'org.springframework.boot:spring-boot-starter-actuator:2.1.8.RELEASE'

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

test {
	useJUnitPlatform()
}

어떤 의존성을 추가했는지 확인해보면, "Config Server" 로서 기능을 제공할 의존성 spring-cloud-config-server 를 추가하였고

implementation 'org.springframework.cloud:spring-cloud-config-server'

애플리케이션을 모니터링하고 상태를 제공해주는 spring-boot-starter-actuator 를 추가해준다. (선택사항)

implementation 'org.springframework.boot:spring-boot-starter-actuator:2.1.8.RELEASE'

git에 설정 올리기

github 에 레포지토리를 생성하고 아래와 같은 구조로

├── dev
│   └── profile-dev.yml
├── prd
│   └── profile-prd.yml
└── stg
    └── profile-stg.yml

다음 내용의 파일을 올려주었다.

config:
  name: dev
info:
  description: Spring Cloud Dev

Config 애플리케이션에 application.yml 설정

resources 밑에 application.yml 파일을 생성하고

아래와 같이 값을 집어 넣었다
(Tmi : 현재 세팅한 스프링부트 버전에서는 bootstrap.yml이 지원안된다)

Application.yml

server:
  port: 8888


spring:
  application:
    name: configserver
  cloud:
    config:
      server:
        git:
          uri: https://github.com/bo-yoon/springcloud-config-profiles.git
          basedir: target/config
          searchPaths: dev, stg, prd

management:
  endpoints:
    enabled-by-default: false
  endpoint:
    info:
      enabled: true

설정을 하나하나 살펴보자

• 서버 포트는 포트번호를 8888 로 지정하는 설정이다
• spring.application.name은 애플리케이션의 이름을 지정한다.
• cloud.config.server.git.uri은 아까 스프링 부트 설정파일을 올린 레포지토리 url을 세팅해주었다.
• basedir은 config 정보를 저장할 위치이다. target/config 라고 세팅하면
  
  위와 같이 세팅된다.
• searchPaths는 디렉토리 안에 yml 파일 보관시 찾아가기 위한 설정이다
• management.endpoint.enabled-by-default 는 기본적인 actuator의 기본엔드포인트가 false로 설정되고, 아래 endpoint 정보에의해서 특정 정보만 true로 세팅한다.

@EnableConfigServer 설정

main에 @EnableConfigServer 을 붙여 준다.

@EnableConfigServer
@SpringBootApplication
public class ConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigApplication.class, args);
    }

}

이렇게 세팅하고 애플리케이션을 실행하면 된다!

ConfigServer 실행

localhost:8888/application/dev 로 접근해보면 다음과 같이 세팅 되는 것을 확인할 수 있다.

Config Client

이번에는 "Config Client" 를 세팅해보자!

Application 생성

Config Server 때와 마찬가지로 스프링 부트 스타터에서 https://start.spring.io/ 에서 아래와 같이 만들어 줬다.

gradle
java 11
springboot version : 2.5.6
packaging : jar
dependency : web

Config Client Gradle 세팅

그리고 gradle 의존성을 세팅해준다.
여기서 참고할 점은 mvn repository 에서 의존성을 찾을 때 "Spring Cloud Starter config"와 "Spring Cloud Config Client" 가 보이는데 사실 이 둘다 Config Client 를 설정하는 것으로 둘 중 하나만 세팅해주면 된다. 둘의 차이는 Spring Cloud Starter Config가 Spring Cloud Config client 를 포함하고 있다.

또한 애플리케이션이 실행되기 전에 config 정보를 localhost:8888에 떠있는 config server에서 가져와야 해서 application.yml 보다 우선순위가 높고, 애플리케이션 시작전 실행되는 bootstrap starter도 집어 넣어준다.

참고로 bootstrap같은 경우 현재 세팅한 스프링 2.5.6버전에서는 따로 의존성을 지정해야하지만 2.3.x 대 버전 이전같은 경우 의존성을 추가할 필요가 없다.

따라서 다음과 같이 Gradle의존성을 세팅해준다.

plugins {
	id 'org.springframework.boot' version '2.5.6'
	id 'io.spring.dependency-management' version '1.0.11.RELEASE'
	id 'java'
}

group = 'com.springcloud'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

apply plugin: 'io.spring.dependency-management'

repositories {
	mavenCentral()
}


ext {
	set('springCloudVersion', "2020.0.4")
}
apply plugin: "io.spring.dependency-management"
dependencyManagement {
	imports {
		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
	}
}


dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'


	//actuator
	implementation 'org.springframework.boot:spring-boot-starter-actuator:2.1.8.RELEASE'

	// config
	implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-config', version: '3.0.5'
    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-bootstrap', version: '3.0.4'

}

test {
	useJUnitPlatform()
}

bootstrap.yml 세팅

이제 config server를 바라보는 bootstrap.yml을 만들어보자.

Application.yml

server:
  port: 9090

spring:
  application:
    name: api-member
  cloud:
    config:
      uri: http://localhost:8888

테스트 용 Controller 작성

해당 위치에 간단한 Config 테스트용 컨트롤러를 작성했다.

@RestController
public class ConfigClient {

    @Value("${config.name}")
    private String profile;

    @GetMapping( value = "/config/profile", produces = "application/json; charset=UTF8")
    public String configConnection() {
         return profile;
    }
}

실행

이제 전부 세팅이 완료되었으니 실행해보자

먼저 따로 profile 세팅을 하지 않았으므로 인텔리제이에서 VM options을 사용해서 profile을 잡아보자

그리고 애플리케이션을 실행해준다.

그러면 profile가 dev라고 들어간 것을 확인할 수 있다.

또 해당 url 을 호출해보면 config.name을 정상으로 읽어오는 것을 확인할 수 있다.

tobe...

다음에는 스프링 클라우드 넷플릭스 oss에 대해 알아보자