[SpringBoot] JPA를 통해 엔티티 반환시 DtoVo 사용하기

📌 상황

Spring Data JPA를 통해 엔티티 조회시 기존에는 아래와 같이 코드를 작성하였다.

//기존 코드
Page<PharmacyMenu> findByMenuKorNameContains(String menuKorName, Pageable pageable);
Page<PharmacyMenu> findByMenuEngNameIgnoreCaseContains(String menuEngName, Pageable pageable);

 

위의 코드가 틀린 것은 아니지만, 몇가지 문제점이 존재한다.

 

1. 기존의 방식은 엔티티 자체가 반환되기 때문에 만약 조회시 특정 필드 값만 필요하다면, 불필요한 필드 값이 모두 반환되는 상황이다.

2. 불필요한 필드가 많거나 해당 필드의 타입이 text와 같이 사이즈가 크다면, 성능 이슈가 발생할 수 있다. 즉, 기존의 방식은 SELECT * FROM 과 같은 경우이다.

 

📌 개선

필요한 필드만 선언해둔 DtoVo 클래스를 별도로 구성하여 엔티티 자체 조회가 아닌 특정 필드들 조회로 개선이 가능하다.

//DtoVo 예시
@Getter
public class PharmMenuListResDtoVo {

    private Long id;
    private String menuKorName;
    private String menuEngName;
    private String menuUrlPath;
    private int menuOrder;
    
    @Builder
    public PharmMenuListResDtoVo(Long id, String menuKorName, String menuEngName, String menuUrlPath, int menuOrder) {
    	this.id = id;
        this.menuKorName = menuKorName;
        this.menuEngName = menuEngName;
        this.menuUrlPath = menuUrlPath;
        this.menuOrder = menuOrder;
    }
}

 

DtoVo 클래스를 사용하여 변경한 조회 코드는 다음과 같다.

//조회 코드 변경 예시
@Query("select pm.id as id, " +
            "pm.menuKorName as menuKorName, " +
            "pm.menuEngName as menuEngName, " +
            "pm.menuUrlPath as menuUrlPath, " +
            "pm.menuOrder as menuOrder " +
            "from PharmacyMenu pm " +
            "where (pm.menuKorName like %:menuName% or pm.menuEngName like %:menuName%)")
Page<PharmMenuListResDtoVo> findByMenuName(@Param("menuName") String menuName, Pageable pageable);

• JPQL로 쿼리를 작성해 엔티티에서 필요한 필드만 가져오도록 한다.
• 위에서 @Query()내의 as 뒤의 {변수명}과 DtoVo 클래스 내의 필드명을 맞춰주면 Spring Data JPA가 자동으로 매핑해준다. 이후 Service 클래스 내에서 DTO로 변경할 때 유용하다.

 

📌 Entity와 DTO 간 변환하는 방식

방식1 - Mapper 사용

단점: 에러 발생시 찾기 어렵다.

 

방식2 - 각각의 필드를 일일이 매핑

 

방식3 - Spring의 Page를 사용하는 경우 Page 인터페이스의 map() 사용

//코드 예시
public Page<PharmMenuDto.PharmMenuListResDto> getPharmMenuList(PharmMenuDto.PharmMenuListReqDto pharmMenuListReqDto) {

        Pageable pageable = PageRequest.of(pharmMenuListReqDto.getPage(), pharmMenuListReqDto.getSize()); //전달할 Pageable 객체 생성

        Page<PharmMenuListResDtoVo> pharmMenuListResDtoVos = pharmacyMenuRepository.findByMenuName(pharmMenuListReqDto.getMenuName(), pageable);

        return pharmMenuListResDtoVos.map(pml -> new PharmMenuDto.PharmMenuListResDto(
                pml.getId(), pml.getMenuKorName(), pml.getMenuEngName(), pml.getMenuUrlPath(), pml.getMenuOrder()
        )); //Page 인터페이스의 map() 사용하여 DTO로 매핑
   }