[JPA] 자바 ORM 표준 JPA 프로그래밍 2장

xyzw·2023년 5월 20일
0

Spring

목록 보기
9/22

2.1 이클립스 설치와 프로젝트 불러오기

책에서는 이클립스를 사용하지만, 인텔리제이에서 프로젝트를 진행하겠다.

  1. https://github.com/holyeye/jpabook 에서 예제 프로젝트(jpabook-master)를 내려받고 압축을 해제한다.
  2. 생성된 폴더(jpabook-master)를 IntelliJ 워크스페이스 폴더 아래로 옮긴다.
  3. IntelliJ에서 파일>열기...를 클릭한 후 jpabook-master 폴더를 선택한다.



2.2 H2 데이터베이스 설치

설치가 필요 없고 용량도 작은 H2 데이터베이스를 사용한다. H2 데이터베이스는 자바가 설치되어 있어야 동작한다.

https://h2database.com 에 들어가서 All Platforms zip파일을 다운받는다.
압축을 풀고 /bin/h2.bat 파일을 실행하여 h2 데이터베이스를 서버 모드로 실행한다. 이때 자동으로 브라우저에서 h2 데이터베이스 로그인 화면이 나오지 않는다면, http://localhost:8082를 입력하여 접속하자.

로그인 화면에서 다음과 같이 입력한다.

  • 드라이버 클래스: org.h2.Driver
  • JDBC URL: jdbc:h2:tcp://localhost/~/test
  • 사용자명: sa
  • 비밀번호: 입력하지 않는다.

그리고 연결 버튼을 눌러 test라는 이름의 데이터베이스에 서버 모드로 접근한다.

다음 SQL을 입력하고 실행 버튼을 눌러 MEMBER 테이블을 생성한다.

CREATE TABLE MEMBER(
    ID VARCHAR(255) NOT NULL,
    NAME VARCHAR(255),
    AGE INTEGER NOT NULL,
    PRIMARY KEY(ID)
);


2.3 라이브러리와 프로젝트 구조

메이븐

pom.xml에 사용할 라이브러리를 적어주면 라이브러리를 자동으로 내려받아서 관리해준다.

pom.xml

<dependencies>는 사용할 라이브러리를 지정하는 부분이다. groupId, artifactId, version만 적어주면 라이브러리를 메이븐 공식 저장소에서 내려받아 라이브러리에 추가해준다.

JPA에 하이버네이트 구현체를 사용하기 위해 필요한 많은 라이브러리 중 핵심은 JPA, 하이버네이트와 H2 데이터베이스이다.

  • JPA, 하이버네이트: JPA 표준과 하이버네이트를 포함하는 라이브러리이다. hibernate-entitymanager를 라이브러리로 지정하면 hibernate-core.jar, hibernate-jpa-2.1-api.jar도 함께 내려받는다.
  • H2 데이터베이스: H2 데이터베이스에 접속하기 위한 라이브러리이다.
<dependencies>
	<!-- JPA, 하이버네이트 -->
	<dependency>
		<groupId>org.hibernate</groupId>
		<artifactId>hibernate-entitymanager</artifactId>
		<version>${hibernate.version}</version>
	</dependency>
	<!-- H2 데이터베이스 -->
	<dependency>
		<groupId>com.h2database</groupId>
		<artifactId>h2</artifactId>
		<version>${h2db.version}</version>
	</dependency>
</dependencies>


2.4 객체 매핑 시작

JPA를 사용하려면 먼저 회원 클래스와 회원 테이블을 매핑해야 한다.

매핑 정보회원 객체회원 테이블
클래스와 테이블MemberMEMBER
기본 키idID
필드와 컬럼usernameNAME
필드와 컬럼ageAGE

애플리케이션에서 사용할 회원 클래스를 만든다.

@Entity
@Table(name="MEMBER")
public class Member {

    @Id
    @Column(name = "ID")
    private String id;

    @Column(name = "NAME")
    private String username;

    private Integer age;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

어노테이션

