[Spring Boot] MapStruct

 

Source Code : https://github.com/junyharang-coding-study/JunyHarang-JAVA-EncryptionDecryption.git

백견불여일타 스프링 부트 쇼핑몰 프로젝트 with JPA:이젠 프로젝트다!

 

 

React.js 스프링 부트 AWS로 배우는 웹 개발 101:SPA REST API 기반 웹 애플리케이션 개발

 

 

스타트 스프링 부트:초급 개발자들을 위한 가볍고 넓은 스프링 부트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

🗂 목차

● [JAVA - Spring Boot] 암호화/복호화 기능 만들기  
● [Spring Boot] MapStruct

 

🚀 MapStruct 가지고 놀기

    🔽  개요

        📦 설명

MapStruct는 Entity 객체와 DTO 객체를 상호 Mapping 지원하는 Library에요.

Entity와 DTO 변환을 위해 많은 방법이 있지만, 해당 작업을 지원하는 Library는 ModelMapper와 MapStruct가 대표적이에요.

주니하랑은 이번에 MapStruct를 사용해보려하는데, 그 이유는 ModelMapper와 비교했을 때, MapStruct의 경우 Compile 시 미리 생성된 구현체를 통해 Entity, DTO를 상호 Mapping 해 주기 때문에 퍼포먼스 이점이 있기 때문이에요.

또한, ModelMapper의 경우 변환 과정에서 리플렉션이 발생하고, MapStruct는 위의 이유로 리플렉션이 발생하지 않는 이 점이 있답니다.

 

 

 

    🔽  초기 구성

        📦 의존성 설정

build.gradle

    // MapStruct 의존성 추가
    // https://mvnrepository.com/artifact/org.mapstruct/mapstruct-processor
    // 순서 주의! Lombok 사용 시 Lombok 의존성 설정이 먼저 위치
    implementation 'org.mapstruct:mapstruct:1.4.2.Final'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final'
    annotationProcessor 'org.projectlombok:lombok-mapstruct-binding:0.2.0'

위와 같이 MapStruct의 의존성을 추가해 주었어요.

        📦 Interface 구성

MapStruct를 사용하기 위해서는 Generic을 이용하여 먼저 Interface를 만들어줘야 해요.

GenericMapper<DTO, Entity>

반응형

위와 같이 GenericMapper를 만들어 주었어요.

위 Interface에서 toDTO와 toEntity는 각각 DTO가 들어오면 Entity로 변환해주고,
Entity가 들어오면 DTO로 변환해주는 추상 Method에요.

그 아래 List Method들은 List로 작업을 할 때 쓰기 위해 선언해 주었어요.

16번째 Annotaion과 같이 설정을 넣게 되면 nullValuePropertyMappingStrategy로 인해
Null 값이 전달될 경우 변화 시켜주지 않도록 설정을 하여 주었어요.

updateFromDTO()는 기존 생성되어 있는 Entity를 Update하고 싶을 때,
Null이 아닌 값만 Update할 수 있도록 만들어준 추상 Method에요.

💡 참고 사항
@MappingTarget : 변환하여 객체를 반환하는 것이 아닌 매개 변수(인자)로 받아 Update할 Target 설정.
@BeanMapping(nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE) : Source Field가 Null이라면 Null 값 무시.

 

 

    🔽 코드 구현

        📦 BoardMapper

실제로 MapStruct를 사용하기 위해서는 아래와 같이 코드를 만들어줘야해요.

TestBoardMapper

위와 같이 GenericMapper를 상속받는데, GenericMapper에 Generic Type으로 Mapping 하고자하는 DTO와 Entity를 명시해 주면 되요.

그리고, @Mapper를 통해 mapstruct가 인식되도록 하여주었어요.

💡 참고 사항
@Mapper : MapStruct Code Generator가 해당 Interface의 구현체를 만들어 줌.
componentModel = "spring" : Spring 환경에 맞게 Bean 등록

 

이제 이 상태에서 Spring Boot를 기동하게 되면 MapperImpl이 자동으로 만들어지게 되요.

Package Path

728x90

