BackEnd/JPA

[JPA] Open Session In View (OSIV)

샤아이인 2022. 4. 24.

내가 공부한 것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼 겸 상세히 기록하고 얕은 부분들은 가볍게 포스팅하겠습니다.

 

1. OSIV와 성능 최적화

JPA의 Entity Manager를 Hibernate에서는 Session이라 부른다.

Spring Boot의 프로젝트를 실행해보면 WARN이 기본적으로 하나 뜬다.

spring.jpa.open-in-view is enabled by default.
Therefore, database queries may be performed during view rendering.
Explicitly configure spring.jpa.open-in-view to disable this warning

기본적으로 JPA가 언제 database connection을 가져오고, 반환하는지가 문제의 핵심이다.

 

기본적으로는 Database Transactoin을 시작할때 JPA가 영속성 컨텍스트를 가져온다.

그럼 언제 connection을 반환할까?

 

1) spring.jpa.open-in-view: true (기본값) 인 경우

@Transactional 이 걸려있는 함수가 끝나고, 호출한 쪽으로 돌아가도 connection을 반환하지 않는다.

API인 경우 API 데이터를 user에게 반환할 때까지, 화면인 경우 viewTemplate로 렌더링 할때까지 반환하지 않는다.

즉, user한태 완전히 response가 나가기 전까지 database connection을 반환하지 않고 있는다.

출처 - 인프런 김영한 JPA 활용 2편

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

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

 

하지만, 아주 큰 단점이 있다!

 

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

 

극적인 예로 Controller에서 외부 API를 호출한다고 생각해보자.

해당 외부 API를 호출하고 응답받기까지 3초가 걸린다면 connection 또한 3초 이상 반환되지 못하고 대기중이다.

 

2) spring.jpa.open-in-view: false 인 경우

OSIV를 끄면 트랜잭션을 종료할 때 영속성 컨텍스트를 닫고, 데이터베이스 커넥션도 반환한다.

따라서 커넥션 리소스를 낭비하지 않는다.

출처 - 인프런 김영한 JPA 활용 2편

예를 들어 다음 코드를 살펴보자.

@PostMapping("/api/v1/members")
public CreateMemberResponse saveMemberV1(@RequestBody @Validated Member member) {
    Long id = memberService.join(member);
    return new CreateMemberResponse(id);
}

회원 가입 정보를 받아 memberService.join(member)를 호출한다.

 

해당 메서드는 다음과 같다.

@Service
@Transactional(readOnly = true)
@RequiredArgsConstructor
public class MemberService {

    private final MemberRepository memberRepository;

    // 회원 가입
    @Transactional
    public Long join(Member member){
        validateDuplicateMember(member);
        memberRepository.save(member);
        return member.getId();
    }
    // 생략...
}

join 메서드 위에는 @Transactional 이 붙어있다.

따라서 해당 메서드를 시작할때 Database connection을 얻어오게 된다.

이후 member를 save한 후, return 하는 순간 @Transactional의 범위가 끈나기 때문에 connection을 반환하게 된다.

 

하지만 이것 또한 문제점이 있다.

 

OSIV를 끄면 모든 지연로딩을 트랜잭션 안에서 처리해야 한다.

따라서 지금까지 작성한 많은 지연 로딩 코드를 트랜잭션 안으로 넣어야 하는 단점이 있다.

그리고 view template에서 지연로딩이 동작하지 않는다. 결론적으로 트랜잭션이 끝나기 전에 지연 로딩을 강제로 초기화 해야한다.

 

예를 들어 컨트롤러는 다음과 같다고 해보자. (지난 글에서 만든 V1버전)

@GetMapping("/api/v1/orders")
public List<Order> ordersV1() {
    List<Order> all = orderRepository.findAllByString(new OrderSearch());
    for (Order order : all) {
        order.getMember().getName(); // 지연 로딩 초기화
        order.getDelivery().getAddress(); // 지연 로딩 초기화

        List<OrderItem> orderItems = order.getOrderItems();
        orderItems.stream().forEach(o -> o.getItem().getName());
    }
    return all;
}

Controller에서 지연 로딩을 초기화 하고 있다.  이는 OSIV 덕분에 Controller까지 영속성 컨텍스트를 사용할 수 있기 때문이다.

 

postMan 을 통하여 조회시 정상적으로 결과가 출력된다.

[
    {
        "id": 4,
        "member": {
            "id": 1,
            "name": "userA",
            "address": {
                "city": "서울",
                "street": "1",
                "zipcode": "1111"
            }
        },
        "orderItems": [
            {
                "id": 6,
                "item": {
                    "id": 2,
                    "name": "JPA1 BOOK",
                    "price": 10000,
                    "stockQuantity": 99,
                    "categories": null,
                    "author": null,
                    "isbn": null
                },
                "orderPrice": 10000,
                "count": 1,
                "totalPrice": 10000
            },
            {
                "id": 7,
                "item": {
                    "id": 3,
                    "name": "JPA2 BOOK",
                    "price": 20000,
                    "stockQuantity": 98,
                    "categories": null,
                    "author": null,
                    "isbn": null
                },
                "orderPrice": 20000,
                "count": 2,
                "totalPrice": 40000
            }
        ],
        "delivery": {
            "id": 5,
            "address": {
                "city": "서울",
                "street": "1",
                "zipcode": "1111"
            },
            "status": null
        },
        "orderDate": "2022-04-24T19:00:34.20792",
        "status": "ORDER",
        "totalPrice": 50000
    },
    {
        "id": 11,
        "member": {
            "id": 8,
            "name": "userB",
            "address": {
                "city": "진주",
                "street": "2",
                "zipcode": "2222"
            }
        },
        "orderItems": [
            {
                "id": 13,
                "item": {
                    "id": 9,
                    "name": "SPRING1 BOOK",
                    "price": 20000,
                    "stockQuantity": 197,
                    "categories": null,
                    "author": null,
                    "isbn": null
                },
                "orderPrice": 20000,
                "count": 3,
                "totalPrice": 60000
            },
            {
                "id": 14,
                "item": {
                    "id": 10,
                    "name": "SPRING2 BOOK",
                    "price": 40000,
                    "stockQuantity": 296,
                    "categories": null,
                    "author": null,
                    "isbn": null
                },
                "orderPrice": 40000,
                "count": 4,
                "totalPrice": 160000
            }
        ],
        "delivery": {
            "id": 12,
            "address": {
                "city": "진주",
                "street": "2",
                "zipcode": "2222"
            },
            "status": null
        },
        "orderDate": "2022-04-24T19:00:34.235877",
        "status": "ORDER",
        "totalPrice": 220000
    }
]

