#실전2 - 8 OSIV와 성능 최적화

API 개발 고급 - 실무 필수 최적화

 

OSIV와 성능 최적화

· Open Session In View: 하이버네이트 (JPA에서의 em이 하이버네이트에서  Session이다.)

· Open EntityManager In View: JPA (관례상 OSIV라 한다.)

 

 

OSIV ON

· spring.jpa.open-in-view : true 기본값

 

이 기본값을 뿌리면서 애플리케이션 시작 시점에 warn 로그를 남기는 것은 이유가 있다.

애플리케이션 시작 시점에 warn 로그

OSIV 전략은 트랜잭션 시작(JPA가 영속성 컨텍스트를 얻어오는 시점)처럼 최초 데이터베이스 커넥션 시작 시점부터 API 응답이 끝날 때 까지 영속성 컨텍스트와 데이터베이스 커넥션을 유지한다.

 

open-in-view는 트랜잭션이 끝나도 영속성컨텍스트를 요청이 더이상 없거나 필요없는 상태가 될때까지 끝까지 살려두다가 view Template일 경우에 html 랜더링할대까지 완전히 완성되고 data response가나가면 db connection을 돌려주고 영속성 컨텍스트도 사라지는 것이다.

API인 경우 API가 유저에게 반환될때까지 화면인 경우  View Template으로 랜더링하거나 할때까지

 

그래서 지금까지 View Template이나 API 컨트롤러에서 지연 로딩이 가능했던 것이다.

 

지연 로딩은 영속성 컨텍스트가 살아있어야 가능하고, 영속성 컨텍스트는 기본적으로 데이터베이스 커넥션을 유지한다. 이것 자체가 큰 장점이다

 

이전략의 치명적인 단점

그런데 이 전략은 너무 오랜시간동안 데이터베이스 커넥션 리소스를 사용하기 때문에, 실시간 트래픽이 중요한 애플리케이션에서는 커넥션이 모자랄 수 있다. 이것은 결국 장애로 이어진다.

예를 들어서 컨트롤러에서 외부 API를 호출하면 외부 API 대기 시간 만큼 커넥션 리소스를 반환하지 못하고, 유지해야 한다.

만약 외부 API 가 블록킹이라도 걸리면 외부 API가 다 쓰레드 풀이 다차버릴때까지 DB Connection을 다먹어버리는 것이다.

 

장점

엔티티를 적극 활용하여 LAZY loading 같은 기술을 controller, view 이런곳에서 적극 활용할수 있다.

중복도 줄이고 투명하게 LAZY loading을 끝까지 할 수 있기 떄문에 그로인해 코드를 유지보수성을 높히는 장점이있다

 

OSIV OFF

· spring.jpa.open-in-view: false OSIV 종료

 

OSIV를 끄면 트랜잭션을 종료할 때 영속성 컨텍스트를 닫고, 데이터베이스 커넥션도 반환한다. 따라서 커넥션 리소스를 낭비하지 않는다.

지연로딩을하려면 영속성컨텍스트가 살아있어야한다. 트랜잭션이 끝낫다고해서 영속성 컨텍스트를 끝내버리면

OSIV를 끄면 모든 지연로딩을 트랜잭션 안에서 처리해야 한다. 따라서 지금까지 작성한 많은 지연 로딩 코드를 트랜잭션 안으로 넣어야 하는 단점이 있다. 그리고 view template에서 지연로딩이 동작하지 않는다. 결론적으로 트랜잭션이 끝나기 전에 지연 로딩을 강제로 호출해 두어야 한다.

 

 

커멘드와 쿼리 분리

실무에서 OSIV를 끈 상태로 복잡성을 관리하는 좋은 방법이 있다. 바로 Command와 Query를 분리하는 것이다. 참고: https://en.wikipedia.org/wiki/Command–query_separation

service.query.OrderQueryService

package jpabook.jpashop.service.query;

import jpabook.jpashop.api.OrderApiController;
import jpabook.jpashop.domain.Order;
import jpabook.jpashop.repository.OrderRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

import static java.util.stream.Collectors.toList;
@Service
@Transactional(readOnly = true)
@RequiredArgsConstructor
public class OrderQueryService {

