[Spring Cloud Netflix Eureka] 기본 개념 정리 및 사용 방법

1. Spring Cloud Netflix Eureka

---

Netflix에서 배포한 오픈 소스입니다. MSA 아키텍쳐를 구성 할 때 Client Side에서 각 서버의 Service를 연동하고 관리하는 것은 한 서버의 서비스 IP 또는, VM IP가 바뀌었을때 마다 대응이 힘들다고 판단하여서 Server 단에서 각 서비스의 IP를 관리하고 이를 사용하는 Client 단에서 각 서비스의 연동하는 name만 가져와서 사용 하게끔 합니다.

 

마치 K8S 내부의 Service와 같은 개념으로 각 Server를 관리하는데요. 이를 좀 더 유저 친화적으로 사용 할 수 있게끔 구현 한 것 입니다.

2. 서버 구현

---

 

Dependancy 등록

아래와 같이 의존성을 추가합니다.

implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-server'

 

application.yaml 등록

 

server:
  port: 8787

# -- Eureka
eureka:
  instance:
    hostname: 127.0.0.1
  client:
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
    register-with-eureka: false
    fetch-registry: false

 

위와 같은 형태로 등록하는데요.

 

우선 각 명령어에 대해서 설명드리겠습니다.

 

eureka.client.serveUrl.defaultZone : eureka는 여러 instance를 두고 여러 서버를 둘 수 있습니다. 이 부분의 역할은 이 여러 인스턴스를 연동해서 하나의 유레카 서버가 내려가더라도 다른 유레카 서버의 정보를 사용해서 각 client들의 기본 정보등을 불러 올 수 있게합니다.

eureka.client.register-with-eureka : client 단에서 사용하는 정보로 클라이언트 단으로 등록 할 지 여부를 묻는 것입니다. 당연히 Eureka Server 이니 false 입니다.

eureka.client. fetch-registry : 서버로 부터 registry 정보를 30초 마다 가져와서 캐싱하는 것인데요 이것 또한, client 단의 필요 요소이니 false 합니다. 이는 기본 값이 true입니다.

 

application 단

@EnableEurekaServer
@SpringBootApplication
public class EurekaApplication {

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

}

EnableEurekaServer를 등록하고 끝 입니다.

 

3. Client 구현

---

 

Eureka 등록을 원하는 application에 등록을 합니다. 보통 서로 연동이 필요한 application이므로 대게는 Spring Cloud Gateway 서버가 될 것 입니다.

 

Dependancy 단

implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client'

 

application.yaml 단

spring:
  application:
    name: apigateway-service

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://127.0.0.1:8787/eureka #유레카 서버에 등록합니다.

 

아까 지정한 셋팅과 반대로 지정하고 service-url 부분으로 부터 유레카 서버에 지정합니다. 만일 여러 인스턴스로 이루어진 유레카 서버라면 쉼표로 여러개를 작성해서 기입합니다. 

 

spring.application.name 부분은 나중에 유레카 서버 상에서 연동해서 쓸 이름을 의미합니다.  (필요한 이유는 만일, 제가 API gateway 서버를 유레카 서버와 연동해서 사용 중이라면 lb://USER-SERVICE 이런식으로 유레카 서버에 연동된 이름을 가져와서 사용 할 수 있습니다. 즉, 관리가 훨씬 수월해집니다.)

 

application 단

@EnableDiscoveryClient
@SpringBootApplication
public class Application {

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

}

 

다만, 위의 @EnableDiscoveryClient는 굳이 적지 않아도 기본적으로 지원 한다고 합니다. application.yaml 까지만 설정하셔도 좋습니다.

 

Cloud Native Applications (spring.io)

(참고 링크 발췌) Spring Cloud will provide both the blocking and reactive service discovery clients by default. 문맥상 이전 내용이 @EnableDiscoverytClient 였고 이를 Spring Cloud에서는 기본적으로 동기 방식의 client나 비동기방식의 client 모두 지원한다는 뜻 입니다.

 

연결 시 볼 수 있는 창

만일, Spring Actuator를 연동해서 알맞게 application.yaml 부분에 셋팅을 해주었다면 healthz check 등을 확인 할 수 있는 창이 뜹니다.

 

[참고 자료]

Spring Cloud Netflix

Spring Cloud Netflix Eureka Server 사용해 보기

Spring Cloud Netflix Eureka - 개념 및 프로젝트 생성

Cloud Native Applications

[SC04] Spring Cloud Eureka 란 ?