Spring Data JPA - QueryDSL 설정

📝 Spring Data JPA - QueryDSL 설정

Spring Data JPA를 사용하다보면 Mybatis의 동적쿼리가 그리워 질 때가 있다.
Select 기능의 경우 Database에 동적쿼리가 필수적인데, 이럴때 QueryDSL을 사용하여 Spring Data JPA와 연동하면 동적쿼리가 가능하다!
Spring Boot + Maven 환경에서 설정 방법을 정리해보려고 한다.

🚩 QueryDSL 설정

1. Pom.xml 에서 Denpendency 추가

<dependencies>
  <!-- Querydsl Dependency-->
  <dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-jpa</artifactId>
  </dependency>

  <!-- Querydsl Dependency-->
  <dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-apt</artifactId>
    <scope>provided</scope>
  </dependency>
</dependencies>

2. Pom.xml 에서 Plugins 추가

<build>
  <plugins>
    <plugin>
      <groupId>com.mysema.maven</groupId>
      <artifactId>apt-maven-plugin</artifactId>
      <version>1.1.3</version>
      <executions>
        <execution>
          <goals>
            <goal>process</goal>
          </goals>
          <configuration>
            <outputDirectory>target/generated-sources/java</outputDirectory>
            <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

3. Intellij -> Project Structure -> Modules 메뉴에서 'target/generated-sources/java' 폴더를 Source 폴더로 지정

4. QueryDSL 설정파일 생성

// Config Package 하위에 하거나 JPA 와 관련된 Package 하위에 Config Package를 만들어서 설정한다.
// 필자는 repository.config Package 하위에 작성하였다.
@Configuration
public class JPAConfig {
    @PersistenceContext
    private EntityManager entityManager;

    @Bean
    public JPAQueryFactory jpaQueryFactory() {
        return new JPAQueryFactory(entityManager);
    }
}

이상으로 QueryDSL을 사용할 기본적인 설정은 모두 마쳤다!
다음으로는 Spring Data JPA와 연동하여 CustomRepository 를 생성하는 법을 정리해보겠다.

🚩 Spring Data JPA + QueryDSL Repository 생성

Spring Data JPA + QueryDSL Repository 생성에 앞서서 기본적인 구조는 아래의 그림을 참고해야한다.

• 기본적인 Spring Data JPA의 Repository는 JpaRepository 인터페이스를 상속받아 확장한 인터페이스 이다
• Spring Data JPA + QueryDSL을 하나의 인터페이스로 사용하기 위해서는 사용자 정의 Repository 인터페이스가 QueryDSL에서 사용하는 Custom 인터페이스도 상속 받아서 확장해야한다.
• QueryDSL Custom 인터페이스는 CustomImpl Class가 상속받아서 구현한다.
  → 반드시 ***Impl Naming을 지켜야 Spring에서 인식하므로 주의해야한다.

1. Spring Data JPA Interface 설정

// extend에 QueryDSL Custom 인터페이스가 추가되었다.
public interface UserInfoRepository 
        extends JpaRepository<UserInfo, Long>, UserInfoRepositoryCustom {
    @Override
    @EntityGraph(attributePaths = {"userDetailInfo"})
    Optional<UserInfo> findById(Long aLong);
}

2. QueryDSL Custom 인터페이스 설정

public interface UserInfoRepositoryCustom {
    List<UserInfo> findByRequestPayload(UserInfoSelectRequestPayload payload, 
                                        Pageable pageable);
}

3. QueryDSL Custom 인터페이스 상속받아 CustomImpl Class 구현

@Repository
@RequiredArgsConstructor
public class UserInfoRepositoryImpl implements UserInfoRepositoryCustom {
    private final JPAQueryFactory queryFactory;

    @Override
    public List<UserInfo> findByRequestPayload(UserInfoSelectRequestPayload payload,
                                               Pageable pageable) {
        return queryFactory.selectFrom(userInfo)
                .where(likeName(payload.getName()), 
                        eqSex(payload.getSex()), 
                        likeDowntownName(payload.getDowntownName()))
                .leftJoin(userInfo.downtownInfo, downtownInfo).fetchJoin()
                .leftJoin(userInfo.userDetailInfo, userDetailInfo).fetchJoin()
                .offset(pageable.getPageNumber())
                .limit(pageable.getPageSize())
                .fetch();
    }

    private BooleanExpression likeName(String name) {
        if (ObjectUtils.isEmpty(name))
            return null;

        return userInfo.name.like(name);
    }

    private BooleanExpression likeName(int name) {
        String findName = String.valueOf(name);

        if (ObjectUtils.isEmpty(findName))
            return null;

        return userInfo.name.like(findName);
    }

    private BooleanExpression eqSex(Sex sex) {
        if (ObjectUtils.isEmpty(sex))
            return null;

        return userInfo.userDetailInfo.sex.eq(sex);
    }

    private BooleanExpression likeDowntownName(String downtownName) {
        if (ObjectUtils.isEmpty(downtownName))
            return null;

        return userInfo.downtownInfo.name.like(downtownName);
    }
}

4. Service Layer 에서 사용

@Service
@RequiredArgsConstructor
@Transactional(readOnly = true)
public class UserInfoServiceImpl implements IUserInfoService {
    private final UserInfoRepository userInfoRepository;

    @Override
    public UserInfoSelectResponsePayload userInfoSelect(UserInfoSelectRequestPayload payload, Pageable pageable) {
    	// 여기서 사용한다!!!!
        List<UserInfo> findUserInfoList = userInfoRepository.findByRequestPayload(payload, pageable);

        List<UserInfoDTO> userInfoDTOList = findUserInfoList.stream()
                .map(UserInfoDTO::new)
                .collect(Collectors.toList());

        UserInfoSelectResponsePayload userInfoSelectResponsePayload = new UserInfoSelectResponsePayload();
        userInfoSelectResponsePayload.setUserInfoList(userInfoDTOList);

        return userInfoSelectResponsePayload;
    }
}

📌 마무리

Spring Data JPA + QueryDSL 의 기본 설정 및 구현을 모두 정리하였다.
QueryDSL 의 CustomImpl Class에서 구현 코드에 여러가지 기법이 나왔는데 간략하게 설명하자면 QueryFactory 를 이용하여 테이블들을 SQL문 처럼 조회하고 LeftJoin.fetchJoin() Method를 활용하여 N+1 문제를 해결한 것이다.
다음 정리에서 자세하게 다뤄보도록 하겠다.