    private final OrderRepository orderRepository;

    public List<OrderDto> orderV3(){
        List<Order> orders = orderRepository.findAllWithMemberDelivery(offset,limit);
        List<OrderApiController.OrderDto> result = orders.stream()
                .map(o -> new OrderApiController.OrderDto(o))
                .collect(toList());
        return result;
    }

}

 

OrderApiController

    private final OrderQueryService orderQueryService;
    
    @GetMapping("/api/v3/orders")
    public List<OrderDto> orderV3(){ //order 객체를 두개뿌린것이기때문에 중복이다.
        return orderQueryService.orderV3();

    }

보통 transational을 controller에서 안쓰고 service에서 쓰기 때문에 qeury  전용 서비스를 만들어서 해결

 

보통 비즈니스 로직은 특정 엔티티 몇게를 등록하거나 수정하는 것이므로 성능이 크게 문제가 되지 않는다. 그런데

복잡한 화면을 출력하기 위한 쿼리는 화면에 맞추어 성능을 최적화 하는 것이 중요하다. 하지만 그 복잡성에 비해 핵심 비즈니스에 큰 영향을 주는 것은 아니다.

그래서 크고 복잡한 애플리케이션을 개발한다면, 이 둘의 관심사를 명확하게 분리하는 선택은 유지보수 관점에서 충분히 의미 있다.

단순하게 설명해서 다음처럼 분리하는 것이다.

 

 

· OrderService

    · OrderService: 핵심 비즈니스 로직 -어플리케이션이 작을떄

    · OrderQueryService: 화면이나 API에 맞춘 서비스 (주로 읽기 전용 트랜잭션 사용) -어플리케이션이 점점커질떄

 

보통 서비스 계층에서 트랜잭션을 유지한다. 두 서비스 모두 트랜잭션을 유지하면서 지연 로딩을 사용할 수 있다.

 

참고: 필자는 고객 서비스의 실시간 API는 OSIV를 끄고, ADMIN 처럼 커넥션을 많이 사용하지 않는 곳에서는

       OSIV를 켠다.

참고: OSIV에 관해 더 깊이 알고 싶으면 자바 ORM 표준 JPA 프로그래밍 13장 웹 애플리케이션과 영속성 관리를 참고하자.

 

 

스프링 데이터 JPA 소개

· https://spring.io/projects/spring-data-jpa

Spring Data JPA

스프링 데이터 JPA는 JPA를 사용할 때 지루하게 반복하는 코드를 자동화 해준다. 이미 라이브러리는 포함되어 있다. 기존의 MemberRepository 를 스프링 데이터 JPA로 변경해보자.

 

 

MemberRepository

package jpabook.jpashop.repository;
import jpabook.jpashop.domain.Member;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Repository;
import javax.persistence.EntityManager;
import java.util.List;

@Repository
@RequiredArgsConstructor
public class MemberRepository {

    private final EntityManager em;
    public void save(Member member) {
        em.persist(member);
    }
    public Member findOne(Long id) {
        return em.find(Member.class, id);
    }
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
    public List<Member> findByName(String name) {
        return em.createQuery("select m from Member m where m.name = :name",
                Member.class)
                .setParameter("name", name)
                .getResultList();
    }
}

스프링 데이터 JPA 적용

package jpabook.jpashop.repository;

import jpabook.jpashop.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;

public interface MemberRepository extends JpaRepository<Member, Long> {
    List<Member> findByName(String name);
}

findOne() → findById()로 변경해야 한다

· 스프링 데이터 JPA는 JpaRepository 라는 인터페이스를 제공하는데, 여기에 기본적인 CRUD 기능이 모두 제공된다.

  (일반적으로 상상할 수 있는 모든 기능이 다 포함되어 있다.)

·  findByName 처럼 일반화 하기 어려운 기능도 메서드 이름으로 정확한 JPQL 쿼리를 실행한다.

    ·  select m from member m where m.name = :name

 

· 개발자는 인터페이스만 만들면 된다. 구현체는 스프링 데이터 JPA가 애플리케이션 실행시점에 주입해준다.

 

