6편. JHipster를 이용하여 MSA를 구축하기 (with Spring Cloud Config)

Micro Service 외부, 내부 Architecture를 편하게 구성할 수 있게 도와주는 오픈소스 플랫폼 Jhipster에 대해서 얘기하고자 한다.  

JHipster(Java Hipster)란?

JHipster는 자바 진영에서 modern 한 모놀리스 애플리케이션 또는 마이크로 서비스를 빠르게 적용, 개발, 배포할 수 있게 도와주는 오픈소스 플랫폼이다.

https://www.jhipster.tech/

JHipster - Full Stack Platform for the Modern Developer!

 

 

각 영역별로 다양한 기술을 지원한다.

• Frontend: React, Angular, Vue, Bootstrap, Jest
• Backend: Spring Boot, Spring Security, Netflix OSS, Mysql, Gradle, MongoDB, Redis, Swagger, Elastic Stack, Prometheus
• CI/CD: Jenkins, Travis CI, Github Workflows, CircleCI 

 

위와 같이 다양한 기술을 지원하기에 아래와 같은 장점이 있다.

1. Client Side와 Server Side를 한 번에 생성할 수 있다.
2. Spring Boot를 사용할 때 프로젝트의 템플릿을 만들어준다.
3. Modern 한 UI를 위해 Angular, React, Vue + Bootstrap을 지원한다.
4. Webpack과 Gradle•Maven 등 강력한 애플리케이션 빌드 도구를 이용할 수 있다.

 

 

MSA에서의 JHipster의 힘

 

https://www.jhipster.tech/api-gateway/

JHipster를 이용해서 MSA를 빠르게 구축할 때 아래의 것들을 빠르게 구축할 수 있다.

1. API Gateway 생성
2. Service Registry 생성
3. Micro Service 생성
4. Micro Service 내부 엔티티 생성

 

JHipster API Gateway

JHIpster API Gateway는 Spring Cloud Load Balancer을 기반한 API Gateway이다.

• JHipster Registry에 등록되어 있는 서비스 인스턴스 정보를 기반하여 로드 밸런서 기능을 수행한다.

API Gateway에서는 토큰 검증과 같은 보안처리도 담당한다.
그중, JWT(Json Web Token) 인증 방식은 MSA에서 애플리케이션을 보호하기 위해 사용하는 가장 쉬운 표준 방식이며, JHipster는 JWT 구현을 위해 Okta에서 제공하는 JJWT 라이브러리를 이용한다. 

 

 

JHipster Registry

JHipster Registry는 Eureka 기반의 Service Discovery 애플리케이션이면서 동시에, Spring Cloud Config 애플리케이션의 역할을 한다.

• Eureka 서버를 이용하며, HTTP 요청을 라우팅 및 로드밸런싱을 수행하기 위해 마이크로 서비스에서 사용 가능한 애플리케이션을 동적으로 관리한다.
• Runtime 설정을 관리하기 위해 Spring Cloud Config를 사용한다.
• 애플리케이션을 관리할 수 있는 모니터링 대시보드를 제공해준다.

https://www.jhipster.tech/jhipster-registry/

 

 

이 이외에도 Swagger를 자동으로 설정하여 API 문서화를 편하게 하거나, 배포 파이프라인을 자동으로 구성해 주거나, Entity Field를 터미널에서 추가할 수 있는 등 여러 기능이 있다.

하지만, 지금 나의 생각으로는 굳이?라는 생각이 든다. 한 발 물러나서 애플리케이션 외부 아키텍처를 구성하는 것까지는 편리하게 할 수 있으니 사용한다 하더라도, 내부 아키텍처나 엔티티를 JHipster로 구성하는 것은 편리하지도 않을뿐더러 비효율적이라고 생각한다.

 

추가적으로, Spring Cloud Config에 대해서 설명하고자 한다.

 

 

Spring Cloud Config의 역할 그리고 장점과 단점은?

Spring Cloud Config는 MSA 또는 분산 시스템에서 외부적으로 구성된 설정 정보를 Server와 Client에게 제공하는 역할을 한다.

