[JPA] JPQL 문법 1 - 기본 문법, 파라미터 바인딩, 프로젝션, 페이징

SQL이 데이터베이스의 테이블을 대상으로 하는 조회 쿼리 였다면 JPQL은 엔티티 객체를 조회하는 객체 지향 쿼리입니다.

JPQL의 문법은 SQL과 비슷하고, ANSI 표준 SQL이 제공하는 기능을 유사하게 지원합니다.

SQL을 추상화한 덕분에 특정 SQL에 의존하지 않아 대부분의 관계형 데이터베이스에 적용할 수 있습니다.

 

JPQL은 결국 객체 지향적인 쿼리일 뿐, 실행될 때 관계형 데이터베이스에 접근할 때에는 SQL로 변환되어 전달됩니다.

---

기본 문법과 쿼리 API

JPQL도 SQL과 비슷하게 SELECT, UPDATE, DELETE문을 사용할 수 있습니다. 

INSERT문은 em.persist를 사용하면 되기 때문에 직접적으로 JPQL에는 INSERT문이 직접적으로 포함되어 있지 않습니다.

 

SELECT 문

select 문은 기본적으로 다음과 같이 사용합니다.

SELECT m
FROM Member AS m
where m.username='hello'

• 엔티티와 속성은 대소문자를 구분합니다. (Member, username)
• 엔티티 이름
  • 위 JPQL에서 사용한 Member는 클래스명 X 엔티티명 O
  • 자바 진영에 엔티티명을 지정(@Entity(name="~")) 하지 않으면 클래스 이름으로 자동 지정됩니다.
  • 기본값인 클래스명을 엔티티명으로 사용하는 것이 일반적입니다.
  • 별칭 : Member AS m을 보면 Member에 m이라는 별칭을 부여했습니다. JPQL에서는 별칭을 필수적으로 사용해야 합니다.
    • AS는 생략 가능. 따라서 Member m으로 작성해도 좋습니다.

작성한 JPQL문을 실행하려면 쿼리 객체를 만들어야 합니다. 쿼리 객체는 TypeQuery와 Query 객체가 있습니다.

• TypeQuery : 반환할 타입을 명확하게 지정할 수 있는 경우 사용
• Query : 반환 타입을 명확하게 지정할 수 없는 경우 사용

 

TypeQuery

// 반환 타입을 명확하게 지정가능한 경우
TypedQuery<Member> query = em.createQuery("SELECT m FROM Member m", Member.class);
List<Member> resultList = query.getResultList();
for (Member member : resultList) {
    System.out.println("member = " + member);
}

• 조회 대상이 Member 엔티티이므로 조회 대상 타입이 명확합니다. 이때는 TypeQuery를 사용할 수 있습니다.

Query

Query query = em.createQuery("SELECT m.id, m.name FROM Member m");
List resultList = query.getResultList();
for (Object o : resultList) {
    Object[] result = (Object[]) o; // 결과가 둘 이상인 경우
    System.out.println("id = " + result[0]);
    System.out.println("name = " + result[1]);
}

• 조회 대상이 String 타입인 이름과 Integer 타입인 나이이므로 조회 대상 타입이 명확하지 않습니다. 
• 여러 엔티티나 컬럼을 선택할 때는 반환 타입이 명확하지 않기 때문에 Query 객체를 사용해야 합니다.
• 조회 대상이 둘 이상인 경우 Object[]를 반환하고, 조회 대상이 하나인 경우 Object를 반환합니다. 

query.getResultList() : 쿼리 실행 결과를 리스트 형태로 리턴, 결과가 없으면 빈 컬렉션 리턴합니다.
query.getSingleResult() : 결과가 정확히 하나일 때 결과 리턴, 만약 결과가 없거나 결과가 여러개인 경우 예외가 발생합니다.

---

파라미터 바인딩 

JDBC는 위치 기반 (?를 사용한 파라미터 바인딩) 바인딩만 지원하지만 JPQL은 이름 기준 파라미터 바인딩도 지원합니다.

 

위치 기반 파라미터 

List<Member> members = em.createQuery("SELECT m FROM Member m where m.name = ?1", Member.class)
                    .setParameter(1, 'kim')
                    .getResultList();
for (Member member : members) {
    System.out.println("member = " + member);
}

※ JPQL API는 대부분 메소드 체인 방식으로 설계되어 있어 연속해서 작성할 수 있습니다.

 

이름 기반 파라미터

List<Member> members = em.createQuery("SELECT m FROM Member m where m.name := username", Member.class)
                    .setParameter("username", 'kim')
                    .getResultList();
for (Member member : members) {
    System.out.println("member = " + member);
}

이름 기반 파라미터는 파라미터 이름으로 구분하는 방법으로 등호 앞에 :를 사용합니다.

 

+ 직접 문자를 더해 JPQL문을 만드는 방식은 SQL 인젝션 공격에 상당히 취약합니다.