  • @Entity
    이 클래스를 테이블과 매핑한다고 JPA에게 알려준다. 이렇게 @Entity가 사용된 클래스를 엔티티 클래스라 한다.
  • @Table
    엔티티 클래스에 매핑할 테이블 정보를 알려준다. 여기서는 name 속성을 사용해서 Member 엔티티를 MEMBER 테이블에 매핑했다. 이 어노테이션을 생략하면 클래스 이름을 테이블 이름으로 매핑한다.
  • @Id
    엔티티 클래스의 필드를 테이블의 기본 키에 매핑한다. 여기서는 엔티티의 id 필드를 테이블의 ID 기본 키 컬럼에 매핑했다. 이렇게 @Id가 사용된 필드를 식별자 필드라 한다.
  • @Column
    필드를 컬럼에 매핑한다. 여기서는 name 속성을 사용해서 Member 엔티티의 username 필드를 MEMBER 테이블의 NAME 컬럼에 매핑했다.
  • 매핑 정보가 없는 필드
    age 필드에는 매핑 어노테이션이 없다. 이렇게 매핑 어노테이션을 생략하면 필드명을 사용해서 컬럼명으로 매핑한다. 여기서는 age이므로 age 컬럼명으로 매핑했다. 만약 대소문자를 구분하는 데이터베이스를 사용하면 @Column(name="AGE")처럼 명시적으로 매핑해야 한다.



2.5 persistence.xml 설정

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


XML 네임스페이스와 사용할 버전을 지정한다.
JPA 2.1을 사용하려면 xmlns와 version을 명시하면 된다.

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

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

<persistence-unit name="jpabook">

필수 속성

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

데이터베이스 방언

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

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

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

하이버네이트가 제공하는 대표적인 데이터베이스 방언

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


2.6 애플리케이션 개발

애플리케이션을 시작하는 코드

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) {...}
}

엔티티 매니저 설정

엔티티 매니저 팩토리 설정

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

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

이는 이름이 jpabook인 영속성 유닛을 찾아서 엔티티 매니저 팩토리를 생성한다.

이때 persistence.xml의 설정 정보를 읽어서 JPA를 동작시키기 위한 기반 객체를 만들고 JPA 구현체에 따라서는 데이터베이스 커넥션 풀도 생성하므로
엔티티 매니저 팩토리를 생성하는 비용은 아주 크다.

따라서 엔티티 매니저 팩토리는 애플리케이션 전체에서 딱 한 번만 생성하고 공유해서 사용해야 한다.

엔티티 매니저 생성

EntityManager em = emf.createEntityManager(); 

엔티티 매니저 팩토리에서 엔티티 매니저를 생성한다. JPA의 기능 대부분은 이 엔티티 매니저가 제공한다.

대표적으로 엔티티 매니저를 사용해서 엔티티를 데이터베이스에 등록/수정/삭제/조회할 수 있다.

엔티티 매니저는 내부에 데이터소스(데이터베이스 커넥션)를 유지하면서 데이터베이스와 통신한다. 따라서 애플리케이션 개발자는 엔티티 매니저를 가상의 데이터베이스로 생각할 수 있다.

참고로 엔티티 매니저는 데이터베이스 커넥션과 밀접한 관계가 있으므로 스레드 간에 공유하거나 재사용하면 안 된다.

종료

마지막으로 사용이 끝난 엔티티는 em.close();처럼 반드시 종료해야 한다.

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

트랜잭션 관리

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

EntityTransaction tx = em.getTransaction(); //트랜잭션 API

try {
    tx.begin(); //트랜잭션 시작
    logic(em);  //비즈니스 로직
    tx.commit();//트랜잭션 커밋

} catch (Exception e) {
    e.printStackTrace();
    tx.rollback(); //예외 발생 시 트랜잭션 롤백
} 

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

비즈니스 로직

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

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
members.size=1

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

등록

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

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

수정

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

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

삭제

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

DELETE FROM MEMBER WHERE ID='id1';

한 건 조회

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

SELECT * FROM MEMBER WHERE ID='id1';

JPQL

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

List<Member> members = em.createQuery("select m from Member m", Member.class).getResultList();

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

문제는 검색 쿼리다. JPA는 엔티티 객체를 중심으로 개발하므로 검색을 할 때도 테이블이 아닌 엔티티 객체를 대상으로 검색해야 한다.

그런데 테이블이 아닌 엔티티 객체를 대상으로 검색하려면 데이터베이스의 모든 데이터를 애플리케이션으로 불러와서 엔티티 객체로 변경한 다음 검색해야 하는데, 이는 사실상 불가능하다.

애플리케이션이 필요한 데이터만 데이터베이스에서 불러오려면 결국 검색 조건이 포함된 SQL을 사용해야 한다. JPA는 JPQL이라는 쿼리 언어로 이런 문제를 해결한다.


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

  • JPQL은 엔티티 객체를 대상으로 쿼리한다. 즉, 클래스와 필드를 대상으로 쿼리한다.
  • SQL은 데이터베이스 테이블을 대상으로 쿼리한다.

참고로 JPQL은 대소문자를 명확하게 구분한다.


목록 조회 예제에서 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

0개의 댓글