스프링 데이터 JPA는 스프링과 JPA를 활용해서 애플리케이션을 만들때 정말 편리한 기능을 많이 제공한다. 단순히 편리함을 넘어서 때로는 마법을 부리는 것 같을 정도로 놀라운 개발 생산성의 세계로 우리를 이끌어 준다.

 

하지만 스프링 데이터 JPA는 JPA를 사용해서 이런 기능을 제공할 뿐이다. 결국 JPA 자체를 잘 이해하는 것이 가장 중요하다.

 

 

QueryDSL 소개

http://www.querydsl.com

Querydsl - Unified Queries for Java

실무에서는 조건에 따라서 실행되는 쿼리가 달라지는 동적 쿼리를 많이 사용한다.

주문 내역 검색으로 돌아가보고, 이 예제를 Querydsl로 바꾸어 보자.

 

Querydsl로 처리

public List<Order> findAll(OrderSearch orderSearch) {
        QOrder order = QOrder.order;
        QMember member = QMember.member;
        return query
        .select(order)
        .from(order)
        .join(order.member, member)
        .where(statusEq(orderSearch.getOrderStatus()),
        nameLike(orderSearch.getMemberName()))
        .limit(1000)
        .fetch();
 }
        
private BooleanExpression statusEq(OrderStatus statusCond) {
   if (statusCond == null) {
       return null;
   }
   return order.status.eq(statusCond);
}

private BooleanExpression nameLike(String nameCond) {
   if (!StringUtils.hasText(nameCond)) {
        return null;
   }
   return member.name.like(nameCond);
}

build.gradle에 querydsl 추가

//querydsl 추가
buildscript {
dependencies {
classpath("gradle.plugin.com.ewerk.gradle.plugins:querydslplugin:1.0.10")
}
}
plugins {
id 'org.springframework.boot' version '2.1.9.RELEASE'
id 'java'
}
apply plugin: 'io.spring.dependency-management'
apply plugin: "com.ewerk.gradle.plugins.querydsl"
group = 'jpabook'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-devtools'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-hibernate5'
implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.5.6'
compileOnly 'org.projectlombok:lombok'
runtimeOnly 'com.h2database:h2'
annotationProcessor 'org.projectlombok:lombok'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
//querydsl 추가
implementation 'com.querydsl:querydsl-jpa'
//querydsl 추가
implementation 'com.querydsl:querydsl-apt'
}
//querydsl 추가
//def querydslDir = 'src/main/generated'
def querydslDir = "$buildDir/generated/querydsl"
querydsl {
library = "com.querydsl:querydsl-apt"
jpa = true
querydslSourcesDir = querydslDir
}
sourceSets {
main {
java {
srcDirs = ['src/main/java', querydslDir]
}
}
}
compileQuerydsl{
options.annotationProcessorPath = configurations.querydsl
}
configurations {
querydsl.extendsFrom compileClasspath
}

Querydsl은 SQL(JPQL)과 모양이 유사하면서 자바 코드로 동적 쿼리를 편리하게 생성할 수 있다.

 

실무에서는 복잡한 동적 쿼리를 많이 사용하게 되는데, 이때 Querydsl을 사용하면 높은 개발 생산성을 얻으면서 동시에 쿼리 오류를 컴파일 시점에 빠르게 잡을 수 있다. 꼭 동적 쿼리가 아니라 정적 쿼리인 경우에도 다음과 같은 이유로 Querydsl을 사용하는 것이 좋다.

 

· 직관적인 문법

· 컴파일 시점에 빠른 문법 오류 발견

· 코드 자동완성

· 코드 재사용(이것은 자바다)

· JPQL new 명령어와는 비교가 안될 정도로 깔끔한 DTO 조회를 지원한다.

 

Querydsl은 JPQL을 코드로 만드는 빌더 역할을 할 뿐이다. 따라서 JPQL을 잘 이해하면 금방 배울 수 있다.

Querydsl은 JPA로 애플리케이션을 개발 할 때 선택이 아닌 필수라 생각한다.

 

참고: Querydsl에 대한 내용은 분량이 상당해서, 별도의 강의를 계획중이다