넷플릭스 유레카(Eureka)를 사용한 서비스 디스커버리 구현

넷플릭스 유레카(Eureka)를 사용하여 서비스 디스커버리를 구현해보자.

스프링 부트 프로젝트 2개를 만들어서 하나는 디스커버리 서버, 다른 하나는 디스커버리 클라이언트 역할을 하도록 할 것이다.

 

java 11

spring boot 2.4.9

gradle

 

디스커버리 서버 - 유레카 서버

우선 디스커버리 서버 역할을 할 스프링 부트 프로젝트를 만들고 다음과 같이 세팅한다.

 

Dependency

spring-cloud-starter-eureka-server 의존성을 추가한다.

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

 

유레카 서버 활성화

스프링 부트 메인 클래스에 @EnableEurekaServer 애노테이션을 붙여 유레카 서버를 활성화한다.

@EnableEurekaServer
@SpringBootApplication
public class DiscoveryApplication {

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

}

 

유레카 서버 설정

📄 application.yml

server:
  port: 8761

spring:
  application:
    name: eureka-server

eureka:
  client:
    register-with-eureka: false
    fetch-registry: false

유레카 서버는 일종의 웹서비스이다.

스프링 부트 내장 서버를 통해 서비스되므로 server.port로 유레카 서버의 포트를 변경할 수 있다.

뒤에서 살펴볼 유레카 클라이언트의 기본 디스커버리 서버 포트가 8761이라 이 포트를 사용하였다.

보통 유레카 서버는 8761을 기본 포트로 사용한다.

 

나머지 설정은 다음을 참고한다.

 

spring.application.name
MSA에서 이 서비스를 식별하는 id이다.

eureka.client.register-with-eureka
유레카 서버에 자기 자신을 클라이언트로 등록하지 않도록 하는 설정이다.
본 프로젝트는 디스커버리 서버 역할을 하는 유레카 서버이므로 자기 자신을 클라이언트로써 디스커버리 서버에 등록하지 않도록 false로 설정한다.

eureka.client.fetch-registry
클라이언트로써 eureka 서버에서 eureka 레지스트리 정보를 가져올지 여부를 설정한다.
위 설정과 마찬가지로 클라이언트가 아니므로 false로 설정한다.

 

유레카 서버 실행 및 확인

애플리케이션을 실행하여 다음 url로 서비스를 확인해본다.

 

UI 대시보드 - http://localhost:8761

유레카 서버가 제공하는 UI 대시보드를 사용할 수 있다.

 

서버 목록 - http://localhost:8761/eureka/apps

유레카 서버에 등록된 마이크로 서비스의 목록을 조회할 수 있다.

 

디스커버리 클라이언트 - 유레카 클라이언트

유레카 클라이언트는 다음의 두 가지 역할을 수행한다.

• 유레카 서버와 통신하여 자신을 등록하고 서비스 정보를 보낸다.
• 서버로부터 데이터를 가져와 캐싱하고 주기적으로 변경사항을 확인한다.

 

다음으로 디스커버리 클라이언트 역할을 할 스프링 부트 프로젝트를 새로 만든다.

 

Dependency

spring-cloud-starter-netflix-eureka-client 의존성을 추가한다.

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

 

유레카 클라이언트 활성화

유레카 서버를 활성화할때 @EnableEurekaServer 애노테이션을 붙이듯, 유레카 클라이언트도 애노테이션을 붙여 활성화할 수 있다.

유레카 클라이언트를 활성화하기 위한 애노테이션은 다음의 두 개 중 하나를 사용할 수 있다.

• org.springframework.cloud.client.discovery.EnableDiscoveryClient
• org.springframework.cloud.netflix.eureka.EnableEurekaClient

 

우선 @EnableDiscoveryClient를 사용해 보자.

@EnableDiscoveryClient
@SpringBootApplication
public class ClientApplication {

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

}

스프링 부트 메인 클래스에 @EnableDiscoveryClient 애노테이션을 붙인다.

 

애플리케이션 설정

application.yml에 다음과 같이 설정값을 추가한다.

spring:
  application:
    name: client-service

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

 

spring.application.name은 서비스 디스커버리에 등록할 클라이언트 서비스 이름, 

eureka.client.serviceUrl.defaultZone은 클라이언트와 통신할 디스커버리 서버 주소를 설정한다.

 

유레카 클라이언트 실행 및 확인

앞서 만든 유레카 서버가 띄워져 있는 상태에서, 이번에 만든 유레카 클라이언트 애플리케이션을 실행하자.

유레카 클라이언트 애플리케이션은 서로 다른 포트로 총 2개의 인스턴스를 실행할 것이다.

 

🖥 빌드

./gradlew -x test clean build

 

🖥 실행

java -jar -Dserver.port=8081 study-eureka-client-0.0.1-SNAPSHOT.jar
java -jar -Dserver.port=8083 study-eureka-client-0.0.1-SNAPSHOT.jar

 

유레카 서버, 유레카 클라이언트가 모두 정상 실행되고 나면 유레카 서버 UI 콘솔 - http://localhost:8761에 다시 접속해보자.

 

Instances currently registered with Eureka 영역에 8081, 8083 포트로 등록된 두 개의 client-service 인스턴스를 확인할 수 있다.

 

✏️ 참고
Application에 보이는 application name(여기서 예로 들면 CLIENT-SERVICE)는 대소문자를 구분하지 않는다.
spring.application.name에는 client-service로 설정했지만 eureka 대시보드에서는 서비스 이름이 모두 대문자로 변환되어 CLIENT-SERVICE라고 출력된다.

 

이번엔 8083 포트로 띄운 클라이언트 인스턴스를 종료한 뒤 다시 확인해보자.

애플리케이션 종료 시 다음과 같은 로그를 볼 수 있다.

2021-08-02 22:44:09.979  INFO 10948 --- [extShutdownHook] com.netflix.discovery.DiscoveryClient    : Shutting down DiscoveryClient ...
2021-08-02 22:44:12.984  INFO 10948 --- [extShutdownHook] com.netflix.discovery.DiscoveryClient    : Unregistering ...
2021-08-02 22:44:12.990  INFO 10948 --- [extShutdownHook] com.netflix.discovery.DiscoveryClient    : DiscoveryClient_CLIENT-SERVICE/192.168.219.104:client-service:8083 - deregister  status: 200
2021-08-02 22:44:12.997  INFO 10948 --- [extShutdownHook] com.netflix.discovery.DiscoveryClient    : Completed shut down of DiscoveryClient

 

그 다음 유레카 서버 대시보드를 보면 registered 목록에서 8083 포트의 인스턴스가 제거되고, 8081 포트의 인스턴스만 보이는 것을 확인할 수 있다.

 

추가로 유레카 서버 대시보드의 http://localhost:8761/lastn 에서는 새롭게 등록되거나 등록 취소된 서비스 이력을 확인할 수 있다.

 

유레카 클라이언트 인스턴스를 모두 종료 후, 클라이언트 활성화를 위해 추가했던 @EnableDiscoveryClient 애노테이션을 @EnableEurekaClient로 변경 후 인스턴스를 재실행해도 동일한 결과를 볼 수 있다.

 

📚 참고 서적

마스터링 스프링 클라우드