[7/27 TIL] JPA(SpringDataJPA)

🍃프로그래머스 백엔드 데브코스 4기 교육과정을 듣고 정리한 글입니다.🍃

SpringDataJPA

spring:
  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:~/order;DB_CLOSE_ON_EXIT=FALSE
    username: sa
    password:

  jpa:
    open-in-view: false
    hibernate:
      ddl-auto: create-drop
    show-sql: true
    properties:
      hibernate.format_sql: true

• 스프링에서 JPA를 편리하게 사용할 수 있도록 지원
• 직접 등록해야 했던, JPA 관련 설정(빈)을 yml 파일을 통해 자동으로 등록
  • 데이터 소스, 엔티티 매니저, 트랜잭션 매니저 설정

public interface OrderRepository extends JpaRepository<Order, String> {
}

• 데이터 저장 계층에 대한 인터페이스를 지원해줘서 CRUD 작업을 편리하게 사용

메소드 쿼리

public interface OrderRepository extends JpaRepository<Order, String> {
    // 주문 상태(OrderStatus)가 'OPEND'인 모든 주문 조회
    List<Order> findAllByOrderStatus(OrderStatus orderStatus);
    // SELECT * FROM orders WHERE order_status = 'OPEND'

    // 주문 상태(OrderStatus)가 'OPEND'인 모든 주문을 주문 일시(orderDatetime)를 기준으로 오름차순 정렬하여 조회
    List<Order> findAllByOrderStatusOrderByOrderDatetimeAsc(OrderStatus orderStatus);
    // SELECT * FROM orders WHERE order_status = 'OPEND' ORDER BY order_datetime ASC

    // 주문 상태(OrderStatus)가 'DELIVERED'인 모든 주문을 주문 금액(totalAmount)을 기준으로 내림차순 정렬하여 조회
    List<Order> findAllByOrderStatusOrderByTotalAmountDesc(OrderStatus orderStatus);
    // SELECT * FROM orders WHERE order_status = 'DELIVERED' ORDER BY total_amount DESC

    // 주문 상태(OrderStatus)가 'CANCELED'이고, 주문 금액(totalAmount)이 100,000원 이상인 모든 주문 조회
    List<Order> findAllByOrderStatusAndTotalAmountGreaterThanEqual(OrderStatus orderStatus, BigDecimal totalAmount);
    // SELECT * FROM orders WHERE order_status = 'CANCELED' AND total_amount >= 100000

    // 주문 상태(OrderStatus)가 'SHIPPED'이거나 'DELIVERED'인 모든 주문 조회
    List<Order> findAllByOrderStatusOrOrderStatus(OrderStatus orderStatus1, OrderStatus orderStatus2);
    // SELECT * FROM orders WHERE order_status = 'SHIPPED' OR order_status = 'DELIVERED'

    // 주문 상태(OrderStatus)가 'PENDING'이 아닌 모든 주문 조회
    List<Order> findAllByOrderStatusNot(OrderStatus orderStatus);
    // SELECT * FROM orders WHERE NOT order_status = 'PENDING'

    // 주문 상태(OrderStatus)가 'OPEND'이고, 주문 금액(totalAmount)이 50,000원 미만인 모든 주문 조회
    List<Order> findAllByOrderStatusAndTotalAmountLessThan(OrderStatus orderStatus, BigDecimal totalAmount);
    // SELECT * FROM orders WHERE order_status = 'OPEND' AND total_amount < 50000

    // 주문 상태(OrderStatus)가 'COMPLETED'인 주문 중 주문 일시(orderDatetime)가 오늘 날짜보다 이전인 모든 주문 조회
    List<Order> findAllByOrderStatusAndOrderDatetimeBefore(OrderStatus orderStatus, LocalDateTime dateTime);
    // SELECT * FROM orders WHERE order_status = 'COMPLETED' AND order_datetime < '2023-07-28 12:00:00'
}

• 메서드 이름 자체로 쿼리로 사용하여 데이터르 조회하는 방법
• 별도의 JPQL 또는 네이티브 SQL 쿼리를 작성하지 않고도 간단하게 데이터를 조회
• 메서드 이름은 find, read, get, query, stream, count, exists 등으로 시작한다.
• By 키워드를 사용하여 검색 조건을 지정
• 검색 조건에는 엔티티의 필드 이름 사용
• 검색 조건이 여러 개인 경우 And 또는 Or 키워드를 사용하여 조합
• 정렬 조건을 추가할 수 있으며, OrderBy 키워드 사용

커스텀 쿼리

