[Spring] Map Struct 사용하기

Map Struct

https://mapstruct.org/    

 

💡 MapStruct는 구성 접근법에 대한 규약에 근거하여 Java Bean 종류 간의 매핑 구현을 크게 단순화한 code generator 이다.

 

간단하게 말하면 Dto 와 Entity의 변환을 쉽게 도와주는 라이브러리이다.

그렇다면 Map Struct를 왜 사용할까?

 

 

장점

1. 어노테이션을 사용하여 컴파일시 매핑코드가 생성되기때문에 컴파일 오류 확인이 가능하다. (컴파일 시점에 매핑 정보가 타입 세이프한 지를 검증)
2. 리플렉션이 아닌 직접 메소드를 호출하는 방식으로 동작하여 속도가 빠르다.
3. 디버깅이 쉽다.
4. 구현체를 자동으로 생성 되기때문에 생성된 매핑 코드를 눈으로 확인 할 수 있다.

 

→ 실제 거대한 시스템을 만들다보면, 다양한 도메인 영역들이 있고 이를 변환하는 작업은 개발자에게 있어서 매우 번거롭고 실수하기 좋다. mapstruct 라이브러리를 통해 실수를 줄여 안전한 개발을 할 수 있을 것같다.

 

 

 

사용해보기

 

의존성 추가

dependencies {
    // lombok
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok:1.18.22'

    implementation 'org.mapstruct:mapstruct:1.5.3.Final'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'

    // lombok 에서 mapstruct binding 해주는 기능 
    annotationProcessor 'org.projectlombok:lombok-mapstruct-binding:0.2.0'
}

lombok과 mapstruct 라이브러리를 추가해준다.

이때, lombok-mapstruct-binding 의존성을 추가해주지 않으면 lombok과 mapstruct 의존성 선언 순서에 따라 다르게 동작할 수 있다.

 

 

사용하기

 

UserEntity

@AllArgsConstructor
@Getter
@Builder
public class User {

    private Long id;

    private String name;

    private Integer age;

    private LocalDateTime createdTime;
}

UserDto

@AllArgsConstructor
@Getter
@Builder
public class UserDto {

    private String name;

    private Integer age;

    private String email;

    private LocalDateTime created;
}

 

Entity 객체와 Dto 객체가 가진 필드가 조금씩 다르다.

• UserDto에는 id 필드가 존재하지 않고 User에는 email 필드가 존재하지 않는다. (필드 불일치)
• 생성시간이 UserDto는 created 필드로 User에는 createdTime로 선언되어 있다. (필드 이름 불일치)

 

❗️ 꺼내오는 객체(source)에는 Getter가 있어야하고 저장하는 객체(target)에는 Builder 혹은 AllArgsConstructor가 있어야한다.

 

 

Mapper를 만든다.

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;

@Mapper // 1
public interface UserMapper {
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class); // 2

    // 3
    @Mapping(target = "id", constant = "0L")
    @Mapping(source = "created",target = "createdTime")
    User userDtoToEntity(UserDto userDto);

    // 4
    @Mapping(target = "email", expression = "java(user.getName() + \"@naver.com\")") 
    @Mapping(source = "createdTime",target = "created")
    UserDto userToDto(User user);
}

1. 매핑 인터페이스임을 명시한다.
2. 사용자가 접근할 수 있는 매퍼 객체를 만들어 준다. (여기서 Instance가 UserMapper를 상속받아서 UserMapperImpl를 구현해준다. )
3. UserDto → User 메소드
   • User에만 있는 id 필드를 상수 "0L"로 지정한다. 
   •  ( id 생성 전략이 Auto Increment여서 값을 대입하고 싶지 않을때는 @Mapping(target = "id", ignore = true) 사용할 수 있다. )
   • UserDto의 created 필드를 User에 createdTime 필드로 저장
   • UserDto에만 있는 email 필드는 기본적으로 무시된다.
4. User → UserDto 메소드
   
   • UserDto의 email 필드를 expression을 기반으로 name@naver.com으로 만든다.

 

 

응용

• 여러 파라미터를 매핑한다.

@Mapper
public interface AddressMapper {

    @Mapping(source = "person.description", target = "description")
    @Mapping(source = "address.houseNo", target = "houseNumber")
    AddressDto personAndAddressToAddressDto(Person person, Address address);
}

두가지 파라미터를 조합하여 Dto로 매핑

 

 

