4. JPA 시작(2)

4. persistence.xml 설정

JPA는 persistence.xml을 사용해서 필요한 설정 정보를 관리한다. 이 설정 파일이 META-INF/persistence.xml 클래스 패스 경로에 있으면 별도의 설정 없이 JPA가 인식할 수 있다.

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence" version="2.1">

    <persistence-unit name="jpabook">

        <properties>

            <!-- 필수 속성 -->
            <property name="javax.persistence.jdbc.driver" value="org.h2.Driver"/>
            <property name="javax.persistence.jdbc.user" value="sa"/>
            <property name="javax.persistence.jdbc.password" value=""/>
            <property name="javax.persistence.jdbc.url" value="jdbc:h2:tcp://localhost/~/test"/>
            <property name="hibernate.dialect" value="org.hibernate.dialect.H2Dialect" />

            <!-- 옵션 -->
            <property name="hibernate.show_sql" value="true" />
            <property name="hibernate.format_sql" value="true" />
            <property name="hibernate.use_sql_comments" value="true" />
            <property name="hibernate.id.new_generator_mappings" value="true" />

            <!--<property name="hibernate.hbm2ddl.auto" value="create" />-->
        </properties>
    </persistence-unit>

</persistence>

위 예제의 persistence.xml 내용을 차근차근 분석해보자.

<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence" version="2.1">

설정파일은 persistence로 시작한다. 이곳에 XML 네임스페이스와 사용할 버전을 지정한다. JPA 2.1을 사용하려면 이 xmlns와 version을 명시하면 된다.

<persistence-unit name="jpabook">

JPA 설정은 영속성 유닛(persistence-unit)이라는 것부터 시작하는데 일반적으로 연결할 데이터베이스당 하나의 영속성 유닛을 등록한다. 그리고 영속성 유닛에는 고유한 이름을 부여해야 하는데 여기서는 jpabook이라는 이름을 사용했다.

다음으로 설정한 각각의 속성 값을 분석해보자.

<properties>

    <!-- 필수 속성 -->
    <property name="javax.persistence.jdbc.driver" value="org.h2.Driver"/>
    ...

사용한 속성은 다음과 같다.

• JPA 표준 속성
  - javax.persistence.jdbc.driver:JDBC 드라이버

  • javax.persistence.jdbc.user: 데이터베이스 접속 아이디
  • javax.persistence.jdbc.password : 데이터베이스 접속 비밀번호
  • javax.persistence.jdbc.url : 데이터베이스 접속 URL

• 하이버네이트 속성
  - hibernate.dialect : 데이터베이스 방언(Dialect) 설정

이름이 javax.persistence로 시작하는 속성은 JPA 표준 속성으로 특정 구현체에 종속되지 않는다. 반면에 hibernate로 시작하는 속성은 하이버네이트 전용 속성이므로 하이버네이트에서만 사용할 수 있다.

사용한 속성을 보면 데이터베이스에 연결하기 위한 설정이 대부분이다. 여기서 가장 중요한 속성은 데이터베이스 방언을 설정하는 hibernate.dialect다.

1. 데이터베이스 방언

JPA는 특정 데이터베이스에 종속적이지 않은 기술이다. 따라서 다른 데이터베이스로 손쉽게 교체할 수 있다. 그런데 각 데이터베이스가 제공하는 SQL 문법과 함수가 조금씩 다르다는 문제점이 있다. 예를 들어 데이터베이스마다 다음과 같은 차이점이 있다.

• 데이터 타입 : 가변 문자 타입으로 MySQL은 VARCHAR, 오라클은 VARCHAR2를 사용한다.
• 다른 함수명 : 문자열을 자르는 함수로 SQL 표준은 SUBSTRING()를 사용하지만 오라클은 SUBSTR()을 사용한다.
• 페이징 처리 : MySQL은 LIMIT을 사용하지만 오라클은 ROWNUM을 사용한다.

이처럼 SQL 표준을 지키지 않거나 특정 데이터베이스만의 고유한 기능을 JPA에서는 방언(Dialect)라고 한다. 애플리케이션 개발자가 특정 데이터베이스에 종속되는 기능을 많이 사용하면 나중에 데이터베이스를 교체하기가 어렵다. 하이버네이트를 포함한 대부분의 JPA 구현체들은 이런 문제를 해결하려고 다양한 데이터베이스 방언 클래스를 제공한다.

