자바 ORM 표준 JPA 프로그래밍 - 기본편

객체지향 쿼리 언어 1 - 기본문법 : 소개

JPA는 다양한 쿼리 방법을 지원한다

  • JPQL
  • JPA Criteria
  • QueryDSL
  • 네이티브 SQL
  • JDBC API 직접 사용, MyBatis, SpringJdbcTemplate 함께 사용

JPQL 이란

  • 가장 단순한 조회 방법
    • EntityManager.find()
    • 객체 그래프 탐색(a.getB().getC())
  • JPA를 사용하면 엔티티 객체를 중심으로 개발
  • 문제는 검색 쿼리
  • 검색을 할 때도 테이블이 아닌 엔티티 객체를 대상으로 검색해야한다.
  • 모든 DB 데이터를 객체로 변환해서 검색하는 것은 불가능
  • 애플리케이션이 필요한 데이터만 DB에서 불러오려면 검색 조건이 포함된 SQL이 필요
  • JPA는 SQL을 추상화한 JPQL 이라는 객체 지향 쿼리 언어 제공
  • SQL 과 문법 유사, SELECT, FROM, WHERE, GROUP BY, HAVING, JOIN 자원
  • JPQL 은 엔티티 객체를 대상으로 쿼리
  • SQL은 데이터베이스 테이블을 대상으로 쿼리
// JPQL example 
String jpql = "select m From Member m where m.name like '%hello%'";
// Member 는 테이블 데이터를 가리키는게 아닌
// Entity Member를 가리키고 있다
List<Member> result = em.createQuery(jpql, Member.class).getResultList();
  • 테이블이 아닌 객체를 대상으로 검색하는 객체 지향 쿼리
  • SQL을 추상화해서 특정 데이터베이스 SQL에 의존하지 않는다
  • JPQL = 객체지향 SQL

Criteria 소개

//Criteria 사용 준비
CriteriaBuilder cb = em.getCroteroaBuilder();
CriteriaQuery<Member> query = cb.createQuery(Member.class)

//루트 클래스 (조회를 시작할 클래스)
Root<Member> m = query.from(Member.class)

// 쿼리 생성 
CriteriaQuery<Member> cq = query.select(m).where(cb.equal(m.get("username"), "kim"));
List<Member> resultList = em.createQuery(cq).getResultList();
  • JPQL은 기본적으로 단순한 문자열이다. 즉, 동적 쿼리를 다 만들어 내려면 쿼리문을 만들어 내야 한다.
    • 좀더 객체지향적이며, 문장을 구현하거나 띄워쓰기 등을 다 일일히 지키지 않아도 되는 편리한 방식이 필요.
  • 그런 점에서 Criteria 방식은 동적 쿼리를 만들기 쉽다.
    • 오타, 자잘한 버그를 최소화시킬 수 있다.
    • 하지만 치명적으로 SQL문 스럽지 않은 구성은 러닝커브, 유지보수 측면에서 가독성이 안 나오는 등의 문제를 함께 가지고 있다.
  • 그러다보니 실무에서 실질적으로 쓰이기가 매우 어렵다.
  • JPA 공식 기능이지만 실용성이 없기에, QueryDSL 사용 권장된다.

QeuryDSL 소개

//JPQL
//select m from Member m where m.age > 18
JPAFactoryQuery query = new JPAQueryFactory(em);
QMember m = QMember.member;

List<Member> list = query.selectFrom(m)
							.where(m.age.gt(18))
							.orderBy(m.name.desc())
							.fetch();
  • 문자가 아닌 자바 코드로 JPQL을 작성할 수 있다.
  • JPQL 빌더의 역할
  • 컴파일 시점에서 문법 오류 찾을 수 있다
  • 동적 쿼리 작성에 용이함
  • Criteria 보다 단순하고 쉬우며 가독성이 좋음
  • 실무 사용이 권장된다. JPQL의 문법을 잘 파악한 이후, 레퍼런스 문서를 잘 찾아보는 것만으로도 충분히 쉽게 복잡한 조건 상황들을 풀어서 검색이 가능해진다.

네이티브 SQL 소개

  • JPA가 제공하는 SQL을 직접 사용하는 기능
  • JPQL 로 해결할 수 없는 특정 데이터베이스에 의존적인 기능
    • 예) 오라클 CONNECT BY, 특정 DB 만 사용하는 SQL 힌트
String sql = "SELECT ID, AGE, TEAM_ID, NAME FROM MEMBER WHERE NAME = `kim`";
List<Member> resultList = em.createNativeQyery(sql, Member.class).getResultList();

