JPA 프로젝트

 

Spring Quick Start(책)의 Day5 class04~05 실습을 진행하면서 기록한 내용입니다.

실습한 코드의 링크입니다.

---

JPA란?

ORM 프레임워크들에 대한 표준화 작업의 결과가 JPA이다.

JPA(Java Persistence API)는 모든 ORM 구현체(ORM 프레임워크)들의 공통 인터페이스를 제공한다.

JDBC는 Oracle, Mysql, H2 등 특정 DBMS에 종속되지 않는 DB 연동 구현을 지원한다.

이와 마찬가지로 JPA API(javax.persistence)를 이용하면 개발 당시에는 Hibernate를 ORM 프레임워크로 사용하다가 실제 서비스가 시작될 때는 TopLink로 변경할 수 있다.

---

===== JPA 프로젝트 작성방법 =====

1. maven 프로젝트 생성

2. persistence.xml 파일이 생성

project structure > facet > JPA 추가 후 + 버튼 눌러서 persistence.xml 확인.

persistence.xml 파일이 생성된 것을 확인할 수 있다.

프로젝트폴더/META-INF/persistence.xml

3. pom.xml 파일에 JPA 관련 의존성 추가

        <!-- MySQL -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>
        <!-- JPA, 하이버네이트 -->
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-entitymanager</artifactId>
			<version>5.1.0.Final</version>
		</dependency>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.7</version>
			<scope>test</scope>
		</dependency>

4. Board 클래스 작성하기

JPA Entity 생성 기능이 intelliJ에는 있는지 모르겠으나

package com.springbook.biz.board;

import java.util.Date;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;

/**
 * Entity implementation class for Entity: Board
 *
 */
@Entity
@Table(name = "BOARD")
public class Board {
	@Id
	@GeneratedValue
	private int seq;
	private String title;
	private String writer;
	private String content;
	@Temporal(TemporalType.DATE)
	private Date regDate = new Date();
	private int cnt;

	// Getter/Setter/toString 메소드
}

어노테이션의 의미

어노테이션	의미
@Entity	@Entity가 설정된 클래스를 엔티티 클래스라고 하며, @Entity가 붙은 클래스는 테이블과 매핑된다.
@Table	엔티티와 관련된 테이블을 매핑한다. name 속성을 사용하여 BOARD 테이블과 매핑했는데 생략하면 클래스 이름이 테이블 이름과 매핑된다. name, catalog, schema, uniqueConstraints 등 다양하 속성이 있다.
@Id	엔티티 클래스의 필수 어노테이션으로서, 특정 변수를 테이블의 기본 키와 매핑한다. @Id 가 없는 엔티티 클래스는 JPA가 처리하지 못한다.
@Column	엔티티 클래스의 변수 이름과 table의 column이름이 다를 때 사용한다. name, nullable=false 등의 속성들이 있다.
@GeneratedValue	@Id가 선언된 필드에 기본 키를 자동으로 생성하여 할당할 때 사용한다. 다양한 옵션이 있지만 @GeneratedValue만 사용하면 데이터베이스에 따라서 자동으로 결정된다.
@Transient	엔티티 클래스 내의 특정 변수를 영속 필드에서 제외할 때 사용한다.
@Temporal	날짜 타입의 변수에 선언하여 날짜 타입을 매핑할 때 사용한다. TemporalType의 DATE, TIME, TIMESTAMP 중 하나를 선택할 수 있다.

5. persistence.xml 파일 작성하기

persistence.xml 은 JPA에서 메인 환경설정 파일이다.

