Advance I/Spring DB

22.11.18

kinggora 2022. 11. 18. 16:16

8. 데이터 접근 기술 - 활용 방안

스프링 데이터 JPA 예제와 트레이드 오프

스프링 데이터 JPA 예제를 다시 한번 돌아보자.

 

클래스 의존 관계

 

런타임 객체 의존 관계

 

  • ItemService: ItemRepository 인터페이스에 의존
  • JpaItemRepositoryV2: ItemRepository 인터페이스를 구현, ItemService 에 실제로 주입되는 객체. 내부적으로SpringDataJpaItemRepository 에 기능을 대부분 위임
  • SpringDataJpaItemRepository: ItemRepository 와 관련 없음. 스프링 데이터 JPA 기능(JpaRepository) 사용

 

중간에서 JpaItemRepositoryV2 가 어댑터 역할을 해준 덕분에 ItemService 가 사용하는 ItemRepository 인터페이스를 그대로 유지할 수 있고 클라이언트인 ItemService 의 코드를 변경하지 않아도 되는 장점이 있다.

 

고민

구조를 맞추기 위해서, 중간에 어댑터가 들어가면서 전체 구조가 너무 복잡해지고 사용하는 클래스도 많아지는 단점이 생겼다. 실제 이 코드를 구현해야하는 개발자 입장에서 보면 중간에 어댑터도 만들고, 실제 코드까지 만들어야 하는 불편함이 생긴다.

유지보수 관점에서 ItemService 를 변경하지 않고, ItemRepository 의 구현체를 변경할 수 있는 장점이 있다. 그러니까 DI, OCP 원칙을 지킬 수 있다는 좋은 점이 분명히 있다. 하지만 반대로 구조가 복잡해지면서 어댑터 코드와 실제 코드까지 함께 유지보수 해야 하는 어려움도 발생한다.

다른 선택

ItemService 코드를 일부 고쳐서 직접 스프링 데이터 JPA를 사용하는 방법이다.

DI, OCP 원칙을 포기하는 대신에, 복잡한 어댑터를 제거하고, 구조를 단순하게 가져갈 수 있는 장점이 있다.

 

클래스 의존 관계

 

ItemService 에서 스프링 데이터 JPA로 만든 리포지토리를 직접 참조한다.

물론 이 경우 ItemService 코드를 변경해야 한다.

 

런타임 객체 의존 관계

트레이드 오프

  • DI, OCP를 지키기 위해 어댑터를 도입하고, 더 많은 코드를 유지한다.
  • 어댑터를 제거하고 구조를 단순하게 가져가지만, DI, OCP를 포기하고, 클라이언트 코드를 직접 변경한다.

=> 구조의 안정성 vs 단순한 구조와 개발의 편리성

 

이 둘 중에 하나의 정답만 있을까?

그렇지 않다. 어떤 상황에서는 구조의 안정성이 매우 중요하고, 어떤 상황에서는 단순한 것이 더 나은 선택일 수 있다.

 

개발을 할 때는 항상 자원이 무한한 것이 아니다. 그리고 어설픈 추상화는 오히려 독이 되는 경우도 많다.

무엇보다 추상화, 인터페이스도 비용이 든다. 여기서 말하는 비용은 유지보수 관점에서 비용을 뜻한다.

  1. 추상화 설계 ( 인터페이스 생성 )
  2. 추상화 이해 ( 코드 흐름에 있어 직관적인 이해를 방해 )

이 추상화 비용을 넘어설 만큼 효과가 있을 때 추상화를 도입하는 것이 실용적이다.

이런 선택에서 하나의 정답이 있는 것은 아니지만, 프로젝트의 현재 상황에 맞는 더 적절한 선택지가 있을 것이다.

 

만약 미래에도 구현체를 변경할 가능성이 거의 없다고 예상되면 간결한 구조로 설계해도 좋을 것이다.

실제로 구현 기술을 변경해야 할 때 애플리케이션 구조 전체를 뒤집는 게 오히려 효율적인 선택인 경우도 있다.

 

혹은, 거대한 프로젝트에서 트래픽이 느는 등의 이유로 구현 기술을 변경해야 할 때, 안정적으로 추상화된 구조에서는 비용을 많이 줄일 수 있을 것이다.

그런 상황이 아니라면 빠르고 단순하게 도입할 수 있는 형태로 개발하고, 후에 프로젝트가 커지면 리팩토링을 통해 개선하는 방법이 실용적이지 않을까.

실용적인 구조

Querydsl을 사용한 리포지토리( JpaItemRepositoryV3 )는 스프링 데이터 JPA를 사용하지 않는 아쉬움이 있었다.

물론 Querydsl을 사용하는 리포지토리가 스프링 데이터 JPA 리포지토리를 사용하도록 해도 된다.

이번에는 스프링 데이터 JPA의 기능은 최대한 살리면서, Querydsl도 편리하게 사용할 수 있는 구조를 만들어보자.

 

