[Querydsl] Expressions.dateTemplate, timeTemplate 사용기

Querydsl 의 기본 사용법은 소개하지 않습니다.
Querydsl 을 학습 중에 작성한 글이기 때문에 소개한 방법이 최고의 방법이 아닐 수 있음을 알려드립니다🙇‍♂️

개발환경
JDK 17, Querydsl 5.0.0, Spring boot 3.x

⭐서론

코드스쿼드 에어비앤비 클론 프로젝트 중, 사용자 조건에 따라 숙소가 검색되는 기능을 구현하고자 했습니다.

사용자가 6/19 ~ 6/20 를 숙소 검색 조건으로 등록하면,
서버에서는 6/19 ~ 6/20 까지 이용 가능 한 숙소 ID(예약 되어있지 않은 숙소 ID) 를 찾습니다.

 

예를 들어,

• 숙소 ID가 1인 숙소에 `6/19 PM15:00 ~ 6/20 AM11:00` 인 예약이 있다고 가정합니다.
• 만약, 사용자가 6/20 ~ 6/21 에 이용가능한 숙소를 찾는다면
  • ID가 1인 숙소의 체크인 시간은 PM 15:00, 체크아웃 시간은 AM 11:00 이기 때문에,
  • ID가 1인 숙소는 6/20 ~ 6/21 에 이용가능하도록 합니다.
• 이를 위해, 날짜는 날짜대로 시간은 시간대로 각각 비교하고자 합니다.

---

⭐구현

• 예약 엔티티의 체크인,아웃은 LocalDateTime 입니다.

* JPA 의 ddl-auto 기능을 true 로 설정하면 엔티티의 LocalDateTime 은 Mysql 에 DateTime 으로 저장이 됩니다. 
```
@Entity
public class Reservation {

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "STAY_ID", foreignKey = @ForeignKey(name = "FK_STAY_RESERVE_ID"))
    private Stay stay;

    @Column(name = "CHECK_IN")
    private LocalDateTime checkIn;

    @Column(name = "CHECK_OUT")
    private LocalDateTime checkOut;
    
}

 

• 사용자가 검색하는 날짜의 타입은 LocalDate 입니다.

private BooleanExpression matchesCheckInAndCheckOut(LocalDate checkInDate, LocalDate checkOutDate)

 

예약엔티티의 LocalDateTime 은 Mysql 의 DateTime 과 대응되기 때문에(jpa 의 ddl-auto=true 로 설정했습니다)

위의 소개한 예시를 충족하기 위해서는 DateTime 을 Date 와 Time 으로 쪼개서,

날짜는 날짜대로 시간은 시간끼리 각각 비교해야 했습니다.

 

그래서, Querydsl 의 Expressions  라이브러리에 있는 `timeTemplate` 과 `dateTemplate` 을 사용하여

dateTemplate 을 사용해서 DateTime 을 LocalDate 로,

timeTemplate 을 사용해서 DateTime 을 LocalTime 으로 바꿨습니다.

 

 

Expressions.timeTemplate 예시 

// 예약 checkIn시간(타입 : LocalDateTime) Time 로 형변환하여, LocalTime 으로 만듭니다.
TimeTemplate<LocalTime> reservationCheckInTime 
        = Expressions.timeTemplate(LocalTime.class, "CAST({0} AS TIME)", reservation.checkIn);

 

Expressions.dateTemplate 예시 

// 예약 checkout 시간(타입 : LocalDateTime)을 Date 로 형변환하여, LocalDate로 만듭니다.
DateTemplate<LocalDate> reservationCheckOutDate 
        = Expressions.dateTemplate(LocalDate.class, "CAST({0} AS DATE)", reservation.checkOut);

 

Expressions.timeTemplate 의 파라미터 이해하기 

• LocalTime.class → timeTemplate(dateTemplate) 의 결과로 올 타입을 선언합니다.
• `CAST({0} AS TIME)`→ Mysql 의 DateTime 을 Time 으로 형변환 합니다. {0}은 자리 표시자로, 후에 제공된 파라미터(reservation.checkIn)로 대체됩니다. 
• reservation.checkIn → 형변환 하고 싶은 Mysql 의 컬럼을 선언합니다.

 

전체 코드

package com.airdnb.clone.domain.booking.repository;

import static com.airdnb.clone.domain.booking.entity.QBooking.booking;
import static com.airdnb.clone.domain.stay.entity.QStay.stay;

import com.querydsl.core.types.dsl.BooleanExpression;
import com.querydsl.core.types.dsl.DateTemplate;
import com.querydsl.core.types.dsl.Expressions;
import com.querydsl.core.types.dsl.TimeTemplate;
import com.querydsl.jpa.impl.JPAQuery;
import com.querydsl.jpa.impl.JPAQueryFactory;
import java.time.LocalDate;
import java.time.LocalTime;
import java.util.List;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class ReservationQuerydslImpl implements ReservationQuerydsl{

    private final JPAQueryFactory jpaQueryFactory;

    public List<Long> findUnavailableStayIdsByCheckInOut(LocalDate checkInDate, LocalDate checkOutDate) {
        return jpaQueryFactory
                .select(reservation.stay.id)
                .distinct()
                .from(reservation)
                .where(matchesCheckInAndCheckOut(checkInDate, checkOutDate))
                .fetch();
    }

    private BooleanExpression matchesCheckInAndCheckOut(LocalDate checkInDate, LocalDate checkOutDate) {

        if (checkInDate == null || checkOutDate == null) {
            return null;
        }
        if (checkInDate.isAfter(checkOutDate)) {
            throw new IllegalArgumentException();
        }

        DateTemplate<LocalDate> reservationCheckInDate = Expressions.dateTemplate(LocalDate.class, 
                "CAST({0} AS DATE)"", reservation.checkIn);

        TimeTemplate<LocalTime> reservationCheckInTime = Expressions.timeTemplate(LocalTime.class,
                "CAST({0} AS TIME)"", reservation.checkIn);

        DateTemplate<LocalDate> reservationCheckOutDate = Expressions.dateTemplate(LocalDate.class,
                "CAST({0} AS DATE)"", reservation.checkOut);

        TimeTemplate<LocalTime> reservationCheckOutTime = Expressions.timeTemplate(LocalTime.class,
                "CAST({0} AS TIME)"", reservation.checkOut);

     /*
     *  (이미 예약 된 체크인 날짜 < 검색한 체크아웃 날짜) or
     *  (이미 예약된 체크인 날짜 == 검색한 체크아웃 날짜) and (이미 예약된 숙소의 체크인 시간 < 해당 숙소의 체크아웃 시간)
     *  and
     *  (이미 예약된 체크아웃 날짜 > 검색한 체크인 날짜) or
     *  (이미 예약된 체크아웃 날짜 == 검색한 체크인 날짜) and (이미 예약된 숙소의 체크아웃 시간 > 해당 숙소의 체크인 시간)
     * 에 해당되면 예약 불가능한 숙소에 해당.
     */
      return  reservationCheckInDate.lt(checkOutDate)
                .or(reservationCheckInDate.eq(checkOutDate).and(reservationCheckInTime.lt(reservation.stay.checkOutTime)))             
                .and(reservationCheckOutDate.gt(checkInDate)
                     .or(reservationCheckOutDate.eq(checkInDate).and(reservationCheckOutTime.gt(reservation.stay.checkInTime))));
    }
}

---

이 외에도 시간과 날짜를 비교하기 위해, Querydsl 의 between 과 stringTemplate 도 있으니 상황에 맞게 선택하시면 되겠습니다.