아래 그림을 보자. 개발자는 JPA가 제공하는 표준 문법에 맞추어 JPA를 사용하면 되고, 특정 데이터베이스에 의존적인 SQL은 데이터베이스 방언이 처리해준다. 따라서 데이터베이스가 변경되어도 애플리케이션 코드를 변경할 필요 없이 데이터베이스 방언만 교체하면 된다. 참고로 데이터베이스 방언을 설정하는 방법은 JPA에 표준화되어 있지 않다.

하이버네이트는 다양한 데이터베이스 방언을 제공한다. 대표적인 것만 살펴보자.

• H2 : org.hibernate.dialect.H2Dialect
• 오라클 10g : org.hibernate.dialect.Oracle10gDialect
• MySQL : org.hibernate.dialect.MySQL5InnoDBDialect

여기서는 H2 데이터베이스를 사용하므로 Hibernate.dialect 속성을 org.hibernate.dialect.H2Dialect로 설정했다.

하이버네이트는 현재 45개의 데이터베이스 방언을 지원한다. 상세 항목은 다음 URL을 참고하자.
https://docs.jboss.org/hibernate/orm/4.3/manual/en-US/html_single/#configuration-optional-dialects

지금까지 persistence.xml 설정을 살펴보았다. 이제 이 정보를 바탕으로 실제 JPA를 사용해보자.

사용된 하이버네이트 전용 속성은 다음과 같다.

• hibernate.show_sql : 하이버네이트가 실행한 SQL을 출력한다.
• hibernate.format_sql : 하이버네이트가 실행한 SQL을 출력할 때 보기 쉽게 정렬한다.
• hibernate.use_sql_comments : 쿼리를 출력할 때 주석도 함께 출력한다.
• hibernate.id.new_generator_mappings : JPA 표준에 맞춘 새로운 키 생성 전략을 사용한다.

JPA 구현체들은 보통 엔티티 클래스를 자동으로 인식하지만, 환경에 따라 인식하지 못할 때도 있다. 그때는 persistence.xml에 다음과 같이 <class>를 사용해서 JPA에서 사용할 엔티티 클래스를 지정하면 된다. 참고로 스프링 프레임워크나 J2EE 환경에서는 엔티티를 탐색하는 기능을 제공하므로 이런 문제가 발생하지 않는다.

<persistence-unit name="jpabook">
    <class>jpabook.start.Member</class>
    <properties>
    ...

5. 애플리케이션 개발

객체 매핑을 완료하고 persistence.xml로 JPA 설정도 완료했다. 이제 JPA 애플리케이션을 개발해보자. 아래 예제는 애플리케이션을 시작하는 코드다.

package jpabook.start;

import javax.persistence.*;
import java.util.List;

public class JpaMain {

    public static void main(String[] args) {

        //엔티티 매니저 팩토리 생성
        EntityManagerFactory emf = Persistence.createEntityManagerFactory("jpabook");
        EntityManager em = emf.createEntityManager(); //엔티티 매니저 생성

        EntityTransaction tx = em.getTransaction(); //트랜잭션 기능 획득

        try {
            tx.begin(); //트랜잭션 시작
            logic(em);  //비즈니스 로직
            tx.commit();//트랜잭션 커밋
        } catch (Exception e) {
            e.printStackTrace();
            tx.rollback(); //트랜잭션 롤백
        } finally {
            em.close(); //엔티티 매니저 종료
        }

        emf.close(); //엔티티 매니저 팩토리 종료
    }
    
    //비즈니스 로직
    public static void logic(EntityManager em) {...}
}

코드는 크게 3부분으로 나뉘어 있다.

• 엔티티 매니저 설정
• 트랜잭션 관리
• 비즈니스 로직

엔티티 매니저 설정부터 살펴보자.

1. 엔티티 매니저 설정

아래 그림을 보면서 엔티티 매니저의 생성 과정을 분석해보자.

엔티티 매니저 팩토리 생성

JPA를 시작하려면 우선 persistence.xml의 설정 정보를 사용해서 엔티티 매니저 팩토리를 생성해야 한다. 이때 Persistence 클래스를 사용하는데 이 클래스는 엔티티 매니저 팩토리를 생성해서 JPA를 사용할 수 있게 준비한다.

EntityManagerFactory emf = Persistence.createEntityManagerFactory("jpabook");

이렇게 하면 META-INF/persistence.xml에서 이름이 jpabook인 영속성 유닛(persistence-unit)을 찾아서 엔티티 매니저 팩토리를 생성한다. 이때 persistence.xml의 설정 정보를 읽어서 JPA를 동작시키기 위한 기반 객체를 만들고 JPA 구현체에 따라서는 데이터베이스 커넥션 풀도 생성하므로 엔티티 매니저 팩토리를 생성하는 비용은 아주 크다. 따라서 엔티티 매니저 팩토리는 애플리케이션 전체에서 딱 한 번만 생성하고 공유해서 사용해야 한다.
엔티티 매니저 팩토리를 만들었으니 이제 엔티티 매니저를 생성하자.

