[JPA/Hibernate] persistence.xml 설정 방법

[JPA/Hibernate] persistence.xml 설정 방법

JPA 2.1
hibernate-entitymanager 4.3.10.Final

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="simple-jpa-application">
        <properties>
            <!-- 속성 설정 -->
        </properties>
    </persistence-unit>
</persistence>

persistence.xml은 <persistence>로 시작하며 xmlns에 네임 스페이스, version에 사용할 JPA 버전을 지정한다.

<persistence-unit>의 name에 unit의 고유한 이름을 설정한다. 일반적으로 연결할 데이터베이스당 하나의 persistence unit을 등록한다.

그리고 <properties> 아래에 JPA 표준 속성과 하이버네이트 속성을 설정한다.

 

필수 속성

일반적으로 JPA를 사용할때 설정해야할 필수 속성은 다음과 같다.

 

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence"
             version="2.1">
    <persistence-unit name="simple-jpa-application">
        <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"/>
        </properties>
    </persistence-unit>
</persistence>

 

name이 javax.persistence로 시작하는 속성은 JPA 표준 속성이다.

hibernate로 시작하는 속성은 하이버네이트 전용 속성이다.

javax.persistence.jdbc.driver, user, password, url에 데이터베이스 연결 정보를 설정하고 hirbernate.dialect에 데이터베이스 dialect를 설정한다.

위에서 설정한 값인 org.hibernate.dialect.H2Dialect는 데이터베이스 dialect를 H2로 설정한 것이다.

하이버네이트는 다양한 데이터베이스의 dialect 클래스를 제공하므로 사용하는 DB의 dialect 클래스를 설정한다.

예를 들어 Oracle 10g를 사용한다면 org.hibernate.dialect.Oracle10gDialect로 설정하면 된다.

 

옵션

<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence"
             version="2.1">
    <persistence-unit name="simple-jpa-application">
        <properties>
            <!-- 필수 속성 -->
            ...


            <!-- 옵션 -->
            <!-- 콘솔에 하이버네이트가 실행하는 SQL문 출력 -->
            <property name="hibernate.show_sql" value="true"/>
            <!-- SQL 출력 시 보기 쉽게 정렬 -->
            <property name="hibernate.format_sql" value="true"/>
            <!-- 쿼리 출력 시 주석(comments)도 함께 출력 -->
            <property name="hibernate.use_sql_comments" value="true"/>
            <!-- JPA 표준에 맞춘 새로운 키 생성 전략 사용 -->
            <property name="hibernate.id.new_generator_mappings" value="true"/>
            <!-- 애플리케이션 실행 시점에 데이터베이스 테이블 자동 생성 -->
            <property name="hibernate.hbm2ddl.auto" value="create"/>
            <!-- 이름 매핑 전략 설정 - 자바의 카멜 표기법을 테이블의 언더스코어 표기법으로 매핑
             ex) lastModifiedDate -> last_modified_date -->
            <property name="hibernate.ejb.naming_strategy" value="org.hibernate.cfg.ImprovedNamingStrategy"/>
        </properties>
    </persistence-unit>
</persistence>

 

표 - hibernate.hbm2ddl.auto 속성

옵션	설명
create	DROP + CREATE 기존 테이블을 삭제하고 새로 생성한다.
create-drop	DROP + CREATE + DROP create 속성에 추가로 애플리케이션을 종료할 때 생성한 DDL을 제거한다.
update	데이터베이스 테이블과 엔티티 매핑정보를 비교해서 변경 사항만 수정한다.
validate	데이터베이스 테이블과 엔티티 매핑정보를 비교해서 차이가 있으면 경고를 남기고 애플리케이션을 실행하지 않는다. 이 옵션은 DDL을 수정하지 않는다.
none	스키마 자동 생성 기능을 사용하지 않는다. hibernate.hbm2ddl.auto 속성을 삭제한 것과 동일하다.

📝 추천 전략

개발 초기 단계 : create 또는 update
테스트 서버 : update 또는 validate
운영 서버 : validate 또는 none

 

Entity Class(엔티티 클래스) 설정

JPA 구현체들은 보통 엔티티 클래스를 자동으로 인식하지만 환경에 따라 인식하지 못할 때도 있다. 그때는 <class>에 엔티티 클래스를 설정해준다.

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence"
             version="2.1">
    <persistence-unit name="simple-jpa-application">
        <!-- 엔티티 클래스 -->
        <class>com.atoz_develop.Member</class>
        
        <properties>
            <!-- 필수 속성 -->
            ...

 

References

📖 자바 ORM 표준 JPA 프로그래밍(에이콘, 2015, 김영한)