MapStruct로 dto 매핑 지옥 탈출

적용 배경

프로젝트 개발 중 변수가 40개 이상이되는 테이블을 조회해서 DTO로 변환 후 리턴해줘야하는 API를 만났다
getter setter 좍좍 타이핑할 생각에 정신이 아득해져서 구글링으로 Entity to Dto 를 검색했다
ModelMapper 라이브러리를 발견 후 적용해보려는데 나랑 너무 안맞아서 다른 라이브러리를 찾아보았고 그것이 MapStruct이다

MapStruct 시작하기

의존성 추가하기 build.gradle

lombok 사용하는 경우 작성 순서가 매우 중요하다 👉 lombok 이후에 정의

1dependencies {
2    ...
3    implementation 'org.projectlombok:lombok'
4    annotationProcessor 'org.projectlombok:lombok'
5    implementation 'org.mapstruct:mapstruct:1.5.3.Final'
6    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'
7    ...
8}

Mapper interface 작성

1import org.mapstruct.Mapper;
2import org.mapstruct.Mapping;
3import org.mapstruct.factory.Mappers;
4
5@Mapper //어노테이션 적용
6public interface ConditionsMapper {
7    ConditionsMapper INSTANCE = Mappers.getMapper(ConditionsMapper.class);
8    // Mappers.getMapper()로 싱글톤 생성하여 INSTANCE를 호출해서 사용
9
10    /* abstract method 정의
11     * @Mapping : 해당 어노테이션을 통해 변수 이름만으로 생성된 getter, setter만으로 매핑이 불가능한 경우를 정의
12     *  * source : method의 파라미터중에서 어떤 파라미터를 사용하여 매핑할 것인지 명시하면 됨
13          예시 코드에서는 method 파라미터가 1개이지만, 2개 이상의 객체를 받아서 하나의 target 객체로 매핑하는 경우도 정의할 수 있다.
14          단, 하나의 @Mapping source 속성에서 하나의 파라미터 객체만 다룰 수 있음 -> @Mapping 여러개를 사용할 수 있음
15     *  * target : method의 리턴 타입
16     */
17    @Mapping(source = "condition.equipmentType", target = "equipmentType", qualifiedByName = "equipmentTypeToString")
18    /* ☝ source쪽 객체에서 equipmentType이라는 변수의 타입이 EquipmentType이라는 Enum객체인데,
19       target쪽 객체에서는 String type으로 정의되어있는 경우 -> 별도 설정 없으면 Enum name이 그대로 target으로 매핑됨
20       이 경우 Enum에서 별도로 사용하고 싶은 fullName을 지정했다고 가정하고 그것을 매핑하는 방법을 예로 들었음 */
21    @Mapping(source = "condition", target = "product", qualifiedByName = "productToBaseProduct")
22    /* ☝ source 객체 자체를 target 변수에 매핑하는데 사용할 수 있음
23       이 경우 equipmentType별로 매핑해야하는 Product 클래스가 다른 경우를 가정하고 예를 들었음 */
24    @Mapping(source = "condition.param", target = "params")
25    /* ☝ 단순히 변수의 이름만 다른 경우 위와 같이 간단하게 정의할 수 있음
26       이 경우 source의 param은 List<Param>이고 target에 List<ParamDto> params로 정의되어 있는 경우를 가정하였고
27       MapStruct에서 알아서 객체, 콜렉션 매핑에 필요한 메소드를 2개 생성함 */
28    ConditionDto toConditionDto(Condition condition);
29
30    //변수명, 타입 등에서 특이사항이 없는 경우 아래와 같이 추상메소드 정의만 해두면 매핑 코드가 생성된다.
31    ProductChild1 toChild1(Product product);
32    ProductChild2 toChild2(Product product);
33
34    /* static method 구현
35     * toConditionDto 메소드의 첫번째 @Mapping 설정 중 qualifiedByName 속성에서 호출하게 될 메소드를 구현한 영역이다.
36     * MapStruct가 매핑 클래스를 구현해줄 때 @Named 어노테이션에 작성한 이름으로 코드를 작성하기 때문에 qualifiedByName이랑 맞춰줘야함
37     */
38    @Named("equipmentTypeToString")
39    static String equipmentTypeToString(EquipmentType equipmentType){
40        return equipmentType.getFullName();
41    }
42
43    @Named("productToBaseProduct")
44    static BaseProduct productToBaseProduct(Condition condition){
45        BaseProduct returnProduct = null;
46        Product product = condition.getProduct();
47
48        switch (condition.getEquipmentType()){
49        case EQUIP1:
50            returnProduct = INSTANCE.toChild1(product);
51            break;
52        case EQUIP2:
53            returnProduct = INSTANCE.toChild2(product);
54            break;
55        }
56
57        return returnProduct;
58    }
59}

