22.06.26
API 개발 고급 정리
엔티티 조회
엔티티를 조회해서 그대로 반환: V1
엔티티 조회 후 DTO로 변환: V2
페치 조인으로 쿼리 수 최적화: V3
컬렉션 페이징과 한계 돌파: V3.1
-컬렉션은 페치 조인시 페이징이 불가능
-ToOne 관계는 페치 조인으로 쿼리 수 최적화
-컬렉션은 페치 조인 대신에 지연 로딩을 유지하고, hibernate.default_batch_fetch_size , @BatchSize 로 최적화
DTO 직접 조회
JPA에서 DTO를 직접 조회: V4
컬렉션 조회 최적화 - 일대다 관계인 컬렉션은 IN 절을 활용해서 메모리에 미리 조회해서 최적화: V5
플랫 데이터 최적화 - JOIN 결과를 그대로 조회 후 애플리케이션에서 원하는 모양으로 직접 변환: V6
* 권장 순서 *
1. 엔티티 조회 방식으로 우선 접근
1. 페치조인으로 쿼리 수를 최적화
2. 컬렉션 최적화
1. 페이징 필요 hibernate.default_batch_fetch_size , @BatchSize 로 최적화
2. 페이징 필요X 페치 조인 사용
2. 엔티티 조회 방식으로 해결이 안되면 DTO 조회 방식 사용
3. DTO 조회 방식으로 해결이 안되면 NativeSQL or 스프링 JdbcTemplate
참고: 엔티티 조회 방식은 페치 조인이나, hibernate.default_batch_fetch_size , @BatchSize 같이 코드를 거의 수정하지 않고, 옵션만 약간 변경해서, 다양한 성능 최적화를 시도할 수 있다. 반면에 DTO를 직접 조회하는 방식은 성능을 최적화 하거나 성능 최적화 방식을 변경할 때 많은 코드를 변경해야 한다.
> 엔티티 조회 방식만으로 해결이 안되는 상황 -> 트래픽이 매우 많음 -> 캐시를 사용하는 등 다른 방식으로 해결해야. DTO로 조회한다고 큰 성능상 이점을 못 얻을 가능성
> 엔티티는 직접 캐싱하면 안된다. 영속성 컨텍스트가 관리하는 것 자체가 일종의 캐싱인데 관리 체계가 복잡해질 수 있다. DTO로 변환한 후 캐싱할 것!
참고: 개발자는 성능 최적화와 코드 복잡도 사이에서 줄타기를 해야 한다. 항상 그런 것은 아니지만, 보통 성능 최적화는 단순한 코드를 복잡한 코드로 몰고간다.
엔티티 조회 방식은 JPA가 많은 부분을 최적화 해주기 때문에, 단순한 코드를 유지하면서, 성능을 최적화 할 수 있다. 반면에 DTO 조회 방식은 SQL을 직접 다루는 것과 유사하기 때문에, 둘 사이에 줄타기를 해야 한다.
DTO 조회 방식의 선택지
DTO로 조회하는 방법도 각각 장단이 있다.
V4, V5, V6에서 단순하게 쿼리가 1번 실행된다고 V6이 항상 좋은 방법인 것은 아니다.
우선 기본적인 코드 추가가 많고, 서로 간의 변경에도 많은 코드 변경이 필요하다.
V4는 코드가 단순하다. 특정 주문 한건만 조회하면 이 방식을 사용해도 성능이 잘 나온다. 예를 들어서 조회한 Order 데이터가 1건이면 OrderItem을 찾기 위한 쿼리도 1번만 실행하면 된다. (적은 데이터에 최적화)
V5는 코드가 복잡하다. 여러 주문을 한꺼번에 조회하는 경우에는 V4 대신에 이것을 최적화한 V5 방식을 사용해야 한다. 예를 들어서 조회한 Order 데이터가 1000건인데, V4 방식을 그대로 사용하면, 쿼리가 총 1 + 1000번 실행된다. 여기서 1은 Order 를 조회한 쿼리고, 1000은 조회된 Order의 row 수다. V5 방식으로 최적화 하면 쿼리가 총 1 + 1번만 실행된다. 상황에 따라 다르겠지만 운영 환경에서 100배 이상의 성능 차이가 날 수 있다. (많은 데이터에 최적화 + 페이징)
-> 엔티티 페치 조인 + hibernate.default_batch_fetch_size , @BatchSize 로 대체 가능
V6는 완전히 다른 접근방식이다. 쿼리 한번으로 최적화 되어서 상당히 좋아보이지만, Order를 기준으로 페이징이 불가능하다. 실무에서는 이정도 데이터면 수백이나, 수천건 단위로 페이징 처리가 꼭 필요하므로, 이 경우 선택하기 어려운 방법이다. 그리고 데이터가 많으면 중복 전송이 증가해서 V5와 비교해서 성능 차이도 미비하다.
OSIV와 성능 최적화
Open Session in View: 하이버네이트
Open EntityManager in View: JPA
spring.jpa.open-in-view: true 기본값
영속성 컨텍스트(JPA)가 데이터베이스 커넥션을 획득하고 반환하는 시기
획득: 트랜젝션을 시작하는 시점 (보통 서비스의 @transaction)
반환: open-in-view가 켜져있으면 트랜젝션이 끝나도 반환X. API 응답이 끝날 때 반환
그래서 지금까지 View Template이나 API 컨트롤러에서 지연 로딩이 가능했던 것
장점 지연 로딩은 영속성 컨텍스트가 살아있어야 가능하고, 영속성 컨텍스트는 기본적으로 데이터베이스 커넥션을 유지한다. 이것 자체가 큰 장점이다.
단점 너무 오랜시간동안 데이터베이스 커넥션 리소스를 사용하기 때문에, 실시간 트래픽이 중요한 애플리케이션에서는 커넥션이 모자랄 수 있다. 이것은 결국 장애로 이어진다. 예를 들어서 컨트롤러에서 외부 API를 호출하면 외부 API 대기 시간 만큼 커넥션 리소스를 반환하지 못하고, 유지해야 한다.
spring.jpa.open-in-view: false OSIV 종료
OSIV를 끄면 트랜잭션을 종료할 때 영속성 컨텍스트를 닫고, 데이터베이스 커넥션도 반환한다.
장점 커넥션 리소스를 낭비하지 않는다.
단점 OSIV를 끄면 모든 지연로딩을 트랜잭션 안에서 처리해야 한다.(나중에 프록시 초기화하려고 하면 exception) 따라서 지금까지 작성한 많은 지연 로딩 코드를 트랜잭션 안으로 넣어야 하는 단점이 있다. 그리고 컨트롤러, view template에서 지연로딩이 동작하지 않는다. 결론적으로 트랜잭션이 끝나기 전에 지연 로딩을 강제로 호출해 두어야 한다. 또는 페치 조인 사용
ex. API 용 쿼리 리포지토리를 생성한 것 처럼 쿼리 서비스(트랜잭션) 만들기
커멘드와 쿼리 분리
실무에서 OSIV를 끈 상태로 복잡성을 관리하는 좋은 방법이 있다. 바로 Command와 Query를 분리하는 것이다.
참고: https://en.wikipedia.org/wiki/Command–query_separation
보통 비즈니스 로직은 특정 엔티티 몇 개를 등록하거나 수정하는 것이므로 성능이 크게 문제가 되지 않는다. 그런데 복잡한 화면을 출력(조회)하기 위한 쿼리는 화면에 맞추어 성능을 최적화 하는 것이 중요하다. 하지만 그 복잡성에 비해 핵심 비즈니스에 큰 영향을 주는 것은 아니다. (핵심 비지니스 로직: 잘 변경되지 않음 / 화면: 변경 잦음)
그래서 크고 복잡한 애플리케이션을 개발한다면, 이 둘의 관심사를 명확하게 분리하는 선택은 유지보수 관점에서 충분히 의미 있다.
단순하게 설명해서 다음처럼 분리하는 것이다.
OrderService
- OrderService: 핵심 비즈니스 로직
- OrderQueryService: 화면이나 API에 맞춘 서비스 (주로 읽기 전용 트랜잭션 사용)
보통 서비스 계층에서 트랜잭션을 유지한다. 따라서 두 서비스 모두 지연 로딩을 사용할 수 있다.
참고: 필자는 고객 서비스의 실시간 API는 OSIV를 끄고, ADMIN 처럼 커넥션을 많이 사용하지 않는 곳에서는 OSIV를 켠다.
참고: OSIV에 관해 더 깊이 알고 싶으면 자바 ORM 표준 JPA 프로그래밍 13장 웹 애플리케이션과 영속성 관리를 참고하자.
스프링 데이터 JPA 소개
https://spring.io/projects/spring-data-jpa
스프링 데이터 JPA는 JPA를 사용할 때 지루하게 반복하는 코드를 자동화 해준다.
이미 라이브러리는 포함되어 있다.
스프링 데이터 JPA는 JpaRepository 라는 인터페이스를 제공하는데, 기본적인 CRUD 메서드가 포함된 구현체를 애플리케이션 실행시점에 주입해준다. 개발자는 인터페이스만 만들면 된다.
findByName 처럼 일반화 하기 어려운 기능도 메서드 이름으로 정확한 JPQL 쿼리를 실행한다.
-> select m from Member m where m.name = :name
하지만 스프링 데이터 JPA는 JPA를 사용해서 이런 기능을 제공할 뿐이다.
결국 JPA 자체를 잘 이해하는 것이 가장 중요하다
QueryDSL 소개
실무에서는 조건에 따라서 실행되는 쿼리가 달라지는 동적 쿼리를 많이 사용한다.
String, Criteria -> 너무 복잡. 버그 발생 가능성
QueryDSL 사전 준비: Q파일을 생성을 위한 세팅(플러그인, 생성 위치 지정...)
Querydsl은 SQL(JPQL)과 모양이 유사하면서 자바 코드로 동적 쿼리를 편리하게 생성할 수 있다. 실무에서는 복잡한 동적 쿼리를 많이 사용하게 되는데, 이때 Querydsl을 사용하면 높은 개발 생산성을 얻으면서 동시에 쿼리 오류를 컴파일 시점에 빠르게 잡을 수 있다.
꼭 동적 쿼리가 아니라 정적 쿼리인 경우에도 다음과 같은 이유로 Querydsl을 사용하는 것이 좋다.
-직관적인 문법
-컴파일 시점에 빠른 문법 오류 발견
-코드 자동완성
-코드 재사용 (자바 특성)
-JPQL new 명령어와는 비교가 안될 정도로 깔끔한 DTO 조회를 지원
Querydsl은 JPQL을 코드로 만드는 빌더 역할을 할 뿐이다. 따라서 JPQL을 잘 이해하면 금방 배울 수 있다.
Querydsl은 JPA로 애플리케이션을 개발 할 때 선택이 아닌 필수라 생각한다.