Spring Cloud Netflix Eureka

💡 서비스 디스커버리 , 레지스트리에 관한 내용을 미리 학습하고 읽으면 좋습니다.

 

 

 

Spring Cloud Eureka란?

• 넷플릭스에서 만든 서비스
• 서버들을 중앙 레지스트리에 등록하고 장애가 발생할 때 자동으로 제외
• 새 인스턴스 시작시 Eureka 서버에 IP, 호스트 주소, 포트 번호 등을 스스로 전송.
• 운영자들은 IP 정보를 신경쓰지 않아도 됨.
• 다른 서비스 호출시 Eureka 서버에 등록된 인스턴스를 조회.
• 클라이언트와 서버로 구분하여 사용.

구성 요소

Service Discovery

• 마이크로서비스의 위치를 찾는 작업
• Spring Cloud Netflix - Eureka Server 를 이용

Service Registry

• 각각의 서비스가 자신의 위치를 특정 서버에 등록하는 작업
• Spring Cloud Netflix - Eureka Client 를 사용

 

흐름

1. Service Registry 기능을 할 Eureka Server 가 최초에 기동
2. Service Registry 서버인 Eureka Server 에 등록될 서비스들이 기동
   • 여기서 등록된 서비스는 Eureka Client라고 부름
3. Eureka 서버는 자신에게 등록된 Eureka Client 에게 30초(기본값)마다 Ping을 보내며 Health Checking을 수행
4. 만약 30초마다 보내는 Heart Heat가 일정 횟수 이상으로 동작되지 않으면 Eureka Server는 해당 Client를 삭제

Eureka는 단지 서비스의 위치만을 표현하는 역할로 보통 Spring Cloud Gateway나 Netflix Zuul 과 같은 Gateway 서비스나 Ribbon 과 같은 클라이언트 사이드 로드밸런서와 함께 동작합니다.

Eureka와 함께 사용되는 Zuul, Ribbon

 

Eureka Server 사용법

build.gradle

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

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

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

• Spring Boot 버전에 맞게 Spring Cloud 버전 선택하여 사용하여야 합니다.
  • Spring initializr를 사용한다면 대부분 알아서 해결해줍니다.

 

application.yml

server:
  port: 8761  // Eureka 서버의 포트 지정, 보통 8761 사용

spring:
  application:
    name: discovery-service  // application 이름 지정, 서비스를 식별할 때 사용
    
eureka:
  client:
    register-with-eureka: false   // 해당 서버를 Client로 동작시킬지를 지정, 기본값이 true이므로 false 처리
    fetch-registry: false         // 위와 동일, 지정안해주면 자기자신을 등록하게된다.

 

@EnableEurekaServer 추가

@EnableEurekaServer
@SpringBootApplication
public class DiscoveryServerApplication {

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

}

 

Eureka Client 사용법

build.gradle

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

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

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

 

application.yml

• 기본설정

server:
  port: 8081   // 서버 포트 설정

spring:
  application:
    name: item-service   // app 이름 설정

eureka:
  client:
    register-with-eureka: true   // 해당 서비스를 클라이언트로 인식
    fetch-registry: true         // 위와 동일
    service-url:
      defaultZone: http://localhost:8761/eureka   // Eureka 서버가 위치한 기본 주소 입력

 

• 랜덤포트 사용 시 설정
  • 인스턴스가 등록될 때 port 설정이 0으로 잡혀있어 여러개를 키더라도 하나만 보여지는 현상이 생기기 때문에 Instance ID를 지정해주어야 합니다.

server:
  port: 0

spring:
  application:
    name: user-service

eureka:
  instance:
    instance-id: ${spring.application.name}:${spring.application.instance_id:${random.value}} // 인스턴스 id 추가

  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://127.0.0.1:8761/eureka

 

@EnableEurekaClient 추가

@EnableEurekaClient
@SpringBootApplication
public class ItemServiceApplication {

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

}

 

적용 모습

 

추가적인 팁

• 실습을 하다보면 인스턴스를 여러 개 띄워야 하는데 그때마다 Port 번호를 바꿔줘야하는 번거로움이 있습니다.
  랜덤 포트로 지정해주면 편하게 실습을 진행할 수 있습니다.
• 이곳에서 랜덤포트 적용하는 법을 확인할 수 있습니다.

 

참고자료

• Spring 공식 문서
• https://wonit.tistory.com/495
• https://velog.io/@easycelsius/MSA