MapStruct with Kotlin

Mapper 정의 : @Mapper

@Mapper(componentModel = "spring")
interface GenreMapper{

    @Mappings(
      Mapping(source = "genreCodes", target = "code"),
      Mapping(source = "engName", target = "enName"),
      //Mapping(source = "krName", target = "krName"),
      //Mapping(source = "imageUrl", target = "imageUrl"),
      //Mapping(source = "topImageUrl", target = "topImageUrl"),
      //Mapping(source = "colorBar", target = "colorBar")
    )
	fun toGenreDTO(genre: Genre): GenreDTO

}

• interface에 매핑 메소드를 정의하고 org.mapstruct.Mapper 어노테이션 추가

• Mapstruct Code Generator 가 @Mapper 가 붙은 인터페이스를 찾아서 XXXImpl 형태로 구현체를 생성함

• 구현체 생성시 source, target이 되는 클래스의 속성명을 비교하고 자동으로 매핑코드를 작성
  • 1:1 매핑이 원활하게 되기 위해서는 source, target 쪽 타입선언이 동일해야함

• 속성명이 다를 경우 @Mapping 어노테이션을 통해 매핑정보를 직접 정의
  • 여러개의 Mapping을 정의할경우 @Mappings 어노테이션으로 묶어줘야함

• source, target class 에 기본 생성자가 반드시 선언되어있어야 하며 source 에는 setter가, target에는 getter가 필요함 (data class 사용하면 됨)

• @Mapper(componentModel = "spring") : Impl 은 스프링의 싱글톤 빈으로 관리됨(@Component)

 

MapStruct가 생성한 구현체

build/generated/source/kapt/...

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2021-05-17T18:09:21+0900",
    comments = "version: 1.4.2.Final, compiler: IncrementalProcessingEnvironment from kotlin-annotation-processing-gradle-1.4.30.jar, environment: Java 11.0.10 (JetBrains s.r.o.)"
)
@Component
public class GenreMapperImpl implements GenreMapper {

    @Override
    public GenreDTO toGenreDTO(Genre genre) {
        if ( genre == null ) {
            return null;
        }

        String code = null;
        String enName = null;
        String krName = null;
        String imageUrl = null;
        String topImageUrl = null;
        String colorBar = null;

        code = genre.getGenreCodes();
        enName = genre.getEngName();
        krName = genre.getKrName();
        imageUrl = genre.getImageUrl();
        topImageUrl = genre.getTopImageUrl();
        colorBar = genre.getColorBar();

        GenreDTO genreDTO = new GenreDTO( code, enName, krName, imageUrl, topImageUrl, colorBar );

        return genreDTO;
    }
}

 

Mapping method 작성법

1. source, target의 속성명이 다른경우
   • Mapping(source = "genreCodes", target = "code")

2. target의 특정 속성을 제외하고 싶은 경우
   • ignore = true로 무시할 속성 지정

   @Mapper(unmappedTargetPolicy = ReportingPolicy.ERROR)
   interface GenreMapper {
   
       @Mapping(target = "code", ignore = true)
       fun toGenreDTO(genre: Genre): GenreDTO
   
   }

   • 일치하지 않는 필드 무시하도록 정책 설정
     • unmappedTargetPolicy = ReportingPolicy.IGNORE
   
   
   • unmappedTargetPolicy = ReportingPolicy.ERROR
     • 매핑 시 타깃 객체에 대한 매핑 정책을 엄격하게 가져가기 위해 타깃 객체에 매핑 시 매핑되지 않은 속성이 있다면 컴파일 에러를 발생시키도록 정책을 설정

3. conversion 메소드를 직접 정의
   • java object로 감싸서 전달

   @Mapper
   interface GenreMapper {
   
       @Mapping(target = "code", expression = "java(genre.getCustomGenreCode())")
       fun toGenreDTO(genre: Genre): GenreDTO
   }

4. 다수의 엔티티를 합치기 위해 여러개의 source parameter를 전달하는 경우
   • 각 속성들은 이름을 비교하여 자동으로 매핑
   • source 속성명이 겹치는 경우 @Mapping 어노테이션으로 어느 source 속성을 매핑할 것인지 명시

   @Mapper
   interface GenreArtistMapper {
   
       @Mappings(
               Mapping(source = "artist.id", target = "artist_id"),
               Mapping(source = "artist.name", target = "artist_name"),
               Mapping(source = "genre.code", target = "genre_code")
       )
       fun toGenreArtistDTO(artist: Artist, genre: Genre): GenreArtistDTO
   
   }

   • source 로 주어진 파라미터를 직접적으로 target의 속성에 매핑할 수 있음

   @Mapper
   interface GenreMapper{
   
   	@Mappings(
   		Mapping(source = "genreCodes", target = "code"),
       Mapping(source = "engName", target = "enName"),
       Mapping(source = "number", target = "genreNumber")
     )
   	fun toGenreDTO(genre: Genre, number: Int): GenreDTO
   
   }

5. Mapping method를 직접 구현
   1. mapstruct로 매핑코드를 구현하지 못하는 경우
   2. interface에 default 메소드로 커스텀 매핑을 추가 (kotlin은 따로 keyword 붙이지 않아도됨)
      • Kotlin

      @Mapper
      interface GenreMapper {
      
          fun toGenreDTO(genre: Genre) GenreDTO {
              // mapping method 직접 구현
          }
      
      }

      • Java

      @Mapper
      public interface GenreMapper {
      
          default GenreDTO toGenreDTO(Genre genre) {
              // mapping method 직접 구현
          }
      
      }

 

링크

• https://mapstruct.org/documentation/stable/reference/html/
• https://meetup.toast.com/posts/213
• https://www.tutorialspoint.com/mapstruct/index.htm