여기서 만약 OSIV 설정을 false 로 주면 어떻게 될까?

false로 설정을 주고 실행하면 다음과 같은 결과가 나온다.

에러를 읽어보면 proxy를 초기화 할 수 없다는 오류가 나온다. 

서버측에서도 no Session 즉, Entity Manager가 존제하지 않는다고 나온다.

 

이러한 문제를 어떻게 해결해야 할까? 크게 2가지 방법이 있다.

1) Transaction 안에서 전부 초기화 해두기

2) Fetch Join 사용하여 데이터 한번에 들고오기

 

간단하게 Transaction안에서 전부 초기화 하는 방법으로 OrderQueryService를 따로 만드는 것 이다.

여기 안으로 기존 Controller의 초기화 로직을 이동시키는 것 이다.

 

예를 들어 다음과 같은 컨트롤러가 있다고 해보자.

@GetMapping("/api/v3/orders")
public List<OrderDto> ordersV3() {
    List<Order> orders = orderRepository.findAllWithItem();

    return orders.stream()
            .map(o -> new OrderDto(o))
            .collect(toList());
}

기존에는 Dto로 변환하면서 Lazy 로딩을 초기화 하게 된다. Controller 안에서 말이다!

 

OSIV문제를 해결하기 위해 다음과 같이 Query용 서비스를 따로 만들자.

@Transactional(readOnly = true)
@Service
@RequiredArgsConstructor
public class OrderQueryService {

    private final OrderRepository orderRepository;

    public List<OrderDto> ordersV3() {
        List<Order> orders = orderRepository.findAllWithItem();

        return orders.stream()
                .map(o -> new OrderDto(o))
                .collect(toList());
    }

    @Getter
    static class OrderDto {

        private Long orderId;
        private String name;
        private LocalDateTime orderDate;
        private OrderStatus orderStatus;
        private Address address;
        private List<OrderItemDto> orderItems;

        public OrderDto(Order order) {
            orderId = order.getId();
            name = order.getMember().getName(); // LAZY 로딩 초기화
            orderDate = order.getOrderDate();
            orderStatus = order.getStatus();
            address = order.getDelivery().getAddress(); // LAZY 로딩 초기화
            orderItems = order.getOrderItems()
                    .stream()
                    .map(OrderItemDto::new)
                    .collect(toList());
        }
    }

    @Getter
    static class OrderItemDto {

        private String itemName;
        private int orderPrice;
        private int count;

        public OrderItemDto(OrderItem orderItem) {
            itemName = orderItem.getItem().getName();
            orderPrice = orderItem.getOrderPrice();
            count = orderItem.getCount();
        }
    }
}

위 서비스의 메서드를 다음과 같이 호출하기만 하면 된다.

private final OrderQueryService orderQueryService

@GetMapping("/api/v3/orders")
public List<OrderDto> ordersV3() {
    return orderQueryService.ordersV3();
}

 

3) 커맨드와 쿼리를 분리

실무에서 OSIV를 끈 상태로 복잡성을 관리하는 좋은 방법이 있다. 바로 Command와 Query를 분리하는 것이다.

즉, Command Query Separation (CQS)로 DB의 데이터를 업데이트하는 명령조회하는 쿼리를 분리하는 것 이다!

대부분의 경우 조회하는 과정에서 문제가 발생한다.

 

일반적으로 비지니스 로직에서 Entity 몇개를 등록하거나 수정하는 명령은 성능이 크게 문제되지 않는다.

그런데, 복잡한 화면을 출력하기 위한 쿼리는 화면에 맞추어 성능을 최적화 하는 것이 중요하다.

하지만 그 복잡성에 비해 핵심 비즈니스에 큰 영향을 주는 것은 아니다.
그래서 크고 복잡한 애플리케이션을 개발한다면, 이 둘의 관심사를 명확하게 분리하는 선택은 유지보수 관점에서 충분히 의미 있다.

 

예를 들어 다음처럼 분리하는 것 이다.

OrderService
- OrderService: 핵심 비즈니스 로직
- OrderQueryService: 화면이나 API에 맞춘 서비스 (주로 읽기 전용 트랜잭션 사용)

 

그럼 언제 OSIV를 키고, 꺼야 할까?

고객 서비스처럼 실시간 API는 OSIV를 끄고, ADMIN 처럼 커넥션을 많이 사용하지 않는 곳에서는 OSIV를 켠다.

 

'BackEnd > JPA' 카테고리의 다른 글

[JPA] 공통 인터페이스 기능  (0) 2022.05.03
[JPA] 예제 도메인 모델  (0) 2022.05.02
[JPA] 컬렉션 조회 최적화 - 4  (0) 2022.04.24
[JPA] 컬렉션 조회 최적화 - 3  (0) 2022.04.24
[JPA] 컬렉션 조회 최적화 - 2  (0) 2022.04.23

댓글