Querydsl 수업을 듣고 정리한 내용입니다.

 

📚 1. 순수 JPA 리포지토리와 Querydsl

📖 A. 순수 JPA 리포지토리

MemberJpaRepository - 순수 JPA 리포지토리

@Repository
public class MemberJpaRepository {

    private final EntityManager em;
    private final JPAQueryFactory queryFactory;
    
    public MemberJpaRepository(EntityManager em) {
        this.em = em;
        this.queryFactory = new JPAQueryFactory(em);
    }
    
    public void save(Member member) {
        em.persist(member);
    }
    
    public Optional<Member> findById(Long id) {
        Member findMember = em.find(Member.class, id);
        return Optional.ofNullable(findMember);
    }
    
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
    
    public List<Member> findByUsername(String username) {
        return em.createQuery("select m from Member m where m.username = :username", Member.class)
                .setParameter("username", username)
                .getResultList();
    }
}

 

MemberJpaRepositoryTest - 순수 JPA 리포지토리 테스트

@SpringBootTest
@Transactional
class MemberJpaRepositoryTest {

    @Autowired
    EntityManager em;
    
    @Autowired
    MemberJpaRepository memberJpaRepository;
    
    @Test
    public void basicTest() {
        Member member = new Member("member1", 10);
        memberJpaRepository.save(member);
        
        Member findMember = memberJpaRepository.findById(member.getId()).get();
        assertThat(findMember).isEqualTo(member);
        
        List<Member> result1 = memberJpaRepository.findAll();
        assertThat(result1).containsExactly(member);
        
        List<Member> result2 = memberJpaRepository.findByUsername("member1");
        assertThat(result2).containsExactly(member);
    }
}

 

📖 B. Querydsl 사용

MemberJpaRepository - 순수 JPA 리포지토리에 Querydsl 추가

public List<Member> findAll_Querydsl() {
    return queryFactory
            .selectFrom(member).fetch();
}

public List<Member> findByUsername_Querydsl(String username) {
    return queryFactory
            .selectFrom(member)
            .where(member.username.eq(username))
            .fetch();
}

 

MemberJpaRepositoryTest - Querydsl 테스트

@Test
public void basicQuerydslTest() {
    Member member = new Member("member1", 10);
    memberJpaRepository.save(member);
    
    Member findMember = memberJpaRepository.findById(member.getId()).get();
    assertThat(findMember).isEqualTo(member);
    
    List<Member> result1 = memberJpaRepository.findAll_Querydsl();
    assertThat(result1).containsExactly(member);
    
    List<Member> result2 = memberJpaRepository.findByUsername_Querydsl("member1");
    assertThat(result2).containsExactly(member);
}

 

✔️ JPAQueryFactory 스프링 빈 등록

이와 같이 JPAQueryFactory를 스프링 빈으로 등록해서 주입받아 사용해도 된다.

 

💡 참고

• 동시성 문제는 걱정하지 않아도 된다. 왜냐하면 여기서 스프링이 주입해주는 엔티티 매니저는 실제 동작 시점에 진짜 엔티티 매니저를 찾아주는 프록시용 가짜 엔티티 매니저이다.
• 이 가짜 엔티티 매니저는 실제 사용 시점에 트랜잭션 단위로 실제 엔티티 매니저(영속성 컨텍스트)를 할당해준다.

 

📚 2. 동적 쿼리와 성능 최적화 조회 - Builder 사용

✔️ MemberTeamDto - 조회 최적화용 DTO 추가

package study.querydsl.dto;  
  
import com.querydsl.core.annotations.QueryProjection;  
import lombok.Data;  
  
@Data  
public class MemberTeamDto {  
    private Long memberId;  
    private String username;  
    private int age;  
    private Long teamId;  
    private String teamName;  
  
    @QueryProjection  
    public MemberTeamDto(Long memberId, String username, int age, Long teamId, String teamName) {  
        this.memberId = memberId;  
        this.username = username;  
        this.age = age;  
        this.teamId = teamId;  
        this.teamName = teamName;  
    }  
}

• @QueryProjection을 추가했다.
• QMemberTeamDto를 생성하기 위해 ./gradlew compileQuerydsl 실행한다.

 

💡 참고

• @QueryProjection 을 사용하면 해당 DTO가 Querydsl을 의존하게 된다.
• 이런 의존이 싫으면, 해당 에노테이션을 제거하고, Projection.bean(), fields(), constructor() 을 사용하면 된다.

 

✔️ 회원 검색 조건

package study.querydsl.dto;  
  
  
import lombok.Data;  
  