package com.junyharang.endecrypttest.common.mapper;

import com.junyharang.endecrypttest.model.dto.request.BoardRequestDTO;
import com.junyharang.endecrypttest.model.dto.request.BoardRequestDTO.BoardRequestDTOBuilder;
import com.junyharang.endecrypttest.model.entity.TestBoard;
import com.junyharang.endecrypttest.model.entity.TestBoard.TestBoardBuilder;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.processing.Generated;
import org.springframework.stereotype.Component;

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2022-12-07T22:50:19+0900",
    comments = "version: 1.4.2.Final, compiler: IncrementalProcessingEnvironment from gradle-language-java-7.5.1.jar, environment: Java 11.0.16 (Azul Systems, Inc.)"
)
@Component
public class TestBoardMapperImpl implements TestBoardMapper {

    @Override
    public BoardRequestDTO toDTO(TestBoard entity) {
        if ( entity == null ) {
            return null;
        }

        BoardRequestDTOBuilder boardRequestDTO = BoardRequestDTO.builder();

        boardRequestDTO.title( entity.getTitle() );
        boardRequestDTO.content( entity.getContent() );

        return boardRequestDTO.build();
    }

    @Override
    public TestBoard toEntity(BoardRequestDTO dto) {
        if ( dto == null ) {
            return null;
        }

        TestBoardBuilder testBoard = TestBoard.builder();

        testBoard.title( dto.getTitle() );
        testBoard.content( dto.getContent() );

        return testBoard.build();
    }

    @Override
    public List<BoardRequestDTO> toDTOList(List<TestBoard> entityList) {
        if ( entityList == null ) {
            return null;
        }

        List<BoardRequestDTO> list = new ArrayList<BoardRequestDTO>( entityList.size() );
        for ( TestBoard testBoard : entityList ) {
            list.add( toDTO( testBoard ) );
        }

        return list;
    }

    @Override
    public List<TestBoard> toEntityList(List<BoardRequestDTO> dtoList) {
        if ( dtoList == null ) {
            return null;
        }

        List<TestBoard> list = new ArrayList<TestBoard>( dtoList.size() );
        for ( BoardRequestDTO boardRequestDTO : dtoList ) {
            list.add( toEntity( boardRequestDTO ) );
        }

        return list;
    }

    @Override
    public void updateFromDTO(BoardRequestDTO dto, TestBoard entity) {
        if ( dto == null ) {
            return;
        }
    }
}

위와 같이 자동으로 구현체 Class가 생기는 것을 확인할 수 있어요.

    🔽 코드 사용

        📦 Service Layer

BoardServiceImpl.insertBoard() - 수정 전

원래는 위와 같이 Entity의 Builder Pattern을 통해 DTO를 Entity로 바꾸는 Logic이였던 것을
MapStruct를 사용해서 변경해 볼게요.

BoardServiceImpl.insertBoard() - 수정 후

위와 같이 수정을 완료 해 주었어요.

최초 content 값을 암호화 해주는 Logic이 구현되어 있었기 때문에 RequestDTO에 setContent()를 호출하여 암호화 Logic을 탄 뒤 반환되는 암호값이 content Field에 저장되도록 하여주었어요.

그런 뒤 43번째 줄에 BoardReqeustDTO 객체를 Entity로 변환해주는 Method를 통해 Entity를 얻게하고, 그것을 Repository로 보내게 구현해 주었어요.

위와 같이 글 작성을 성공하였어요.

상세 조회 기능을 이용했을 때도 정상적으로 복호화가 되면 값을 반환받은 것을 확인할 수 있어요.

🧐 참고 자료

[Spring] MapStruct를 이용한 Entity, Dto 반환 및 고찰

 

 

 

백견불여일타 스프링 부트 쇼핑몰 프로젝트 with JPA:이젠 프로젝트다!

 

 

React.js 스프링 부트 AWS로 배우는 웹 개발 101:SPA REST API 기반 웹 애플리케이션 개발

 

 

스타트 스프링 부트:초급 개발자들을 위한 가볍고 넓은 스프링 부트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."