xToOne(ManyToOne, OneToOne) 관계 최적화
간단한 주문 조회 V1: 엔티티를 직접 노출
/**
* xToOne (ManyToOne, OneToOne)
* Order
* Order -> Member
* Order -> Delivery
*/
@RestController
@RequiredArgsConstructor
public class OrderSimpleApiController {
private final OrderRepository orderRepository;
@GetMapping("/api/v1/simple-orders")
public List<Order> ordersV1() {
List<Order> all = orderRepository.findAllByString(new OrderSearch());
return all;
}
}
문제점
- 엔티티를 직접 노출하는 것은 좋지 않다.
- `order` `member` 와 `order` `delivery` 는 지연로딩이다.
- 따라서 실제 엔티티 대신에 프록시가 존재 (ByteBuddy)
- jackson 라이브러리는 기본적으로 이 프록시 객체를 json으로 어떻게 생성해야 하는지 모름 -> 예외 발생
- `Hibernate5Module` 을 스프링 빈으로 등록하면 해결(스프링 부트 사용중)
하이버네이트 모듈 등록
// 스프링 부트 3.0 미만: Hibernate5Module 등록
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-hibernate5'
// 스프링 부트 3.0 이상: Hibernate5JakartaModule 등록
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-hibernate5-jakarta'
스프링 빈 등록
@Bean // 스프링 부트 3.0 미만: Hibernate5Module 등록
Hibernate5Module hibernate5Module() {
return new Hibernate5Module();
}
@Bean // 스프링 부트 3.0 이상: Hibernate5JakartaModule 등록
Hibernate5JakartaModule hibernate5Module() {
return new Hibernate5JakartaModule();
}
- 기본적으로 초기화 된 프록시 객체만 노출, 초기화 되지 않은 프록시 객체는 노출 안함
주의점
- 엔티티를 직접 노출할 때는 양방향 연관관계가 걸린 곳은 꼭! 한곳을 `@JsonIgnore` 처리 해야 한다.
- 안그러면 양쪽을 서로 호출하면서 무한 루프가 걸린다.
-
지연 로딩(LAZY)을 피하기 위해 즉시 로딩(EARGR)으로 설정하면 안된다!
- 즉시 로딩 때문에 연관관계가 필요 없는 경우에도 데이터를 항상 조회해서 성능 문제가 발생할 수 있다.
-
즉시 로딩으로 설정하면 성능 튜닝이 매우 어려워 진다.
-
항상 지연 로딩을 기본으로 하고, 성능 최적화가 필요한 경우에는 페치 조인(fetch join)을 사용해라!
정말 간단한 애플리케이션이 아니면 엔티티를 API 응답으로 외부로 노출하는 것은 좋지 않다.
따라서 Hibernate5Module 를 사용하기 보다는 DTO로 변환해서 반환하는 것이 더 좋은 방법이다.
간단한 주문 조회 V2: 엔티티를 DTO로 변환
/**
* V2. 엔티티를 조회해서 DTO로 변환(fetch join 사용X)
* 단점: 지연로딩으로 쿼리 N번 호출
*/
@GetMapping("/api/v2/simple-orders")
public List<SimpleOrderDto> ordersV2() {
// ORDER 2개
// N + 1 문제 -> 1 + N(2 member, delivery)
List<Order> orders = orderRepository.findAllByString(new OrderSearch());
List<SimpleOrderDto> list = new ArrayList<>();
for (Order order : orders) {
SimpleOrderDto simpleOrderDto = new SimpleOrderDto();
simpleOrderDto.setOrderId(order.getId());
simpleOrderDto.setName(order.getMember().getName()); // Lazy 초기화
simpleOrderDto.setOrderStatus(order.getStatus());
simpleOrderDto.setOrderDate(order.getOrderDate());
simpleOrderDto.setAddress(order.getDelivery().getAddress()); // Lazy 초기화
list.add(simpleOrderDto);
}
return list;
}
@Data
static class SimpleOrderDto {
private Long orderId;
private String name;
private LocalDateTime orderDate;
private OrderStatus orderStatus;
private Address address;
}
- 엔티티를 DTO로 변환하는 일반적인 방법이다.
- 쿼리가 총 1 + N + N번 실행된다. (v1과 쿼리수 결과는 같다.)
- order 조회 1번(order 조회 결과 수가 N이 된다.)
- order -> member 지연 로딩 조회 N 번
- order -> delivery 지연 로딩 조회 N 번
- 예) order의 결과가 4개면 최악의 경우 1 + 4 + 4번 실행된다.(최악의 경우)
- 지연로딩은 영속성 컨텍스트에서 조회하므로, 이미 조회된 경우 쿼리를 생략한다.
간단한 주문 조회 V3: 엔티티를 DTO로 변환 - 페치 조인 최적화
/**
* V2. 엔티티를 조회해서 DTO로 변환(fetch join 사용X)
* 단점: 지연로딩으로 쿼리 N번 호출
*/
@GetMapping("/api/v2/simple-orders")
public List<SimpleOrderDto> ordersV2() {
// ORDER 2개
// N + 1 문제 -> 1 + N(2 member, delivery)
List<Order> orders = orderRepository.findAllByString(new OrderSearch());
List<SimpleOrderDto> list = new ArrayList<>();
for (Order order : orders) {
SimpleOrderDto simpleOrderDto = new SimpleOrderDto();
simpleOrderDto.setOrderId(order.getId());
simpleOrderDto.setName(order.getMember().getName()); // Lazy 초기화
simpleOrderDto.setOrderStatus(order.getStatus());
simpleOrderDto.setOrderDate(order.getOrderDate());
simpleOrderDto.setAddress(order.getDelivery().getAddress()); // Lazy 초기화
list.add(simpleOrderDto);
}
return list;
}
// **OrderRepository - 추가 코드**
public List<Order> findAllWithMemberDelivery() {
return em.createQuery(
"select o from Order o " +
" join fetch o.member m" +
" join fetch o.delivery d", Order.class
). getResultList();
}
- 엔티티를 페치 조인(fetch join)을 사용해서 쿼리 1번에 조회
- 페치 조인으로 `order -> member` , `order -> delivery` 는 이미 조회된 상태이므로 지연로딩X
- 하지만 필요없는 정보까지 끌고온다는 단점이 있음 (예시: DTO에 필요없는 회원의 번호, 주소)
간단한 주문 조회 V4: JPA에서 DTO로 바로 조회
/**
* V4. JPA에서 DTO로 바로 조회
* - 쿼리 1번 호출
* - select 절에서 원하는 데이터만 선택해서 조회 */
@GetMapping("/api/v4/simple-orders")
public List<OrderSimpleQueryDto> ordersV4() {
return orderSimpleQueryRepository.findOrderDtos();
}
@Repository
@RequiredArgsConstructor
public class OrderSimpleQueryRepository {
private final EntityManager em;
public List<OrderSimpleQueryDto> findOrderDtos() {
return em.createQuery(
"select new jpabook.jpashop.repository.OrderSimpleQueryDto(o.id, m.name, o.orderDate, o.status, d.address)" +
" from Order o" +
" join o.member m" +
" join o.delivery d", OrderSimpleQueryDto.class
).getResultList();
}
}
@Data
public class OrderSimpleQueryDto {
private Long orderId;
private String name;
private LocalDateTime orderDate;
private OrderStatus orderStatus;
private Address address;
public OrderSimpleQueryDto(Long orderId, String name, LocalDateTime orderDate, OrderStatus orderStatus, Address address) {
this.orderId = orderId;
this.name = name;
this.orderDate = orderDate;
this.orderStatus = orderStatus;
this.address = address;
}
}
- 일반적인 SQL을 사용할 때 처럼 원하는 값을 선택해서 조회
- new 명령어를 사용해서 JPQL의 결과를 DTO로 즉시 변환
- SELECT 절에서 원하는 데이터를 직접 선택하므로 DB -> 애플리케이션 네트웍 용량 최적화(생각보다 미비)
- 리포지토리 재사용성 떨어짐, API 스펙에 맞춘 코드가 리포지토리에 들어가는 단점
정리
엔티티를 DTO로 변환하거나, DTO로 바로 조회하는 두가지 방법은 각각 장단점이 있다.
둘중 상황에 따라서 더 나은 방법을 선택하면 된다. 엔티티로 조회하면 리포지토리 재사용성도 좋고, 개발도 단순해진다.
쿼리 방식 선택 권장 순서
- 우선 엔티티를 DTO로 변환하는 방법을 선택한다.
- 필요하면 페치 조인으로 성능을 최적화 한다. (대부분의 성능 이슈가 해결된다.)
- 그래도 안되면 DTO로 직접 조회하는 방법을 사용한다.
- 최후의 방법은 JPA가 제공하는 네이티브 SQL이나 스프링 JDBC Template을 사용해서 SQL을 직접 사용한다.
'JPA' 카테고리의 다른 글
[JPA] OSIV와 성능 최적화 (0) | 2025.01.10 |
---|---|
[JPA] 컬렉션 조회 최적화 (0) | 2025.01.10 |
[Spring Data JPA] 쿼리 메서드 기능 (0) | 2024.11.11 |
[Spring Data JPA] 공통 인터페이스 기능 (0) | 2024.11.11 |
[JPA 사용법] JPQL (0) | 2024.10.30 |