[MSA 구축하기] 1. 마이크로서비스 생성하기

🔊 우리는 Spring Cloud를 활용하여 MSA를 구축한다.

🔊 이번에는, 마이크로서비스를 생성할 것이다. 

 

마이크로서비스는 user, beverage, community 3개의 서비스로 구성한다.

1. user-service
2. beverage-service
3. community-service

---

⭐ 웹 프로젝트를 생성할 때 필요한 의존성에 대해 알아보자.

1. Lombok

lombok 은 Java 라이브러리 중 하나로 Java 개발 시에 반복적으로 구현되는 getter, setter, toString 등을 자동으로 생성해 주어 코드를 간결하게 유지하고 생산성을 높여주는 라이브러리이다. 어노테이션을 기반으로 동작하며, 클래스에 어노테이션을 추가하여 컴파일 과정에서 실제 기능이 생성되는 방식으로 동작한다. 즉, 소스코드에서는 어노테이션만 보이고 해당 메서드들은 보이지 않지만 실제로 컴파일된 결과물. class 파일에는 코드가 생성되게 된다.

 

lombok을 사용하면 반복적인 코드가 제거되어 코드의 가독성이 좋아지고 유지보수에 유리해진다. 또한 반복적인 코드 작성의 시간이 줄어 생산성이 향상된다. 하지만 경우에 따라서는 코드가 직관적이지 않고 어노테이션으로 생략되는 것에 불편함이 있을 수도 있어 상황에 맞게 사용하는 것이 좋다.

 

또한 내부에서 어떻게 구현이 되는지 이해를 하고 사용해야 한다. 예를 들어 @ToString의 경우 클래스의 내부 필드의 성격에 따라서 순환 참조나 무한 재귀 호출 등의 문제를 발생할 수 있다. 그렇기 때문에 각 기능들이 구현하는 로직에 대해서 숙지하고 발생할 수 있는 예외 상황에 대해서 파악한 후에 사용하는 것이 필요하다.

 

2. Spring Web

Spring Web은 웹 애플리케이션을 개발하는 데 필요한 기능을 제공하는 스프링 부트의 의존성이다.

Spring MVC, Tomcat, Jackson 같은 웹 개발에 필요한 대부분의 라이브러리를 포함하고 있다.

 

Spring Boot 프로젝트에서 Spring Web 의존성을 추가하면 다음과 같은 주요 라이브러리들이 자동으로 설정된다.

1. Spring Boot Starter Web: Spring Boot Starter Web는 Spring Web과 관련된 기본적인 설정을 자동으로 해주는 스타터(Starter) 패키지입니다. 이를 추가하면 Spring MVC, 내장 웹 서버 설정, 기본적인 웹 애플리케이션 구성 등이 자동으로 설정됩니다.
2. Spring MVC: Spring MVC는 Model-View-Controller 패턴을 기반으로 한 웹 애플리케이션을 구축하기 위한 핵심 모듈입니다. 이를 통해 개발자는 컨트롤러(Controller), 모델(Model), 그리고 뷰(View)를 사용하여 웹 애플리케이션의 비즈니스 로직과 사용자 인터페이스를 분리하고, 각각의 역할을 구현할 수 있습니다.
3. 내장 웹 서버 설정: Spring Boot는 톰캣(Tomcat), 제티(Jetty), 언더토우(Undertow) 등의 내장 웹 서버를 제공합니다. Spring Web 의존성을 추가하면 기본적으로 이러한 내장 웹 서버의 설정이 자동으로 추가됩니다. 이를 통해 별도로 웹 서버를 설치하거나 구성할 필요 없이 간편하게 웹 애플리케이션을 실행할 수 있습니다.
4. RESTful 웹 서비스 지원: Spring Web은 RESTful 웹 서비스를 쉽게 개발할 수 있는 다양한 기능을 제공합니다. 이를 통해 JSON 또는 XML 형식의 데이터를 주고받는 RESTful 웹 서비스를 구축할 수 있습니다.
5. 데이터 바인딩과 유효성 검사: Spring Web은 HTTP 요청의 데이터를 자동으로 Java 객체로 바인딩하고, 데이터의 유효성을 검사할 수 있는 기능을 제공합니다. 이를 통해 사용자 입력을 처리하고 검증하는 작업을 간편하게 수행할 수 있습니다.

따라서 Spring Web을 사용하면 Spring 기반의 웹 애플리케이션을 빠르고 효율적으로 개발할 수 있으며, Spring Boot의 자동 구성 기능을 통해 설정의 복잡성을 줄일 수 있습니다.

 

Spring Web의 주요 어노테이션

어노테이션	설명
@SpringBootApplication	스프링 부트 애플리케이션의 주요 구성 요소로, 자동 구성, 구성 요소 검색 및 프로퍼티 설정을 제공합니다.
@Configuration	스프링 빈 설정을 위한 클래스임을 나타냅니다. 이 어노테이션이 지정된 클래스는 하나 이상의 @Bean 메서드를 포함할 수 있습니다.
@Bean	스프링 컨테이너에 의해 관리되는 빈 객체를 정의하는 메서드임을 나타냅니다. @Configuration 어노테이션이 지정된 클래스 내에서 사용됩니다.
@Component	스프링 관리 빈으로 등록되는 클래스임을 나타냅니다. 일반적으로 의존성 주입(Dependency Injection)을 위해 사용됩니다.
@Controller	스프링 MVC 애플리케이션에서 컨트롤러로 사용되는 클래스임을 나타냅니다.
@Service	스프링 애플리케이션에서 서비스 클래스임을 나타냅니다.
@Repository	스프링 애플리케이션에서 리포지토리 클래스임을 나타냅니다.
@ComponentScan	컴포넌트를 검색하여 스프링 빈으로 등록하는 데 사용됩니다. 지정된 패키지에서 @Component 어노테이션이 지정된 클래스를 검색합니다.

 

---

마이크로서비스 구축하기

1. 개발 환경

도구	버전
IntelliJ	2023.03.04
Java	17
Gradle	8.5
SpringBoot	3.2.3

 

2. Dependincies 추가

1. Lombok
2. Spring Web

다른 의존성(dependency)은 추후에 필요시 추가할 예정이다.

 

3. 마이크로서비스 프로젝트 생성

Spring Initializr를 사용하여 마이크로서비스 프로젝트들을 생성해 준다.

https://start.spring.io/  의 주소로 Spring Initializr에 접근가능하다.

 

user-service

 

beverage-service

 

community-service

 

반응형

---

생성된 마이크로서비스의 폴더 구조

---

 

참고 자료

https://adjh54.tistory.com/311

https://velog.io/@kkh30123/Spring-boot-Starter-Web

https://jammdev.tistory.com/201