JDBC 직접 사용, SpringJdbcTemplate 등

  • JPA를 사용하면서 JDBC 커넥션을 직접 사용하거나, 스프링 JdbcTemplate, MyBatis 등을 함께 사용 가능하다
  • 단 영속성 컨텍스트를 적절한 시점에 강제로 플러시 필요
    • 예 ) JPA를 우회해서 SQL을 실행하기 직전에 영속성 컨텍스트 수동 Flush

객체지향 쿼리 언어 1 - 기본문법 : 기본 문법과 쿼리 API

JPQL 소개

  • JPQL = Java Persistence Query Language
  • 객체지향 쿼리 언어로, 테이블을 기준으로 쿼리 하는 것이 아닌, Entity 객체를 대상으로 질의 하는 언어다
  • SQL 을 추상화해서 특정 데이터베이스의 방언에 제약없이 사용이 가능하다(의존성이 적다)
  • 그러나 최종적으로 목적지인 데이터베이스의 방언에 맞춰 SQL로 변환된다.

JPQL 문법

select_문 :: =
	select_절
	from_절
	[where_절]
	[groupby_절]
	[having_절]
	[orderby_절]
update_문::=update_절 [where_절]
delete_문::=delete_절 [where_절]
  • select m from Memeber as m where m.age > 18
  • 엔티티와 속성은 대소문자를 구분한다(Member, age)
  • JPQL 키워드는 대소문자 구분하지 않는다(SELECT, FROM, where)
  • 엔티티 이름 사용, 테이블 이름이 아니다.
  • 별칭(m)은 필수(as는 생략가능)

집합과 정렬

select
	COUNT(m), 
	SUM(m.age),
	AVG(m.age),
	MAX(m.age),
	MIN(m.age)
from Member m
  • GROUP BY, HAVING : SQL 과 동일
  • ORDER BY : SQL 과 동일

TypeQuery , Query

  • TypeQuery : 반환 타입이 명확할 때 사용
TypedQuery<Member> query = em.createQuery("SELECT m FROM Member m", Member.class)
  • Query : 반환 타입이 명확하지 않을 때 사용
Query query = em.createQuery("SELECT m.username, m.age FROM Member m")

결과 조회 API

  • query.getResultList() : 결과가 하나 이상 일 때, 리스트 반환
    • 결과가 없으면 빈 리스트(빈 컬렉션이므로 에러가 나올 상황이 아님)
  • query.getSingleResult() : 결과가 정확히 하나, 단일 객체 반환
    • 결과가 없다 : javax.persistence.NoResultException
    • 둘 이상이면 : javax.persistence.NoUniqueResultException
    • 따라서 반드시 조건을 작성할 때 한 개가 될 수 있도록 해야 한다.
    • 이러한 구조가 아무래도 논란(?) 일 수 있는게, 조건에 맞지 않다고 에러가 아니고 결과가 없을 뿐인데 예외가 발동된다는 것은 애매할 수 있다. 이에 Spring Data JPA에서는 내부적으로 이를 처리하고 null 또는 Optional 로 처리한다.

Parameter 바인딩 - 이름 기준, 위치 기준

// 이름 기준 
Query query = "SELECT m FROM Member m where m.username=:username";
query.setParameter("username", usernameParam);
// 위치 기준
Query query = "SELECT m FROM Member m wher m.username=?1";
query .setParameter(1, usernameParam);
  • 가능하면 위치 기준은 쓰지 말 것. 왜냐하면 사용 도중 중간에 무언가 끼면 순서가 일괄 밀리는 등 골치 아플 수 있다.

객체지향 쿼리 언어 1 - 기본문법 : 프로젝션(SELECT)

프로젝션

  • SELECT 절에 조회할 대상을 지정하는 것
  • 프로젝션 대상 : Entity, Embedded Type, Scala Type(숫자, 문자 등 기본 데이터 타입)
  • SELECT m FROM Member m : 엔티티 프로젝션
  • SELECT m.team FROM Member m : 엔티티 프로젝션 (묵시적 조인)
    • SELECT t FROM Member m JOIN m.team t : 성능적인 부분을 고려하여 SQL 식으로 표현하여 받아 오는게 낫다. (명시적 조인)
    • 이렇게 굳이 해야 하는 이유는 내가 작성한 JPQL이 SQL로 정확하게 바뀌는지 확인이 안되고, 이러한 지점은 모르는 채 더 많은 혹은 해괴한 SQL로의 번역이 발생할 수 있기 때문이다.
  • SELECT m.address FROM Member m : 임베디드 타입 프로젝션
  • SELECT m.username, m.age FROM Member m -> 스칼라 타입 프로젝션
  • DISCTINCT 로 중복 제거
    • SELECT DISTINCT m.username, m.age FROM Member m
  • 당연한 말이겠지만, 엔티티 프로젝션의 경우 영속성 컨텍스트에 들어가서 그 데이터의 숫자가 많든 작든 모두 영속성 관리에 들어간다.