애플리케이션 내에서 application.yml로 설정 정보를 등록하는 게 익숙하겠지만, Spring Cloud Config를 사용하면 여러 장점이 있다.

1.  서버를 중지하거나 재배포하지 않고 설정 정보를 실시간으로 반영할 수 있다.
2. 설정 정보를 중앙 서버에서 집중적으로 관리할 수 있다.

 

 

하지만, 장점이 있으면 단점도 있다.

1. Spring Cloud Config 서버의 장애로 인해 서비스 애플리케이션에도 장애가 전파될 수 있다.
2. 우선순위에 따라 설정이 복잡해질 수 있다.

 

 

Spring Cloud Config 설정 정보 우선순위

단점으로 위에서 우선순위의 복잡성을 언급했다. Spring Boot 애플리케이션에서 설정 파일의 우선순위에 대해서 얘기해보겠다.
설정 파일은 아래와 같은 순서로 읽어지고, 뒤에 읽어질수록 우선순위가 높아진다.

1. 서비스 애플리케이션의 application.yml
2. Spring Cloud Config Server의 application.yml
3. 서비스 애플리케이션의 application-{profile}.yml
4. 설정 저장소의 {application name}-{profile}.yml

따라서, 우선순위에 대한 이해를 바탕으로 Spring Cloud Config를 사용해야 한다.

 

 

Config Server 구축

이제 Spring Cloud Config를 구축하는 방법에 대해 살펴보겠다.

1. 설정 정보를 저장할 저장소를 구축한다.
2. Spring Cloud Config Server를 구축하고 설정 정보 저장소와 연결한다.
3. 서비스 애플리케이션을 Spring Cloud Config Server와 연결한다.

 

Spring Cloud Config의 설정 정보 저장소는 Git이 대표적이지만, 그 외에 여러 방법이 존재한다.

• Git Repository
• AWS S3
• Redis
• JDBC
• File

 

 

 

설정 정보를 Runtime에 반영시키려면?

새로운 설정 정보를 런타임에 반영시키려면 어떻게 해야 할까?

1️⃣ 첫 번째로, Spring Boot Actuator를 이용할 수 있다. https://application/actuator/refresh와 같이 refresh 기능을 호출하여 각 애플리케이션이 새로운 설정 정보를 적용하도록 수동으로 호출하는 것이다.

 

이러한 수동 방식은 모든 애플리케이션을 refresh 해주어야 하기 때문에, Scale-Out 되어 있는 모든 애플리케이션에 실행시키기는 번거롭다.

 

2️⃣ 두 번째로, Spring Cloud Bus를 이용할 수 있다. Spring Cloud Bus는 분산 시스템 환경에서 각각의 서비스를 연결시켜주는 Light Weight 메시지 브로커이다.

이러한 Message Broker를 이용하여 설정 정보들을 실시간 및 지속적으로 반영하도록 할 수 있다.

Message Broker로는 대표적으로 Kafka와 RabbitMQ가 존재한다.
Config Server에서는 RabbitMQ와 같이 초당 20개 이상 정도의 메시지를 처리할 수 있는 능력을 가진 플랫폼 정도면 충분하다.

 

 

이제 설정 정보가 적용되는 과정에 대해서 얘기해보겠다.

1. 개발자가 yml 파일과 같은 설정 파일을 Remote Repository에 추가한다.
2. Github의 경우 WebHook을 통해 Config Server가 설정 정보 변경을 감지한다.
3. Config Server는 이 정보를 Spring Cloud Bus를 통해 RabbitMQ로 보낸다.
4. RabbitMQ는 받은 설정 변경 Event를 연결된 모든 서비스 인스턴스에게 전파한다. (Pub/Sub 모델)
5. Message Broker는 설정 정보 변경 메시지를 구독하고 있는 Application들에게 설정이 변경되었음을 전파한다.
6. 각각의 노드들은 /actuator/refresh 엔드포인트를 자동으로 호출해서 최신 설정 정보를 Config Server로부터 업데이트받는다.