엔티티 매니저 생성

EntityManager em = emf.createEntityManager();

엔티티 매니저 팩토리에서 엔티티 매니저를 생성한다. JPA의 기능 대부분은 이 엔티티 매니저가 제공한다. 대표적으로 엔티티 매니저를 사용해서 엔티티를 데이터베이스에 등록/수정/삭제/조회할 수 있다. 엔티티 매니저는 내부에 데이터소스(데이터베이스 커넥션)를 유지하면서 데이터베이스와 통신한다. 따라서 애플리케이션 개발자는 엔티티 매니저를 가상의 데이터베이스로 생각할 수 있다.
참고로 엔티티 매니저는 데이터베이스 커넥션과 밀접한 관계가 있으므로 스레드간에 공유하거나 재사용하면 안 된다.

종료

마지막으로 사용이 끝난 엔티티 매니저는 다음처럼 반드시 종료해야 한다.

em.close();  //엔티티 매니저 종료

애플리케이션을 종료할 때 엔티티 매니저 팩토리도 다음처럼 종료해야 한다.

emf.close();  //엔티티 매니저 팩토리 종료

2. 트랜잭션 관리

JPA를 사용하면 항상 트랜잭션 안에서 데이터를 변경해야 한다. 트랜잭션 없이 데이터를 변경하면 예외가 발생한다. 트랜잭션을 시작하라면 엔티티 매니저(em)에서 트랜잭션 API를 받아와야 한다. 아래 예제를 참고하자.

EntityTransaction tx = em.getTransaction();  //트랜잭션 API
try {
    tx.begin();     //트랜잭션 시작
    logic(em);      //비즈니스 로직 실행
    tx.commit();    //트랜잭션 커밋
} catch (Exception e) {
    tx.rollback();  //예외 발생 시 트랜잭션 롤백
}

트랜잭션 API를 사용해서 비즈니스 로직이 정상 동작하면 트랜잭션을 커밋(commit)하고 예외가 발생하면 트랜잭션을 롤백(rollback)한다.

3. 비즈니스 로직

비즈니스 로직은 단순하다. 아래 예제를 보자. 회원 엔티티를 하나 생성한 다음 엔티티 매니저를 통해 데이터베이스에 등록, 수정, 삭제, 조회한다.