프로젝션 - 여러 값 조회

  • SELECT m.username, m.age FROM Member m
    • Query 타입으로 조회 
      List resultList = em.createQuery("select m.username, m.age from Mmember m").getResultList();
Object o = resultList.get(0);
Object[] result = (Object[])o;
System.out.println("username : " + result[0]);
System.out.println("age : " + result[1]);
    • Query[] 타입으로 조회 
      List<Object[]> resultList = em.createQuery("select m.username, m.age from Mmember m").getResultList();
Object[] result = resultList.get(0);
System.out.println("username : " + result[0]);
System.out.println("age : " + result[1]);
    • new 명령어로 조회⭐(제일 효과적이고 깔끔한 방법)
      • 단순 값을 DTO로 바로 조회 : SELECT new jpabook.jpql.UserDTO(m.username, m.age) FROM Member m
      • 패키지 명을 포함한 전체 클래스 명 입력 필요
      • 순서와 타입이 일치하는 생성자 필요
      • 서버 차원에서 API로 왔다갔다 하는 동안, 데이터의 특정 형태로 재변환, 한번에 요청할 때 사용하기 편리하게 적용 가능하다.

객체지향 쿼리 언어 1 - 기본문법 : 페이징

페이징 API

  • JPA는 페이징을 두개의 API로 추상화 한다.
  • setFirstResult(int startPosition) : 조회 시작 위치(0부터 시작)
  • setMaxResults(int maxResult) : 조회할 데이터 수
// 페이징 쿼리
String jpql = "select m from Member m order by m.name desc";
List<Member> resultList = em.createQuery(jpql, Member.class)
	.setFirstResult(10)
	.setMaxResults(20)
	.getResultList();

JPA API 기준으로 최초의 방식이라고 생각하면 된다. Spring Data JPA에서 사용될 때는 Pageable 객체를 통해 사용하는 것이 낫다.

객체지향 쿼리 언어 1 - 기본문법 : 조인

조인

  • 내부 조인 : SELECT m FROM Member m [INNER] JOIN m.team t
    • INNER 는 생략 가능
  • 외부 조인 : SELECT m FROM Member m LEFT [OUTER] JOIN m.team t
    • OUTER 는 생략 가능
  • 세타 조인 : select count(m) from Member m, Team t where m.username = t.name (연관관계가 없어도 조인이 필요할 시)
조인 기초 개념을 알아보자 
1. **내부 조인 (Inner Join)**:
    - 두 테이블의 공통된 데이터만을 결과로 반환한다.
    - 지정한 조건에 만족하는 레코드만을 선택한다.
    - 가장 흔히 사용되는 조인 유형으로, 조인 조건에서 일치하는 행만 포함된다.
2. **외부 조인 (Outer Join)**:
    - 특정 테이블의 모든 레코드와 다른 테이블에서 조인 조건에 일치하는 레코드를 결합한다.
    - 외부 조인은 다시 세 가지 유형으로 나누어진다. : 
	    - 왼쪽 외부 조인(Left Outer Join)
	    - 오른쪽 외부 조인(Right Outer Join)
	    - 전체 외부 조인(Full Outer Join).
    - 왼쪽 또는 오른쪽 테이블의 모든 데이터를 포함하고, 상대 테이블에서는 매칭되는 데이터만 포함한다.
3. **세타 조인 (Theta Join)**:
    - 두 테이블 간의 임의의 조건을 사용하여 조인하는 방식이다.
    - 내부 조인과 유사하지만, 일반적으로 등호(=) 이외의 다른 비교 연산자(>, <, != 등)를 사용하는 조인을 가리킬 때 사용한다.
    - 복잡한 조건을 사용한 조인에서 주로 활용된다.

조인 - ON절

  • ON 절을 활용한 조인(JPA 2.1부터 지원)
      1. 조인 대상 필터링
      1. 연관관계 없는 엔티티 외부 조인(하이버네이트 5.1 부터)

1. 조인 대상 필터링

  • 예시 ) 회원과 팀을 조인하면서, 팀 이름이 A인 팀만 조인
  • JPQL : SELECT m, t FROM Member m LEFT JOIN m.team t on t.name = 'A'
  • SQL : SELECT m.*, t.* FROM Member m LEFT JOIN Team t ON m.TEAM_ID=t.id and t.name = 'A'

2. 연관관계 없는 엔티티 외부 조인

  • 예시 ) 회원의 이름과 팀 이름이 같은 대상 외부 조인
  • JPQL : SELECT m, t FROM Member m LEFT JOIN Team t on m.username = t.name
  • SQL : SELECT m.*, t.* FROM Member m LEFT JOIN Team t ON m.username = t.name

객체지향 쿼리 언어 1 - 기본문법 : 서브 쿼리