복잡한 쿼리 분리

 

  • ItemRepositoryV2 는 스프링 데이터 JPA의 기능을 제공하는 리포지토리이다. ( extends JpaRepository ) 
  • ItemQueryRepositoryV2 는 Querydsl을 사용해서 복잡한 쿼리 기능을 제공하는 리포지토리이다.

기본 CRUD와 단순 조회 -> 스프링 데이터 JPA

복잡한 조회, 동적 쿼리 -> Querydsl

 

ItemService 는 기존 ItemRepository 를 사용할 수 없기 때문에 코드를 변경해야 한다.

ItemRepositoryV2 클래스

import hello.itemservice.domain.Item;
import org.springframework.data.jpa.repository.JpaRepository;

public interface ItemRepositoryV2 extends JpaRepository<Item, Long> {
}

 

  • JpaRepository 를 인터페이스 상속 받아서 스프링 데이터 JPA의 기능을 제공하는 리포지토리
  • 기본 CRUD 제공 + 추가로 단순한 조회 쿼리들을 추가해도 된다.

ItemQueryRepositoryV2 클래스

@Repository
public class ItemQueryRepositoryV2 {

    private final JPAQueryFactory query;

    public ItemQueryRepositoryV2(EntityManager em) {
        this.query = new JPAQueryFactory(em);
    }

    public List<Item> findAll(ItemSearchCond cond){
        return query.select(item)
                .from(item)
                .where(
                        likeItemName(cond.getItemName()),
                        maxPrice(cond.getMaxPrice()))
                .fetch();
    }

    private BooleanExpression likeItemName(String itemName){
        if(StringUtils.hasText(itemName)){
            return item.itemName.like("%" + itemName + "%");
        }
        return null;
    }

    private BooleanExpression maxPrice(Integer maxPrice){
        if(maxPrice != null){
            return item.price.loe(maxPrice); //maxPrice 보다 작거나 같다
        }
        return null;
    }
}

 

  • Querydsl ( JPAQueryFactory ) 을 사용해서 복잡한 쿼리 문제를 해결한다. 따라서 복잡한 쿼리는 이 부분만 유지보수 하면 되는 장점이 있다.
  • JPAQueryFactory는 EntityManager 를 필요로 한다.

ItemServiceV2 클래스

@Service
@RequiredArgsConstructor
@Transactional
public class ItemServiceV2 implements ItemService {

    private final ItemRepositoryV2 itemRepositoryV2;
    private final ItemQueryRepositoryV2 itemQueryRepositoryV2;

    @Override
    public Item save(Item item) {
        return itemRepositoryV2.save(item);
    }

    @Override
    public void update(Long itemId, ItemUpdateDto updateParam) {
        Item findItem = itemRepositoryV2.findById(itemId).orElseThrow();
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
    }

    @Override
    public Optional<Item> findById(Long id) {
        return itemRepositoryV2.findById(id);
    }

    @Override
    public List<Item> findItems(ItemSearchCond cond) {
        return itemQueryRepositoryV2.findAll(cond);
    }
}

 

  • ItemServiceV2 는 ItemRepositoryV2 와 ItemQueryRepositoryV2 를 의존한다.

V2Config 설정 파일

@Configuration
@RequiredArgsConstructor
public class V2Config {

    private final EntityManager em;
    private final ItemRepositoryV2 itemRepositoryV2; //SpringDataJPA

    @Bean
    public ItemService itemService(){
        return new ItemServiceV2(itemRepositoryV2, ItemQueryRepositoryV2());
    }

    @Bean
    public ItemQueryRepositoryV2 ItemQueryRepositoryV2(){
        return new ItemQueryRepositoryV2(em);
    }

    @Bean
    public ItemRepository itemRepository(){
        return new JpaItemRepositoryV3(em);
    }
}

 

  • ItemRepositoryV2 는 스프링 데이터 JPA 가 자동으로 구현체를 생성하여 스프링 빈으로 등록하기 때문에 바로 의존 관계를 주입받아 사용했다.
  • ItemRepository 는 테스트에서 사용하므로 여전히 필요하다.

ItemServiceApplication - 변경

@Import(V2Config.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}

실행 확인

JpaRepositoryTest

class ItemRepositoryTest {