public static void logic(EntityManager em) {

    String id = "id1";
    Member member = new Member();
    member.setId(id);
    member.setUsername("지한");
    member.setAge(2);
    
    //등록
    em.persist(member);
    
    //수정
    member.setAge(20);
    
    //한 건 조회
    Member findMember = em.find(Member.class, id);
    System.out.println("findMember=" + findMember.getUsername()
        + ", age=" + findMember.getAge();
    
    //목록 조회
    List<Member> members = em.createQuery("select m from Member m", Member.class).getResultList();
    System.out.println("members.size=" + members.size());
    
    //삭제
    em.remove(member);
}

출력 결과는 다음과 같다.

findMember=지한, age=20
member.size=1

비즈니스 로직을 보면 등록, 수정, 삭제, 조회 작업이 엔티티 매니저(em)를 통해서 수행되는 것을 알 수 있다. 엔티티 매니저는 객체를 저장하는 가상의 데이터베이스처럼 보인다. 먼저 등록, 수정, 삭제 코드를 분석해보자.

등록

String id = "id1";
Member member = new Member();
member.setId(id);
member.setUsername("지한");
member.setAge(2);

//등록
em.persist(member);

엔티티를 저장하려면 엔티티 매니저의 persist() 메소드에 저장할 엔티티를 넘겨주면 된다. 예제를 보면 회원 엔티티를 생성하고 em.persist(member)를 실행해서 엔티티를 저장했다. JPA는 회원 엔티티의 매핑 정보(어노테이션)을 분석해서 다음과 같은 SQL을 만들어 데이터베이스에 전달한다.

INSERT INTO MEMBER (ID, NAME, AGE) VALUES ('id1', '지한', 2)

수정

//수정
member.setAge(20);

수정 부분을 보면 조금 이상하다. 엔티티를 수정한 후에 수정 내용을 반영하려면 em.update() 같은 메소드를 호출해야 할 것 같은데 단순히 엔티티의 값만 변경했다. JPA는 어떤 엔티티가 변경되었는지 추적하는 기능을 갖추고 있다. 따라서 member.setAge(20)처럼 엔티티의 값만 변경하면 다음과 같은 UPDATE SQL을 생성해서 데이터베이스에 값을 변경한다. 사실 em.update()라는 메소드도 없다.

UPDATE MEMBER
    SET AGE=20, NAME='지한'
WHERE ID='id1'

삭제

em.remove(member);

엔티티를 삭제하려면 엔티티 매니저의 remove() 메소드에 삭제하려는 엔티티를 넘겨준다. JPA는 다음 DELETE SQL을 생성해서 실행한다.

DELETE FROM MEMBER WHERE ID = 'id1'

한 건 조회

//한 건 조회
Member findMember = em.find(Member.class, id);

find() 메소드는 조회할 엔티티 타입과 @Id로 데이터베이스 테이블의 기본 키와 매핑한 식별자 값으로 엔티티 하나를 조회하는 가장 단순한 조회 메소드다. 이 메소드를 호출하면 다음 SELECT SQL을 생성해서 데이터베이스에 결과를 조회한다. 그리고 조회한 결과 값으로 엔티티를 생성해서 반환한다.

SELECT * FROM MEMBER WHERE ID='id1'

4. JPQL

하나 이상의 회원 목록을 조회하는 다음 코드를 자세히 살펴보자.

//목록 조회
TypedQuery<Member> query = em.createQuery("select m from member m", Member.class);
List<Member> members = query.getResultList();

JPA를 사용하면 애플리케이션 개발자는 엔티티 객체를 중심으로 개발하고 데이터베이스에 대한 처리는 JPA에 맡겨야 한다. 바로 앞에서 살펴본 등록, 수정, 삭제, 한 건 조회 예를 보면 SQL을 전혀 사용하지 않았다. 문제는 검색 쿼리다. JPA는 엔티티 객체를 중심으로 개발하므로 검색을 할 때도 테이블이 아닌 엔티티 객체를 대상으로 검색해야 한다.

그런데 테이블이 아닌 엔티티 객체를 대상으로 검색하려면 데이터베이스의 모든 데이터를 애플리케이션으로 불러와서 엔티티 객체로 변경한 다음 검색해야 하는데, 이는 사실상 불가능하다. 애플리케이션이 필요한 데이터만 데이터베이스에서 불러오려면 결국 검색 조건이 포함된 SQL을 사용해야 한다. JPA는 JPQL(Java Persistence Query Language)이라는 쿼리 언어로 이런 문제를 해결한다.

JPA는 SQL을 추상화한 JPQL이라는 객체지향 쿼리 언어를 제공한다. JPQL은 SQL과 문법이 거의 유사해서 SELECT, FROM, WHERE, GROUP BY, HAVING, JOIN 등을 사용할 수 있다. 둘의 가장 큰 차이점은 다음과 같다.

• JPQL은 엔티티 객체를 대상으로 쿼리한다. 쉽게 이야기해서 클래스와 필드를 대상으로 쿼리한다.
• SQL은 데이터베이스 테이블을 대상으로 쿼리한다.

방금 본 목록 조회 예제에서 select m from Member m이 바로 JPQL이다. 여기서 from Member는 회원 엔티티 객체를 말하는 것이지 MEMBER 테이블이 아니다. JPQL은 데이터베이스 테이블을 전혀 알지 못한다.

JPQL을 사용하려면 먼저 em.createQuery(JPQL 반환 타입) 메소드를 실행해서 쿼리 객체를 생성한 후 쿼리 객체의 getResultList() 메소드를 호출하면 된다.

JPA는 JPQL을 분석해서 다음과 같은 적절한 SQL을 만들어 데이터베이스에서 데이터를 조회한다.

SELECT M.ID, M.NAME, M.AGE FROM MEMBER M

JPQL은 대소문자를 명확하게 구분하지만 SQL은 관례상 대소문자를 구분하지 않고 사용하는 경우가 많다.

6. 정리

JPA를 사용하기 위한 개발 환경을 설정하고 JPA를 사용해서 객체 하나를 테이블에 등록/수정/삭제/조회하는 간단한 애플리케이션을 만들어 보았다. JPA가 반복적인 JDBC API와 결과 값 매핑을 처리해준 덕분에 코드량이 상당히 많이 줄어든 것은 물론이고 심지어 SQL도 작성할 필요가 없었다. 하지만 코드량을 줄이고 SQL을 자동 생성하는 것은 JPA가 제공하는 전체 기능 중 일부에 불과하다. 다음 장을 통해 JPA의 핵심 기능인 영속성 관리에 대해 알아보자.

참고

• 자바 ORM 표준 JPA 프로그래밍