MapStruct에 이런 기능이 있었는데 혹시 알고 계셨나요? (Enum to Enum Automatically)

[github-insu]

BoardEntityStatus를 새로 만들었는데 BoardStatus와 열거 상수 매핑이 필요했습니다.
그런데 별생각 없이 빌드 후, 자동으로 생성된 BoardEntityMapperImpl 코드를 보니 알아서 매핑 할 수 있도록 함수를 자동으로 만들어 줬습니다!

당장 찾아보는 건 아니지만, 어떻게 이렇게 가능한지도 궁금하고,
이밖에도 Mapper가 타입이 같지만 변수명이 달라도 매핑이 되는지 리서치 해 보면 좋을 것 같습니다!

• BoardEntityMapper 가 자동으로 만든 함수

protected BoardStatus toDomainStatus(BoardEntityStatus boardEntityStatus) {
    if ( boardEntityStatus == null ) {
        return null;
    }

    BoardStatus boardStatus;

    switch ( boardEntityStatus ) {
        case REMOVED: boardStatus = BoardStatus.REMOVED;
        break;
        case PENDING: boardStatus = BoardStatus.PENDING;
        break;
        case ACTIVE: boardStatus = BoardStatus.ACTIVE;
        break;
        case SUSPENDED: boardStatus = BoardStatus.SUSPENDED;
        break;
        default: throw new IllegalArgumentException( "Unexpected enum constant: " + boardEntityStatus );
    }

    return boardStatus;
}

protected BoardEntityStatus toEntityStatus(BoardStatus boardStatus) {
    if ( boardStatus == null ) {
        return null;
    }

    BoardEntityStatus boardEntityStatus;

    switch ( boardStatus ) {
        case PENDING: boardEntityStatus = BoardEntityStatus.PENDING;
        break;
        case ACTIVE: boardEntityStatus = BoardEntityStatus.ACTIVE;
        break;
        case SUSPENDED: boardEntityStatus = BoardEntityStatus.SUSPENDED;
        break;
        case REMOVED: boardEntityStatus = BoardEntityStatus.REMOVED;
        break;
        default: throw new IllegalArgumentException( "Unexpected enum constant: " + boardStatus );
    }

    return boardEntityStatus;
}

추가적으로 MapStruct를 찾아보신 내용 중에 공유할 만한 내용이 있다면 공유해 주세요~

[wch-os]

1) MapStruct 매핑

MapStruct는 기본적으로 타입과 변수명이 같은 경우 자동으로 매핑을 지원해주지만, 타입이 같지만 변수명이 다른 경우 아래와 같이 매핑할 수 있습니다

@Mapping(target = "boardName", source = "boardEntityName")
Board toBoard(BoardEntity boardEntity);

• source: 원본 객체 필드 (BoardEntity)
• target: 매핑될 객체 필드 (Board)

2) Enum 간의 매핑

위와 같이 @Mapping 어노테이션은 일반적인 객체 필드 간의 매핑은 가능하지만, Enum 간의 매핑에는 적용되지 않아 @ValueMapping 어노테이션을 사용할 수 있습니다.

cf. 이전에 bfdc4e5 서 언급주신@Named + qualifiedByName과, MapStruct 1.2(?) 버전부터 사용이 가능한 @EnumMapping을 이용한 매핑도 가능합니다.

@ValueMappings({
    @ValueMapping(source = "ENABLED", target = "ACTIVE"),
    @ValueMapping(source = "DISABLED", target = "INACTIVE"),
    @ValueMapping(source = "REMOVED", target = "DELETED")
})
BoardStatus toBoardStatus(BoardEntityStatus boardEntityStatus);

3) 매핑 시 기본값 지정

또한 defaultValue를 통해서 source 값이 null일 시, 지정된 값으로 설정 및
constant를 사용하여 source 값과 무관하게, 항상 지정된 값으로 설정도 가능합니다.

@Mapping(target = "title", defaultValue = "Untitled")
Board toBoard(BoardEntity boardEntity);

@Mapping(target = "title", constant = "Fixed title")
Board toBoard(BoardEntity boardEntity);

4) 추가 기능

이 밖에도 MapStruct 내에서 지원하는 기능들이 많아, 관련하여 추가 기능 구현이 필요하실 때 공식문서도 참고해 보면 좋을 것 같습니다!

참고

• MapStruct Docs
• 편리한 객체 간 매핑을 위한 MapStruct 적용기 (feat. SENS)

[silberbullet]

오호 맞네요!! @wch-os 님에 링크 걸어주신 MapStruct Docs에서 내용을 보니,

---

MapStruct supports the generation of methods which map one Java enum type into another.
By default, each constant from the source enum is mapped to a constant with the same name in the target enum type. If required, a constant from the source enum may be mapped to a constant with another name with help of the @ValueMapping annotation. Several constants from the source enum can be mapped to the same constant in the target type.

MapStruct는 한 Java enum 타입을 다른 enum 타입으로 매핑하는 메서드를 자동으로 생성하는 기능을 지원합니다.

기본적으로 소스 enum의 각 상수는 동일한 이름을 가진 타겟 enum의 상수로 매핑됩니다. 하지만, 필요에 따라 @ValueMapping 애너테이션을 사용하여 소스 enum의 특정 상수를 타겟 enum의 다른 이름의 상수로 매핑할 수도 있습니다. 또한, 여러 개의 소스 enum 상수를 동일한 타겟 enum 상수에 매핑하는 것도 가능합니다.

---

이렇게 기재되어 있네요!

다행히 저희 BoardStatus.java와 BoardEntityStatus.java 상수 이름이 둘 다 똑같아서 MapStruct가 자동으로 매핑이
된거였네요!!😆

[silberbullet]

MapStruct 라이브러리가 참 똑똑하게 잘 만든 것 같네요!

그렇지만 MapStruct도 저희가 알고 있는 의도와 다르게 작동할 수 있다는 생각이 들어요! 🤔
잠깐 리서치 해보면 프로젝트에서 Lombok 라이브러리랑 같이 사용할 때, 어노테이션 프로세싱 순서 문제로 의도치 않게 매핑이 될 수도 있다고 하네요?

어찌 보면 남이 해준 매핑이니 신경써보는 것도 좋을 것 같네요!