• 조건이 여러개라면 @Mappings로 묶어서 세팅해줄 수 있다.

@Mapper
public interface UserMapper {

    @Mappings({
        @Mapping(source = "nickname2", target = "nickname"),
        @Mapping(target = "address", ignore = true),
        @Mapping(target = "name", ignore = true),
        @Mapping(target = "age", ignore = true)
    })
    UserSaveRequestDto from(UserSaveRequest2 userSaveRequest);
}

 

 

• mapper 어노테이션에 속성을 추가할 수 있다.

@Mapper(
      componentModel = "spring", // 빌드 시 구현체 만들고 빈으로 등록
      injectionStrategy = InjectionStrategy.CONSTRUCTOR, // 생성자 주입 전략
      unmappedTargetPolicy = ReportingPolicy.ERROR // 일치하지 않는 필드가 있으면 빌드 시 에러
)
public interface UserMapper { 
			...
}

unmappedTargetPolicy = ReportingPolicy.IGNORE 로 설정하면 값을 대입하고 싶지 않은 필드를 일괄 ignore 처리할 수있다.

 

 

• 중첩(nested) 매핑을 할 수 있다.

@Mapper
public interface OrderMapper {

    @Mapping(source = "OrderItemDto", target = "orderItem")
    @Mapping(source = "OrderItemDto.amount", target = "orderItem.count")
    Order OrderCreateDtoToOrder(OrderCreateDto orderCreateDto);
}

OrderCreateDto의 orderItemDto 필드 객체를 Order 엔티티 orderItem 필드 객체에 매핑한다. 이때 orderItemDto의 amount값을 orderItem의 count에 매핑한다.

https://stackoverflow.com/questions/43518374/mapping-a-dto-in-a-dto-to-entity-in-entity-with-mapstruct   

 

 

 

MapStruct가 생성한 구현체를 사용하는 두가지 방식

 

1. Mapper Factory 사용

@Mapper 
public interface UserMapper {

    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class); 
 
    ....
}

생성된 Mapper 인스턴스를 받아와 사용할 수 있다.

이 패턴은 mapper를 사용하기 위해 인스턴스를 새로 생성할 필요없이 싱글톤으로 새성된 인스턴스를 사용할 수 있다.

 

// INSTANCE 사용하기
UserDto userDto = MemberMapper.INSTANCE.UserToDto(user);

 

 

2. Dependency Injection 사용

 

DI를 지원하는 프레임워크를 사용한다면 구현된 매퍼들을 DI를 통해 사용할 수 있다.

@Mapper(componentModel = "spring")
public interface MemberMapper {

    MemberDto memberToDto(Member member);
}

• 지원하는 프래임워크들
  • cdi: 매퍼를 application-scoped CDI bean으로 생성하며 @Inject 를 통해 사용할 수 있다.
  • spring: 매퍼를 스프링 빈으로 생성하며 @Autowired 를 통해 사용할 수 있다.
  • jsr330: @javax.inject.Named, @Singleton어노테이션을 매퍼에 붙여 빈을 생성하며 @Inject 를 통해 사용할 수 있다.

 

@Autowired 사용하여 의존성 주입

@Autowired
private MemberMapper mapper;

 

 

검증

@Test
public void mapperTest() throws Exception {

    User user = repository.findById(1L).get();

    UserDto userDto = UserMapper.INSTANCE.userToDto(user);
}

 

ComponentModel을 Spring으로 설정하였을 경우에도, 스프링을 띄워 DI로 주입 받을 필요없이 인스턴스로 생성하여 단위 테스트 한다.

public class UserDtoMapperTest {

    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);

    public void mapperTest(){ 
    	...
    }
}

 

 

끝!

잘못된 정보가 있다면 댓글을 통해 알려주세요. 감사합니다. 

 

 

 

reference. 

https://huisam.tistory.com/entry/mapStruct

https://kth990303.tistory.com/131

https://wise-develop.tistory.com/18 

https://ykh6242.tistory.com/entry/%EB%B0%98%EB%B3%B5%EC%A0%81%EC%9D%B8-DTO-%EB%B3%80%ED%99%98-%EC%9E%91%EC%97%85%EC%9D%84-%ED%95%9C-%EB%B2%88%EC%97%90-%EC%A0%95%EC%9D%98-MapStruct-%EA%B8%B0%EB%B3%B8-%EC%A0%95%EB%A6%AC