@Data  
public class MemberSearchCondition {  
    // 회원명, 팀명, 나이(ageGoe, ageLoe)  
  
    private String username;  
    private String teamName;  
    private Integer ageGoe;  
    private Integer ageLoe;  
}

• 이름이 너무 길 경우, MemberCond 등으로 줄여서 사용해도 된다.

 

✔️ 동적쿼리 - Builder를 사용한 예제

// Builder 사용  
// 회원명, 팀명, 나이(ageGoe, ageLoe)  
public List<MemberTeamDto> searchByBuilder(MemberSearchCondition condition) {  
    BooleanBuilder builder = new BooleanBuilder();  
    if (hasText(condition.getUsername())) {  
        builder.and(member.username.eq(condition.getUsername()));  
    }  
  
    if (hasText(condition.getTeamName())) {  
        builder.and(team.name.eq(condition.getTeamName()));  
    }  
  
    if (condition.getAgeGoe() != null) {  
        builder.and(member.age.goe(condition.getAgeGoe()));  
    }  
  
    if (condition.getAgeLoe() != null) {  
        builder.and(member.age.goe(condition.getAgeLoe()));  
    }  
  
    return queryFactory  
            .select(new QMemberTeamDto(  
                    member.id,  
                    member.username,  
                    member.age,  
                    team.id,  
                    team.name))  
            .from(member)  
            .leftJoin(member.team, team)  
            .where(builder)  
            .fetch();  
}

 

조회 예제 테스트

@Test  
public void searchTest() {  
    Team teamA = new Team("teamA");  
    Team teamB = new Team("teamB");  
    em.persist(teamA);  
    em.persist(teamB);  
  
    Member member1 = new Member("member1", 10, teamA);  
    Member member2 = new Member("member2", 20, teamA);  
    Member member3 = new Member("member3", 30, teamB);  
    Member member4 = new Member("member4", 40, teamB);  
  
    em.persist(member1);  
    em.persist(member2);  
    em.persist(member3);  
    em.persist(member4);  
  
    MemberSearchCondition condition = new MemberSearchCondition();  
    condition.setAgeGoe(35);  
    condition.setAgeLoe(40);  
    condition.setTeamName("teamB");  
  
    List<MemberTeamDto> result = memberJpaRepository.searchByBuilder(condition);  
  
    assertThat(result).extracting("username").containsExactly("member4");  
}

 

실행 결과

 

📚 3. 동적 쿼리와 성능 최적화 조회 - Where절 파라미터 사용

MemberJpaRepository에 추가 - Where절에 파라미터를 사용한 예제

//회원명, 팀명, 나이(ageGoe, ageLoe)
public List<MemberTeamDto> search(MemberSearchCondition condition) {  
  
    return queryFactory  
            .select(new QMemberTeamDto(  
                    member.id,  
                    member.username,  
                    member.age,  
                    team.id,  
                    team.name))  
            .from(member)  
            .leftJoin(member.team, team)  
            .where(  
                    usernameEq(condition.getUsername()),  
                    teamNameEq(condition.getTeamName()),  
                    ageGoe(condition.getAgeGoe()),  
                    ageLoe(condition.getAgeLoe()))  
            .fetch();  
}

private BooleanExpression usernameEq(String username) {  
    return hasText(username) ? member.username.eq(username) : null;  
}  
  
private BooleanExpression teamNameEq(String teamName) {  
    return hasText(teamName) ? team.name.eq(teamName) : null;  
}  
  
private BooleanExpression ageGoe(Integer ageGoe) {  
    return ageGoe != null ? member.age.goe(ageGoe) : null;  
}  
  
private BooleanExpression ageLoe(Integer ageLoe) {  
    return ageLoe != null ? member.age.loe(ageLoe) : null;  
}

 

조회 예제 테스트

@Test  
public void searchTest() {  
    Team teamA = new Team("teamA");  
    Team teamB = new Team("teamB");  
    em.persist(teamA);  
    em.persist(teamB);  
  
    Member member1 = new Member("member1", 10, teamA);  
    Member member2 = new Member("member2", 20, teamA);  
    Member member3 = new Member("member3", 30, teamB);  
    Member member4 = new Member("member4", 40, teamB);  
  
    em.persist(member1);  
    em.persist(member2);  
    em.persist(member3);  
    em.persist(member4);  
  
    MemberSearchCondition condition = new MemberSearchCondition();  
    condition.setAgeGoe(35);  
    condition.setAgeLoe(40);  
    condition.setTeamName("teamB");  
  
    List<MemberTeamDto> result = memberJpaRepository.search(condition);  
  
    assertThat(result).extracting("username").containsExactly("member4");  
}

 

