Driving Adapter

🚀 Driving Adapter

🫰 Introduction

Hexagonal Architecture(헥사고날 아키텍처)의 Driving Adapter는 사용자의 입력을 받아 Application Core로 전달하는 역할을 합니다. 이를 통해 외부 계층(사용자, 시스템, 이벤트 소스 등)과 Application의 도메인 로직을 분리하여 유연성과 유지보수성을 향상시킬 수 있었습니다.

또한, Application의 UseCase를 포트로 할당 받아 입출력을 정의하였습니다. 그로 인해 의존도 또한 Application으로 향할 수 있었습니다. 이번 backend-sample-hexagonal-simple-crud의 Driving Adapter는 Rest API를 처리하는 Web Adapter를 구현하였습니다.

CQRS 패턴을 도입하여 Board(게시판) 도메인의 조회와 명령을 각각 분리하여 진행하였습니다.

항목	작업자
QueryApi	shin-jingyu
CommandApi	silberbullet

🕸️ Web Adapter

🫏 About REST Controller

• HTTP 요청 수신: 클라이언트의 GET, POST, PATCH, DELETE 요청 처리
• UseCase 호출: 요청된 데이터를 비즈니스 로직으로 전달

API	설명	기능
QueryApi	데이터 조회 기능을 담당하며, 클라이언트로부터의 GET 요청을 처리하여 필요한 데이터를 반환	QueryApi 구현 QueryApi 테스트 코드 작성 및 검증
CommandApi	데이터의 변경(생성, 수정, 삭제) 요청을 처리하며, 클라이언트의 POST, PATCH, DELETE 요청을 처리	CommandApi 구현 CommandApi 테스트 코드 작성 및 검증

🛠 Mapper(MapStruct)와 DTO를 활용한 전략

명확한 데이터 변환 및 구조화를 위해 Mapper와 DTO(Data Transfer Object) 를 활용하여 Application 영역과 데이터를 주고받는 전략을 사용하였습니다.

✨ Mapper의 역할

• Domain(도메인)과 DTO 간 변환을 수행하여 비즈니스 로직과 표현 계층을 분리
• 서비스 레이어에서 데이터를 가공하는 역할을 최소화하고, 단순 변환 로직을 전담

🏗 DTO를 활용한 이점

• 클라이언트와 서버 간 일관된 데이터 포맷 유지
• 도메인 모델 보호
• REST API의 요청과 응답을 명확하게 정의하여 유지보수성 향상

🦖 테스트 코드

❗필수 Annotation

• @WebMvcTest(BoardQueryApi::class)

  • BoardQueryApi를 빈으로 로드하고 MockMvc를 활용하여 HTTP 요청을 테스트할 때 사용

• @MockitoBean

  • 특정 객체를 Mocking하여 테스트 컨텍스트에 주입

💚 Kotest Style is FreeSpec

• Kotest에서 제공하는 테스트 스타일 중 하나로, 보다 자유로운 구조의 테스트를 작성할 수 있음
• 계층적 구조 없이 간결한 테스트 작성 가능

@WebMvcTest(BoardQueryApi::class)
class BoardQueryApiTest(
    @MockitoBean private val boardReadUseCase: BoardReadUseCase,
    @MockitoBean private val boardReadByStatusesUseCase: BoardReadByStatusesUseCase,
    @MockitoBean private val boardDtoMapper: BoardDtoMapper,
    @Autowired private val mvc: MockMvc
) : FreeSpec({

• beforeSpec {}

  • 전체 테스트 실행되기 전에 한 번만 실행되는 블록으로 공통적인 설정 작업을 구현

• 구조

  • 가독성을 위해 대괄호[]를 이용한 테스트 케이스명 기능 정의
  • 설정 코드(Mock 설정 등)를 테스트 실행 코드 아래 배치하여 가독성 향상

💭 회고

@shin-jingyu

헥사고날 아키텍처를 적용하면서 API에서 도메인과 DTO를 매핑하는 과정이 처음엔 헷갈렸지만, 구현을 진행하면서 점점 구조가 명확해졌습니다. 이번 경험을 통해 Git도 더 익숙하게 다룰 수 있게 되었습니다. PR과 이슈 관리를 직접 사용해보면서 협업 과정에서 어떻게 활용되는지 배울 수 있었습니다. 테스트 코드를 작성하면서 구조적인 부분을 더 깊이 고민할 수 있었고, 같이 작업한 경우님 덕분에 가독성이 좋은 코드로 다듬을 수 있었습니다. 또한, HTTP 테스트 코드를 직접 작성하면서 테스트에 대한 이해가 많이 늘었고, 전반적으로 코드의 구조와 테스트 설계에 대해 배울 수 있는 좋은 경험이었습니다.