[MapStruct] 내가 찾아 쓰려고 정리한 글

 

🏃‍♂️ 계속해서 업데이트 하기 🏃‍♂️

 

1. 공식문서

2. 왜 사용할까?

3. 동작방식

4. 의존성

5. Mapper Inteface 작성

6. Mapper 구현체 살펴보기

 

 

 

 

공식문서

 

https://mapstruct.org/documentation/stable/reference/pdf/mapstruct-reference-guide.pdf

 

 

 

MapStruct 왜 사용할까?

 

보통 DB에서 데이터를 조회하고 서비스단에서 로직을 설계 하기 위해 Entity -> Dto , Dto -> Entity 작업을 하게 되는데 이러한 Mapping 작업을 해주는 라이브러리가 많이 존재한다 그중 아래의 링크를 확인해보면 MapStruct 퍼포먼스가 빠른 것을 확인할 수 있다.

https://www.baeldung.com/java-performance-mapping-frameworks

 

 

동작방식

 

사용자가 인터페이스 구현을 생성하고 맵핑 관련 설정을 해주면 컴파일하는동안 MapStruct가 내부 구현체에서 setter를 이용하여 객체를 맵핑한다.

 

 

의존성

 

Maven

...
<properties>
    <org.mapstruct.version>1.4.2.Final</org.mapstruct.version>
</properties>
...
<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
</dependencies>
...
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source> <!-- depending on your project -->
                <target>1.8</target> <!-- depending on your project -->
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                    <!-- other annotation processors -->
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

 

Gradle

dependencies {
    ...
    implementation 'org.mapstruct:mapstruct:1.4.2.Final'
 
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final'
}

 

 Mapper Inteface 작성

public class OrderDto{
    private int itemCount;
    private ItemStatus itemStatus;
    private Brand brand;
}

public class Orders{
    private long id;
    private ItemList itemList;
    private Brand brand;
}

public class Brand{
    private Long id;
    private String name;
    private Stirng tel;
}

@Mapper(uses = {BrandMapper.class})
public interface OrderMapper {

  OrderMapper INSTANCE = Mappers.getMapper(OrderMapper.class);
 
  @Mapping(target = "brand", source = "brand")
  @Mapping(target = "itemCount", source = "itemList", qualifiedByName = "itemCount")
  @Mapping(target = "itemStatus", source = "itemList.status")
  OrderDto toDto(Orders orders);

  List<OrderDto> toListDto(List<Orders> orders);
  
  @Named("itemCount")
  default int itemCount(List<ItemList> itemList){
  return (int) itemList.stream()
  			.map(itemList::getItemId)
  			.distinct()
  			.count();
  }


}

 

 

Orders Entity -> OrderDto 로 변경하는 작업이다 

 

@Mapper(uses = {BrandMapper.class})

- OrderDto 안에 Brand 필드가 있기 때문에 BrandMapper 도 만들어준 다음에 포함시켜줘야한다.

밑에 구현체 에서 어떻게 사용되는지 설명하겠음

 

- Orders 에 id 와 OrderDto 에 id 는 필드명이 같기 때문에 따로 @Mapping 해주지 않아도 자동으로 맵핑된다.

그 외에 필요한 필드는 @Mapping으로 연결해줍니다

 

- Dto에 있는 ItemStatus 는 Orders의 itemList의 status로 맵핑한다.

 

@Mapping(target = "itemCount", source = "itemList", qualifiedByName = "itemCount")

@Named("itemCount")

- Dto로 변환중에 계산이 필요할 경우 따로 메서드를 빼줍니다 -> 구현체 생성시 제외하고 생성함. 해당 이름을 가진 메서드를 호출한다.

 

 

 

Mapper 구현체 살펴보기

 

어떤식으로 작성하는지 확인하고 싶다면 해당 인터페이스의 구현체를 찾아가보면 된다. 예시는 아래와 같다

(Interface 작성 후 target/generated-sources-annotaions 를 rebuild 하면 자동으로 생성된다) 

나는 기본생성자, Setter 가 아닌 Builder 를 사용했기 때문에 아래와 같은 코드가 생성되어있다.

public class OrderMapperImpl implements OrderMapper {

    private final BrandMapper brandMapper = Mappers.getMapper( BrandMapper.class );

	@Override
    public OrderDto toDto(Orders orders) {
        if ( orders == null ) {
            return null;
        }

        OrderDtoBuilder orderDto = OrderDto.builder();

        orderDto.brand( brandMapper.toDto( brandMapper.toDto(orders) ) );
        orderDto.itemCount( itemCount( orders.getItemList() ) );
        orderDto.status( itemStatus( orders ) );
        
        
    private ItemStatus itemStatus(Orders orders) {
        if ( orders == null ) {
            return null;
        }
        ItemList itemList = orders.getItemList();
        if ( itemList == null ) {
            return null;
        }
        ItemStatus itemStatus = goodsReceipt.getItemStatus();
        if ( itemStatus == null ) {
            return null;
        }
        return itemStatus;
    }
    

        return orderDto.build();
        }
 }