    @Autowired
    ItemRepository itemRepository;

 

현재까지 사용했던 테스트 코드는 ItemRepository 를 테스트 하는데, 현재 JpaItemRepositoryV3 가 스프링 빈으로 등록되어 있다. V2Config 에서 사용한 리포지토리를 테스트 하려면 ItemQueryRepositoryV2 , ItemRepositoryV2 용 테스트가 별도로 필요하다.

 

 

 

ItemServiceApplication

@Bean
@Profile("local")
public TestDataInit testDataInit(ItemRepository itemRepository) {
   return new TestDataInit(itemRepository);
}

 

local 프로필에서 TestDataInit() 도 JpaItemRepositoryV3 를 사용하여 데이터를 초기화한다.

그 외에 애플리케이션은 ItemServiceV2 를 사용하기 때문에 정상적으로 동작하는지 확인하자.

 

참고: 스프링 데이터 JPA가 제공하는 커스텀 리포지토리를 사용해도 비슷하게 문제를 해결할 수는 있다.

다양한 데이터 접근 기술 조합

어떤 데이터 접근 기술을 선택하는 것이 좋을까?

 

이 부분은 하나의 정답이 있다기 보다는, 비즈니스 상황과, 현재 프로젝트 구성원의 역량에 따라서 결정하는 것이 맞다.

JdbcTemplate 이나 MyBatis 같은 기술들은 SQL을 직접 작성해야 하는 단점은 있지만 기술이 단순하기 때문에 SQL에 익숙한 개발자라면 금방 적응할 수 있다.

JPA, 스프링 데이터 JPA, Querydsl 같은 기술들은 개발 생산성을 혁신할 수 있지만, 학습 곡선이 높기 때문에, 이런 부분을 감안해야 한다. 그리고 매우 복잡한 통계 쿼리를 주로 작성하는 경우에는 잘 맞지 않는다.


개인적으로 추천하는 방향은 JPA, 스프링 데이터 JPA, Querydsl을 기본으로 사용하고, 만약 복잡한 쿼리를 써야 하는데, 해결이 잘 안되면 해당 부분에는 JdbcTemplate이나 MyBatis를 함께 사용하는 것이다.

 

실무에서 95% 정도는 JPA, 스프링 데이터 JPA, Querydsl 등으로 해결하고, 나머지 5%는 SQL을 직접 사용해야 하니 JdbcTemplate이나 MyBatis로 해결한다. 물론 이 비율은 프로젝트 마다 다르다. 아주 복잡한 통계 쿼리를 자주 작성해야 하면 JdbcTemplate이나 MyBatis의 비중이 높아질 수 있다.

 

트랜잭션 매니저 선택

JPA, 스프링 데이터 JPA, Querydsl은 모두 JPA 기술을 사용하는 것이기 때문에 트랜잭션 매니저로 JpaTransactionManager 를 사용한다. 해당 기술을 사용하면 스프링 부트는 자동으로 JpaTransactionManager 를 스프링 빈에 등록한다.

그런데 JdbcTemplate , MyBatis 와 같은 기술들은 내부에서 JDBC를 직접 사용하기 때문에 DataSourceTransactionManager 를 사용한다. 따라서 JPA와 JdbcTemplate 을 함께 사용하면 트랜잭션 매니저가 달라지고, 트랜잭션을 하나로 묶을 수 없는 문제가 발생할 수 있다. 그런데 이 부분은 걱정하지 않아도 된다.

 

JpaTransactionManager의 다양한 지원

JpaTransactionManager 는 DataSourceTransactionManager 가 제공하는 기능도 대부분 제공한다. JPA라는 기술도 결국 내부에서는 DataSource와 JDBC 커넥션을 사용하기 때문이다.

결과적으로 JpaTransactionManager 하나만 스프링 빈에 등록하면, JPA, JdbcTemplate, MyBatis 여러 데이터 접근 기술을 하나의 트랜잭션으로 묶어서 사용할 수 있다. 물론 함께 롤백도 할 수 있다.

 

주의점

이렇게 JPA와 JdbcTemplate을 함께 사용할 경우 JPA의 플러시 타이밍에 주의해야 한다.

JPA는 데이터를 변경하면 변경 사항을 즉시 데이터베이스에 반영하지 않는다. 기본적으로 트랜잭션이 커밋되는 시점에 변경 사항을 데이터베이스에 반영한다. 그래서 하나의 트랜잭션 안에서 JPA를 통해 데이터를 변경한 다음에 JdbcTemplate을 호출하는 경우 JdbcTemplate에서는 JPA가 변경한 데이터를 읽기 못하는 문제가 발생한다.

이 문제를 해결하려면 JPA 호출이 끝난 시점에 JPA가 제공하는 플러시라는 기능을 사용해서 JPA의 변경 내역을 데이터베이스에 반영해주어야 한다. 그래야 그 다음에 호출되는 JdbcTemplate에서 JPA가 반영한 데이터를 사용할 수 있다.

 

정리

ItemServiceV2 는 스프링 데이터 JPA를 제공하는 ItemRepositoryV2 도 참조하고, Querydsl과 관련된 ItemQueryRepositoryV2 도 직접 참조한다.

덕분에 ItemRepositoryV2 를 통해서 스프링 데이터 JPA 기능을 적절히 활용할 수 있고, ItemQueryRepositoryV2 를 통해서 복잡한 쿼리를 Querydsl로 해결할 수 있다.

 

이렇게 하면서 구조의 복잡함 없이 단순하게 개발할 수 있다. 본인이 진행하는 프로젝트의 규모가 작고, 속도가 중요하고, 프로토타입 같은 시작 단계라면 이렇게 단순하면서 라이브러리의 지원을 최대한 편리하게 받는 구조가 더 나은 선택일 수 있다. 하지만 이 구조는 리포지토리의 구현 기술이 변경되면 수 많은 코드를 변경해야 하는 단점이 있다.

이런 선택에서 하나의 정답은 없다. 이런 트레이드 오프를 알고, 현재 상황에 더 맞는 적절한 선택을 하는 좋은 개발자가 있을 뿐이다.