실행 결과

 

✔️ where 절에 파라미터 방식을 사용하면 조건 재사용 가능하다.

//where 파라미터 방식은 이런식으로 재사용이 가능하다.
public List<Member> searchMember(MemberSearchCondition condition) {
    return queryFactory
            .selectFrom(member)
            .leftJoin(member.team, team)
            .where(usernameEq(condition.getUsername()),
                    teamNameEq(condition.getTeamName()),
                    ageGoe(condition.getAgeGoe()),
                    ageLoe(condition.getAgeLoe()))
            .fetch();
}

• Builder를 사용하는 것보다 Where절에 파라미터 방식을 사용하는 것이 가독성이 좋다.

 

📚 4. 조회 API 컨트롤러 개발

• 편리한 데이터 확인을 위해 샘플 데이터를 추가하자.
• 샘플 데이터 추가가 테스트 케이스 실행에 영향을 주지 않도록 다음과 같이 프로파일을 설정하자

 

✔️ 프로파일 설정

src/main/resources/application.yml

 

src/test/resources/application.yml

➡️ 이렇게 분리하면 main 소스코드와 테스트 소스 코드 실행시 프로파일을 분리할 수 있다.

 

✔️ 샘플 데이터 추가

package study.querydsl.controller;  
  
import lombok.RequiredArgsConstructor;  
import org.springframework.context.annotation.Profile;  
import org.springframework.stereotype.Component;  
import org.springframework.transaction.annotation.Transactional;  
import study.querydsl.entity.Member;  
import study.querydsl.entity.Team;  
  
import javax.annotation.PostConstruct;  
import javax.persistence.EntityManager;  
import javax.persistence.PersistenceContext;  
  
@Profile("local")  
@Component  
@RequiredArgsConstructor  
public class InitMember {  
  
    private final InitMemberService initMemberService;  
  
    @PostConstruct  
    public void init() {  
        initMemberService.init();  
    }  
  
    // 시작할 때 db에 데이터를 다 넣는다.  
    @Component  
    static class InitMemberService {  
        @PersistenceContext  
        private EntityManager em;  
  
        @Transactional  
        public void init() {  
            Team teamA = new Team("teamA");  
            Team teamB = new Team("teamB");  
            em.persist(teamA);  
            em.persist(teamB);  
  
            for (int i = 0; i < 100; i++) {  
                Team selectedTeam = i % 2 == 0 ? teamA : teamB;  
                em.persist(new Member("member" + i, i, selectedTeam));  
            }  
  
        }  
    }  
  
}

• InitMemberService의 init() 안의 내용을 바로 @PostConstruct 어노테이션이 달린 init() 안에 바로 넣지 않고 굳이 분리하는 이유는 @PostConstruct와 @Transactional을 동시에 붙일 수 없기 때문이다!

• 질문 게시판에서 추가로 설명해주셨다.

 

✔️ 조회 컨트롤러

MemberController

package study.querydsl.controller;  
  
  
import lombok.RequiredArgsConstructor;  
import org.springframework.web.bind.annotation.GetMapping;  
import org.springframework.web.bind.annotation.RestController;  
import study.querydsl.dto.MemberSearchCondition;  
import study.querydsl.dto.MemberTeamDto;  
import study.querydsl.repository.MemberJpaRepository;  
  
import java.util.List;  
  
@RestController  
@RequiredArgsConstructor  
public class MemberController {  
  
    private final MemberJpaRepository memberJpaRepository;  
  
    @GetMapping("/v1/members")  
    public List<MemberTeamDto> searchMemberV1(MemberSearchCondition condition) {  
        return memberJpaRepository.search(condition);  
    }  
}

 

실행 결과

• InitMember의 @Profile("local") 있는 local이다.
• 즉, 실행 초기에 InitMember가 실행된다.

 

postman에서
http://localhost:8080/v1/members?teamName=teamB&ageGoe=31&ageLoe=35 실행 결과

 

🔔 spring local vs test로 테스트 실행할 때

• java 디렉터리에서 localhost:8080을 호출하여 화면을 띄울 때는 InitMember 와 같은 클래스를 선언하여 테스트 데이터를 넣어 준다.
• test 디렉터리에서 test할 때는 test용 데이터로 체크한다.
  • 현재 test 에서는 실행해도, 샘플 데이터가 실행되지 않는다.
  • test디렉터리에 있는 테스트 소스 파일을 실행했을 때, 현재 InitMember가 활성화되지 않는다. InitMember는 @Profile("local")이기 때문에, localhost:8080 으로 실행했을 때 활성화 된다.