예를들어 아래와 같은 JPQL문을 만들었다고 가정해봅시다.

String query = "SELECT * FROM Member m WHERE m.username = '" + username + "' AND m.password = '" + password + "'";

정상적인 입력의 경우 실행되는 JPQL

SELECT * FROM Member m WHERE username = 'john' AND password = 'secret'

악의적인 입력의 경우 실행되는 JPQL

SELECT * FROM Member m WHERE username = '' OR '1'='1' AND password = '' OR '1'='1'

이 경우, '1'='1' 조건이 항상 참이 되기 때문에 악의적인 사용자는 로그인 절차를 우회하고 모든 사용자의 데이터를 액세스할 수 있을 수 있습니다.

 

따라서 파라미터 바인딩 방식을 사용하되, 좀 더 명확한 파라미터 바인딩 방식인 이름 기반 파라미터 바인딩 방식을 사용하도록 합시다.

---

프로젝션 

select절에 조회할 대상을 지정하는 것을 프로젝션이라고 합니다.

프로젝션에는 엔티티 뿐만 아니라, 임베디드 타입, 스칼라 타입 또한 지정할 수 있습니다.

 

'스칼라 타입'이란?

: 숫자, 문자 등 기본 데이터 타입

엔티티 프로젝션

SELECT m FROM Member m
SELECT m.username FROM Member m

조회한 엔티티는 영속성 컨텍스트에서 관리됩니다.

 

임베디드 타입 프로젝션

임베디드 타입이란?

[JPA] 값 타입 - 임베디드 값 타입, 컬렉션 값 타입

 

JPQL에서 임베디드 타입은 엔티티와 거의 비슷하게 사용되지만, 하지만 한 가지 제약이 있습니다.

당연한 얘기지만, 임베디드 타입은 조회의 시작점이 될 수가 없습니다. 시작점은 반드시 엔티티를 통해서 접근해야 합니다.

 

잘못된 예시

SELECT a FROM Address a

올바른 사용 예시

TypedQuery<Address> query = em.createQuery("SELECT o.address FROM Orders o", Address.class);
List<Address> resultList = query.getResultList();

임베디드 타입은 엔티티 타입이 아닌 값 타입이기 떄문에 조회한 임베디드 타입은 영속성 컨텍스트에서 관리되지 않습니다. 

 

스칼라 타입 프로젝션

숫자, 문자, 날짜와 같은 기본 데이터 타입들을 스칼라 타입이라고 합니다. 예를들어 전체 회원의 이름을 조회하고 싶을 때 다음 처럼 쿼리하면 됩니다.

TypedQuery<String> query = em.createQuery("SELECT m.name FROM Member m", String.class);
List<String> resultList = query.getResultList();

 

여러 값 프로젝션

엔티티를 대상으로 조회하면 편리하겠지만, 꼭 필요한 데이터들만 선택해서 조회해야 할 때도 있습니다.

프로젝션에 여러값을 선택하면 TypeQuery를 사용할 수 없고 Query를 사용해야 합니다.

List<Object[]> resultList = em.createQuery("SELECT m.name, m.age FROM Member m")
        .getResultList();
for (Object[] row : resultList) {
    String username = (String) row[0];
    Integer age = (Integer) row[1];

    System.out.println("username = " + username);
    System.out.println("age = " + age);
}

실제 애플리케이션 개발 시에는 Object[]를 사용하지 않고 DTO 로 변환해서 사용합니다.

List<Object[]> resultList = em.createQuery("SELECT m.name, m.age FROM Member m")
        .getResultList();

List<MemberDto> memberDTOs = new ArrayList<MemberDto>();

for (Object[] row : resultList) {
    MemberDto memberDto = new MemberDto((String) row[0], (Integer) row[1]);
    memberDtos.add(memberDto);
}

- DTO 변환 작업을 추가로 수행합니다.

- 객체 변환 작업도 귀찮게 for문으로 작성하지 않고, new 명령어를 사용하여 JPQL 하나로 퉁쳐서 변환할 수 있습니다.

TypedQuery<MemberDto> query = em.createQuery("SELECT new domain.MemberDto(m.name, m.age) FROM Member m", MemberDto.class);
List<MemberDto> resultList = query.getResultList();

• new 명령어 사용시 패키지 명을 포함한 전체 클래스명을 입력해야 하고
• 순서와 타입이 일치하는 생성자가 필요합니다.

---

페이징 처리 메소드 

페이징은 데이터를 페이지 단위로 나누어서 조회하는 기능입니다. 데이터베이스마다 페이징을 처리하는 SQL문법이 다르지만, JPA는 페이징을 다음 두 API로 추상화 해두었습니다.

• setFirstResult(int startPosition) : 조회 시작 위치 ( 0부터 시작 )
• setMaxResults(int maxResult) : 조회할 데이터 수 

---

<참고자료>

• 자바 ORM 표준 JPA 프로그래밍, 김영한