META-INF 폴더 아래에 있으면 JPA가 인식한다.

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.1"
	xmlns="http://xmlns.jcp.org/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_2_1.xsd">
	<persistence-unit name="JPAProject">
		<class>com.springbook.biz.board.Board</class>
		<properties>
			<!-- DB 커넥션 -->
			<property name="javax.persistence.jdbc.driver" value="com.mysql.cj.jdbc.Driver" />
			<property name="javax.persistence.jdbc.user" value="jueun" />
			<property name="javax.persistence.jdbc.password" value="jueun" />
			<property name="javax.persistence.jdbc.url" value="jdbc:mysql://localhost:3306/springquickstart?serverTimezone=Asia/Seoul&amp;useSSL=false&amp;allowPublicKeyRetrieval=true" />
			<!-- Dialect 클래스 설정 -->
			<property name="hibernate.dialect" value="org.hibernate.dialect.MySQLDialect" />
			<!-- JPA 구현체 관련 속성 설정 -->
			<property name="hibernate.show_sql" value="true" />
			<property name="hibernate.format_sql" value="true" />
			<property name="hibernate.use_sql_comments" value="false" />
			<property name="hibernate.id.new_generator_mappings" value="true" />
			<property name="hibernate.hbm2ddl.auto" value="create" />
		</properties>
	</persistence-unit>
</persistence>

<persistance>: 루트 엘리먼트

<persistence-unit>: 영속성 유닛 설정. 영속성 유닛은 연동할 데이터베이스당 하나의 영속성 유닛을 사용한다.

<class>: 영속성 유닛 설정에서 가장 먼저 Entity class를 등록한다.

<properties>

<!-- DB 커넥션 -->

Entity class의 properties를 설정하는데 먼저 DB 커넥션을 설정했다.

<!-- Dialect 클래스 설정 -->

JPA는 최적화된 SQL을 제공하기 위해 DBMS마다 다른 Dialect 클래스를 제공하는데, 이를 설정했다.

<!-- JPA 구현체 관련 속성 설정 -->

속성	의미
hibernate.show_sql	생성된 SQL을 콘솔에 출력한다.
hibernate.format_sql	SQL을 출력할 때, 일정한 포맷으로 보기 좋게 출력한다.
shibernate.use_sql_comments	SQL에 포함된 주석도 같이 출력한다.
hibernate.id.new_generator_mappings	새로운 키 생성 전략을 사용한다.
hibernate.hbm2ddl.auto	테이블 생성이나 수정, 삭제 같은 DDL 구문을 자동으로 처리할지를

6. 클라이언트 프로그램

클라이언트 프로그램을 작성하고 실행해보자.

테이블이 아닌 엔티티 객체를 다루고 있다는 사실을 기억하자!

package com.springbook.biz.board;

import java.util.List;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.Persistence;

public class BoardServiceClient {
	public static void main(String[] args) {
		// EntityManagerFactory 객체로부터 EntityManager 객체 생성
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("JPAProject");
        EntityManager em = emf.createEntityManager();
		// EntityManager를 통해 Transaction 객체 생성
		EntityTransaction tx = em.getTransaction(); // 트랜잭션 제어
		try {
			// Transaction 시작
			tx.begin();
			Board board = new Board();
			board.setTitle("JPA 제목");
			board.setWriter("관리자");
			board.setContent("JPA 글 등록 잘 되네요.");

			// 글 등록
			em.persist(board);
            
			// 글 목록 조회
			String jpql = "select b from Board b order by b.seq desc";
			List<Board> boardList = em.createQuery(jpql, Board.class).getResultList();
			for (Board brd : boardList) {
				System.out.println("---> " + brd.toString());
			}
			// Transaction commit
			tx.commit();
		} catch (Exception e) {
			e.printStackTrace();
			// Transaction rollback
			tx.rollback();
		} finally {
			em.close();
		}
		emf.close();
	}
}

 

*EntityManager의 CRUD 메소드

EntityManager객체가 제공하는 CRUD 기능의 메소드이다.

메소드	기능 설명
persist(Object entity)	INSERT
merge(Object entity)	UPDATE
remove(Object entity)	DELETE
find(Object entity)	SELECTE ONE
createQuery(Object entity)	SELECT LIST

*JPQL

글 목록을 조회할 때, JPQL(Java Persistence Query Language)라는 JPA 고유의 쿼리 구문을 사용한다.

 

JPQL을 작성하고 실행하면, 하이버네이트 같은 JPA 구현체가 JPQL을 연동되는 DBMS에 맞게 적절한 SELECT 명령어로 변환한다.

예외가 발생한다면 트랜잭션을 롤백 처리하면 된다.

7. 실행결과

잘 된 다 !