MapStruct

Posted on | Edited on | In | Comments:

기본 사용법

클래스간 변환을 간편하게 해주는 라이브러리이다(Car <> CarDTO)
아래는 Mapper 선언법이다.

1
2
3
4
5
6
7
8
9
10
11
12
@Mapper(componentModel = "spring", uses = {
    OwnerMapper.class // 3
})
public interface CarMapper {
    CarMapper INSTANCE = Mappers.getMapper( CarMapper.class );

    @Mapping(source = "numberOfSeats", target = "seatCount") // 1
    CarDto toDto(Car car);

    @Mapping(target = "id", ignore = true) // 2
    Car toEntity(CarDTO dto);
}

보다시피 entity를 DTO로 변환해주는 작업을 한다(지금은 엔티티와 DTO를 예시로 들었지만 어떤 클래스든 상관없다).
아래의 generate 된 코드를 보면 알 수 있곘지만,
변환될 클래스는 setter가 필요하고, 변환대상 클래스는 getter가 필요하다.

  1. source와 target의 필드 이름이 다를 경우 직접 지정할 수 있다
  2. ignore를 통해 특정 필드는 변환되지 않도록 설정할 수 있다. target만 신경쓰면 된다.
  3. 기본적으로 deep mapping 하는 코드까지 generation 해주긴하나, 기본적인 방식으로만 generation 된다(이름에 맞춰서 get/set)
    그러므로 custom한 mapper가 필요하다면 위와 같이 선언해줘야 한다.

install한 library로 빌드하면 @Mapper 인터페이스들을 찾아서 XXXImpl의 형태로 구현체를 모두 만든다.(빌드 방식 알아봐야함)

현재 componentModel을 spring으로 줬기때문에 생성되는 Impl은 스프링의 싱글톤 빈으로 관리된다(@Component 붙음)

생성된 구현체는 아래와 같다. 간단하다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Override
public CarDTO toDto(Car entity) {
    if ( entity == null ) {
        return null;
    }

    CarDTO carDTO = new CarDTO();

    carDTO.setName( entity.getName() );
    carDTO.setSeatCount( entity.numberOfSeats() );
    carDTO.setOwner( ownerMapper.toDto(entity.getOwner() ) );

    return carDTO;
}

아래는 간단한 사용법이다.

1
2
3
4
5
6
7
8
9
10
11
12
// some service
public void save(CarDTO carDTO){
    Car car = CarMapper.INSTANCE.toEntity(carDTO);
    
    em.persist(car);
}

public CarDTO select(){
    Car car = em.find(Car.class, 1);

    return CarMapper.INSTANCE.toDTO(car);
}