서브 쿼리

  • 서브 쿼리란? : 쿼리 내부에 추가적인 쿼리를 통해 조건 등을 구체화하는 것이 가능한 내부 쿼리를 말한다.
  • 나이가 평균보다 많은 회원 :
    • select m from Member m where m.age > (select avg(m2.age) from Member m2
    • m2로 새롭게 정의내려서 메인 쿼리와 서브 쿼리의 관계가 없도록 만들어야 성능적으로 우위에 있게 된다.
  • 한 건이라도 주문한 고객 :
    • select m from Member m where (select count(o) from Order o where m = o.member) > 0
    • 이 SQL에서 m을 끌고 오는 이러한 구조는 SQL 처럼 성능적으로 좋지 못할 수 있다.

서브 쿼리 지원 함수

  • [NOT] EXISTS (subquery): 서브쿼리에 결과가 존재하면 참
    • {ALL|ANY|SOME} (subquery)
    • ALL 모두 만족하면 참
    • ANY, SOME : 같은 의미, 조건을 하나라도 만족하면 참
  • [NOT] IN (subquery) : 서브쿼리의 결과 중 하나라도 같은 것이 있으면 참

서브쿼리 - 예제

  • 팀A 소속인 회원
    • select m fromn Member m where exists (select t from m.team t where t.name = '팀A')
  • 전체 상품 각각의 재고보다 주문량이 많은 주문들
    • select o from Order o where o.orderAmount > ALL (select p.stockAmount from Product p
  • 어느 팀이든 팀에 소속된 회원
    • select m from Member m where m.team = ANY (select t from Team t)

JPA 서브 쿼리의 한계

  • JPA 는 WHERE, HAVING 절에서만 서브 쿼리 사용 가능
  • SELECT 절도 가능(하이버네이트에서 지원)
  • FROM 절의 서브쿼리는 현재 JPQL 에서 불가능
    • 조인으로 풀수 있으면 풀어서 해결

객체지향 쿼리 언어 1 - 기본문법 : JPQL 타입 표현과 기타식

JPQL 타입 표현

  • 문자: ‘HELLO’, ‘She’, ‘s’
  • 숫자: 10L(Long), 10D(Double), 10F(Float)
  • Boolean : TRUE, FALSE
  • enum : 풀 패키지명 포함 enum 명
  • Entity : TYPE(m) = Member(상속 관계에서 사용)

JPQL 기타

  • SQL과 문법이 같은 식
  • EXISTS, IN
  • AND, OR, NOT,
  • =, >=, <=, >, <,<>
  • BETWEEN, LIKE, IS NULL

객체지향 쿼리 언어 1 - 기본문법 : 조건식(CASE 등)

조건식 - CASE 식

  • 기본 CASE 식 :
select 
	case when m.age <= 10 then '학생요금'
		 when m.age >= 60 then '경로요금'
		 else '일반요금'
	end
from Member m
  • 단순 CASE 식 :
select 
	case t.name 
		when '팀A' then '인센티브110%'
		when '팀B' then '인센티브120%'
		else '인센티브105%'
	end
from Team t
  • COALESCE : 하나 씩 조회해서 null이 아니면 반환
    • 예시 : 사용자 이름이 없으면 이름이 없는 회원을 반환
    • select coalesce(m.username, '이름 없는 회원') from Member m
  • NULLIF : 두 값이 같으면 null 반환, 다르면 첫번째값 반환
    • 예시 : 사용자 이름이 관리자면 null을 반환하고 나머지는 본인 의 이름을 반환
    • select NULLIF(m.username, '관리자') from Member m

객체지향 쿼리 언어 1 - 기본문법 : JPQL 함수

JPQL 기본함수

  • CONCAT : select concat(m.name, m.age) From Member m 문자열 합치기
    • 사용은 대부분 비슷하니 확인해보고 적용하면 된다~
  • SUBSTRING : 하위 문자열 생성
  • TRIM : 공백 자르기
  • LOWER
  • UPPER
  • LENGTH
  • LOCATE
  • ABS, SQRT, MOD
  • SIZE, INDEX(JPA용도)
  • 다행이도 데이터베이스 종속적이긴 하나 기본 함수 외에도 꽤나 많은 함수들이 등록되어 있고, 이를 찾아 들어가서 확인해보면서 사용을 하면 된다(다소 방언으로 인한 차이가 있을 수 있다.)

사용자 정의 함수 호출

  • 하이버네이트 사용 전 방언에 추가해야한다.
    • 사용하는 DB 방언을 상속받고, 사용자 정의 함수를 등록하면된다.
    • 이때 중요한건 JPA설정에서 내가 상속받아 커스텀한 나의 Dialect를 설정해줘야 실제로 내가 만든 커스텀 함수를 쓸 수 있다.
    • select function( 'group_concat', i.name) from Item i