컴파일 후 자동 생성된 클래스 구경

너무 길어서..👉 gist link

2에서 생성한 INSTANCE를 통해 메소드 호출

1public ConditionDto getCondition(Long id){
2    ...
3    Condition condition = conditionRepository.findById(id);
4
5    return ConditionMapper.INSTANCE.toConditionDto(condition);
6}

MapStruct와 ModelMapper의 차이점 (=MapStruct가 더 좋은 이유)

ModelMapper
- Collection, Enum 타입의 변수를 변환할 때 작성하는 코드가 너무 장황함
- 런타임에서 예외를 반환함
- 문제가 있을 때 디버깅이 불가능함
MapStruct
- Collection, Enum 타입 변환 코드가 간단함
- 컴파일할 때 예외를 반환함
- 디버깅이 쉬움 : 인터페이스로 매핑할 내용을 정의하면 컴파일 시 getter, setter를 사용한 클래스를 자동생성해주기 때문에

Collection type 변환 코드 비교

조회 결과가 findAll인 경우

1// ModelMapper
2List<User> users = userRepository.getUsers();
3List<UserDto> userList = users.stream()
4        .map(user -> modelMapper.map(user, UserDto.class))
5        .collect(Collectors.toList());

1// MapStruct
2UserDto toUserDto(User user);
3List<UserDto> toUserDtoList(List<User> users);

조회 결과가 findOne인 경우

1// ModelMapper
2User user = orderRepository.getOrdersGroupByUser();
3List<OrderDto> orders = user.getOrders()
4        .map(order -> modelMapper.map(order, OrderDto.class))
5        .collect(Collectors.toList());
6UserDto userDto = modelMapper.map(user, UserDto.class);
7userDto.setOrders(orders);

1// MapStruct : findAll에서 작성한 toUserDto로 처리 가능

Enum type 변환 코드 비교

Enum

1@Getter
2public enum Currency{
3    WON("￦"),
4    DOLLAR("$");
5
6    private String symbol;
7
8    Currency(String symbol){
9        this.symbol = symbol;
10    }
11}

ModelMapper

1@Bean
2public ModelMapper modelMapper(){
3    ModelMapper modelMapper = new ModelMapper();
4
5    Converter<Currency, String> currencyConverter = ctx -> ctx.getSource().getSymbol();
6    PropertiMap<Item, ItemDto> itemMap = new PropertyMap<>(){
7        protected void configure(){
8            using(currencyConverter).map(source.getCurrency()).setCurrency(null);
9        }
10    }
11    modelMapper.addMappings(itemMap);
12
13    return modelMapper;
14}

MapStruct

1@Mapping(source = "item.currency", target="currency", qualifiedByName = "currencyToSymbol")
2ItemDto toItemDto(Item item);
3
4@Named("currencyToSymbol")
5static String currencyToSymbol(Currency currency){
6    return currency.getSymbol();
7}

성능 차이 : MapStruct > ModelMapper
출처 : Java 매핑 프레임워크의 성능

결론

난 이제 MapStruct 없이 JPA를 사용할 수 없는 몸이 되었다. 우리나라에서는 ModelMapper의 점유율이 더 높다고 하는데 MapStruct 많이 쓰면 좋겠다.

참조

NHN Cloud Meetup Object Mapping 어디까지 해봤니?