public interface OrderRepository extends JpaRepository<Order, String> {
    // 주문 상태(OrderStatus)가 'COMPLETED'이고, 주문 금액(totalAmount)이 특정 금액 이상이면서 주문 메모(memo)에 특정 단어가 포함된 주문 조회
    @Query("SELECT o FROM Order o WHERE o.orderStatus = 'COMPLETED' AND o.totalAmount >= :amount AND o.memo LIKE %:keyword%")
    List<Order> findCompletedOrdersByAmountAndMemoContaining(@Param("amount") BigDecimal amount, @Param("keyword") String keyword);

    // 특정 사용자의 주문 중 주문 상태(OrderStatus)가 'PENDING'이고, 주문 금액(totalAmount)이 가장 높은 주문 조회
    @Query("SELECT o FROM Order o WHERE o.user = :user AND o.orderStatus = 'PENDING' ORDER BY o.totalAmount DESC")
    Order findHighestAmountPendingOrderByUser(@Param("user") User user);

    // 특정 사용자의 주문 중 주문 일시(orderDatetime)가 특정 날짜 이후인 주문 조회
    @Query("SELECT o FROM Order o WHERE o.user = :user AND o.orderDatetime >= :date")
    List<Order> findOrdersByUserAndOrderDatetimeAfter(@Param("user") User user, @Param("date") LocalDateTime date);

    // 특정 상품(product)과 관련된 모든 주문 조회
    @Query("SELECT o FROM Order o JOIN o.orderItems oi WHERE oi.product = :product")
    List<Order> findOrdersByProduct(@Param("product") Product product);

    // 특정 사용자의 주문 중 주문 상태(OrderStatus)가 'CANCELED'이고, 주문 금액(totalAmount)이 특정 금액 이하인 주문 조회
    @Query("SELECT o FROM Order o WHERE o.user = :user AND o.orderStatus = 'CANCELED' AND o.totalAmount <= :amount")
    List<Order> findCanceledOrdersByUserAndAmountLessThanOrEqual(@Param("user") User user, @Param("amount") BigDecimal amount);

    // 특정 사용자의 주문 중 주문 상태(OrderStatus)가 'DELIVERED'이고, 주문 일시(orderDatetime)가 특정 기간 내에 있는 주문 조회
    @Query("SELECT o FROM Order o WHERE o.user = :user AND o.orderStatus = 'DELIVERED' AND o.orderDatetime BETWEEN :startDate AND :endDate")
    List<Order> findDeliveredOrdersByUserAndOrderDatetimeBetween(@Param("user") User user, @Param("startDate") LocalDateTime startDate, @Param("endDate") LocalDateTime endDate);
}

• 위에 메서드 쿼리 방법으로 할 수 없는 복잡한 조회나 수정 작업은 직접 @Query를 통해 JPQL 또는 네이티브 SQL 쿼리를 작성해서 실행
  • 조인을 사용하는 복잡한 조회
  • 집계 함수를 사용하는 조회
  • 동적 쿼리
  • 여러 테이블을 한번에 수정해야 하는 복잡한 수정 작업

QueryDSL

// QUser 클래스는 QueryDSL에서 사용할 사용자 엔티티의 별칭
QUser qUser = QUser.user;

// 사용자 이름이 'John'인 사용자 조회
User user = new JPAQueryFactory(entityManager)
            .selectFrom(qUser)
            .where(qUser.name.eq("John"))
            .fetchOne();

// 나이가 20 이상인 사용자들 조회
List<User> users = new JPAQueryFactory(entityManager)
            .selectFrom(qUser)
            .where(qUser.age.goe(20))
            .fetch();

// 사용자의 이름과 이메일 주소만 조회하여 튜플 리스트로 반환
List<Tuple> userTupleList = new JPAQueryFactory(entityManager)
            .select(qUser.name, qUser.email)
            .from(qUser)
            .fetch();

// 특정 컬럼의 값을 그룹화하여 집계 함수 적용
List<Tuple> aggregatedData = new JPAQueryFactory(entityManager)
            .select(qUser.age.avg(), qUser.age.max(), qUser.age.min())
            .from(qUser)
            .groupBy(qUser.gender)
            .fetch();

• 공식 문서
• 빌더 패턴 방식으로 쿼리를 생성하여 SQL과 JPQL을 쉽게 작성할 수 있도록 지원하는 라이브러리
• JPA와 함께 사용되며, 복잡한 쿼리를 자바 코드로 간편하게 작성 가능
• 동적 쿼리를 쉽게 처리할 수 있음