Hibernateを使ったシンプルなJPA環境構築

Java Persistence API(JPA) とは

Java Persistence API(JPA) は Java の O/R マッピング標準 API。
概要は (日経BPの記事)が分かりやすい。
メリットは

オブジェクト指向で DB 開発がサクサクできる。
テーブルや制約などを自動的に作成できる。
オブジェクト・キャッシュの仕組みなどによって DB アクセスの負荷軽減・高速化が期待できる。

という点。デメリット(注意点)は

DB や SQL に関する知識が不要になるわけではない。
上手に DB 設計しないとメモリを馬鹿食いしたり、逆に性能低下で悩まされやすい。
エンティティ設計者は、どういうテーブル・制約・SQLが生成されるかを意識する必要がある。
ということで、開発者は既存の DB や SQL に加え、JPA に関する知識の習得を要求される。

といったところ。

デメリットに関しては一人、熟練技術者がいれば解決し、メリットだけを享受できるので、ぜひ「一家に一台」そういう技術者が欲しいところ。

概要

JPA 実装として代表的なのが Hibernate。最近だと EclipseLink(TopLink) も活気が出てきている。

実際の開発では Spring Framework や Seasar などの DI コンテナとともに使われることが多い Hibernate。
今回は Hibernate だけでシンプルな JPA 環境を構築する。

開発環境

項目	値
OS	Windows XP Pro SP2
IDE 環境	Eclipse 3.3.2(Preiades All in One)
Java	JDK 6 update 6
DB	PostgreSQL 8.3

まずは環境構築

Maven プロジェクト作成

まずは Eclipse 上で Maven プロジェクトを作成する。

[ファイル] メニュー ⇒ 新規 ⇒ プロジェクト
Maven ⇒ Maven Project。「New Manve Project」ダイアログが開く。
[次へ] ボタンを押す。
archetype 選択画面でそのまま [次へ] ボタンを押す。(maven-archetype-quickstart を選択)
グループId とアーティファクトID に test と入力して [終了]ボタンを押す。すると、 test プロジェクトが作成される。

Java コンパイラー準拠レベルの設定

Eclipse 上でプロジェクト名 test を右クリック ⇒ プロパティを選択。
左側のメニューから「Java コンパイラー」を選択。
「プロジェクト固有の設定を可能にする」にチェックを入れる。
「コンパイラー準拠レベル」を「6.0」に変更して [OK] ボタンを押す。
「プロジェクトをビルドしますか？」と聞かれるので、「はい」を押す。

pom.xml を設定する

プロジェクト・トップに作成された pom.xml を編集し、利用するソフトウェアを自動ダウンロードする。

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>test</groupId>
	<artifactId>test</artifactId>
	<packaging>jar</packaging>
	<version>0.0.1-SNAPSHOT</version>
	<name>test</name>

	<dependencies>
		<dependency>
			<groupId>commons-logging</groupId>
			<artifactId>commons-logging</artifactId>
			<version>1.1.1</version>
		</dependency>
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.14</version>
		</dependency>
		<dependency>
			<groupId>commons-lang</groupId>
			<artifactId>commons-lang</artifactId>
			<version>2.4</version>
		</dependency>

		<dependency>
			<groupId>postgresql</groupId>
			<artifactId>postgresql</artifactId>
			<version>8.3-603.jdbc4</version>
		</dependency>

		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-entitymanager</artifactId>
			<version>3.3.2.GA</version>
		</dependency>
	</dependencies>

</project>

解説
Hibernate を使った JPA 環境を構築するには Hibernate EntityManager を利用するので、まず hibernate-entitymanager が必要。
Hibernate のログ出力環境として

commons-logging と log4j も指定。

DB に PostgreSQL を使うので  postgresql を指定。



作成するエンティティの中で ToStringBuilder を使用するので、 commons-lang を指定。

設定ファイル作成

まず、maven のルールに従い、リソースファイル置き場 src/main/resources フォルダを作成する。

  プロジェクト test の上で右クリック、[新規] ⇒ [ソース・フォルダー] を選択する。
  フォルダー名に「src/main/resources」と入力して [終了] ボタンを押す。


作成するファイルは次の３つ。

  META-INF/persistence.xml
  ehcache.xml
  log4j.properties


META-INF/persistence.xml

persistence.xml は JPA の設定ファイル。



src/main/resources フォルダの中に META-INF フォルダを作成。その中に作成する。


<?xml version="1.0" encoding="UTF-8" ?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
	version="1.0">

	<persistence-unit name="persistenceUnit" transaction-type="RESOURCE_LOCAL">
		<provider>org.hibernate.ejb.HibernatePersistence</provider>

		<properties>
			<property name="hibernate.dialect" value="org.hibernate.dialect.PostgreSQLDialect" />
			<property name="hibernate.connection.url" value="jdbc:postgresql://localhost:5432/sandbox" />
			<property name="hibernate.connection.driver_class" value="org.postgresql.Driver" />
			<property name="hibernate.connection.password" value="postgres" />
			<property name="hibernate.connection.username" value="postgres" />
			<property name="hibernate.connection.pool_size" value="10" />

			<property name="hibernate.transaction.factory_class" value="org.hibernate.transaction.JDBCTransactionFactory" />

			<property name="hibernate.cache.provider_class"	value="org.hibernate.cache.EhCacheProvider" />
			<property name="hibernate.cache.provider_configuration_file_resource_path" value="/ehcache.xml" />
			<property name="hibernate.cache.use_query_cache"		value="true" />
			<property name="hibernate.cache.use_second_level_cache"	value="true" />

			<property name="hibernate.jdbc.fetch_size"	value="1000" />
			<property name="hibernate.jdbc.batch_size"	value="50" />
			<property name="hibernate.max_fetch_depth"	value="3" />
			<property name="hibernate.default_batch_fetch_size" value="16" />

			<property name="hibernate.hbm2ddl.auto"		value="update" />

			<property name="hibernate.show_sql" value="true" />
			<property name="hibernate.format_sql" value="true" />
			<property name="hibernate.use_sql_comments" value="false" />

		</properties>
	</persistence-unit>
</persistence>


いくつか設定項目いついて解説。詳しい設定項目についてはこちら

hibernate.cache.provider_class で二次キャッシュ機能を提供してくれるクラスを指定する。




hibernate.cache.use_query_cache はクエリキャッシュ機能を有効にするかどうか。

キャッシュしたくないクエリに対しては次のように設定する。

Query query = entityManager.createNativeQuery("...", User.class);

query.setHint("org.hibernate.cacheable", Boolean.FALSE);
または
((HibernateQuery) query).getHibernateQuery().setCacheable(false);




hibernate.cache.use_second_level_cache で、二次キャッシュ機能を有効(true)に設定している。

バッチ処理などで大量の insert や update を行う場合(Bulk Insert/Bulk Update)は、ここを false にしておいた方が、余計なキャッシュ処理でメモリや CPU リソースを消費せずに済むらしい。




hibernate.hbm2ddl.auto は、実行時にテーブルなどの作成を行うかどうか。開発中は update、運用時は none、開発環境で作り直すときは create-drop を指定するとよい。


update を指定すると、テーブルなどが存在しなければ自動的に作成。
create-drop を指定すると、削除して再作成する。
none を指定すると、何もしない。




hibernate.show_sql は、実行された SQL をログに出力するかどうか。開発時にチューニングを行う時に true、それ以外は false を指定するといい。

ehcache.xml

src/main/resources フォルダの中に作成する。


<ehcache>
   <diskStore
      path="java.io.tmpdir"/>
   <defaultCache
      maxElementsInMemory="10000"
      eternal="false"
      timeToIdleSeconds="600"
      timeToLiveSeconds="1200"
      overflowToDisk="false"
      diskPersistent="false"
      diskExpiryThreadIntervalSeconds="1200"
      memoryStoreEvictionPolicy="LRU"
   />
</ehcache>


log4j.properties

src/main/resources フォルダの中に作成する。


log4j.rootCategory=INFO, console

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%d] %c: %p: %m%n


エンティティ作成

ここまでで環境構築は終了。次にエンティティを作成する。


BaseEntity クラス作成

まずは、全てのエンティティのベースとなる BaseEntity を作成する。

src/main/java フォルダの中で test.test.entity パッケージを作成し、その中に BaseEntity クラスを作成する。



ついでに自動的に作成された App クラスは不要なので、消しておく。


package test.test.entity;

import java.io.Serializable;
import java.util.Date;

import javax.persistence.Column;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Version;

import org.apache.commons.lang.builder.ToStringBuilder;

@MappedSuperclass
public abstract class BaseEntity implements Serializable {
	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private long id;

	@Column(nullable = false)
	@Temporal(TemporalType.TIMESTAMP)
	private Date createTimestamp;

	@Column(nullable = false)
	@Temporal(TemporalType.TIMESTAMP)
	@Version
	private Date updateTimestamp;

	@PrePersist
	protected void updateCreateTimestamp() {
		this.createTimestamp = new Date();
	}

	@PreUpdate
	public void updateUpdateTimestamp() {
		this.updateTimestamp = new Date();
	}

	public String toString() {
		return ToStringBuilder.reflectionToString(this);
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) return true;

		if (getClass() != obj.getClass()) return false;

		BaseEntity entity = (BaseEntity) obj;

		if (entity.getId() == id) return true;

		return false;
	}

	@Override
	public int hashCode() {
		return id != 0 ? (int) id : super.hashCode();
	}

	public long getId() {
		return id;
	}

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

	public Date getCreateTimestamp() {
		return createTimestamp;
	}

	public void setCreateTimestamp(Date createTimestamp) {
		this.createTimestamp = createTimestamp;
	}

	public Date getUpdateTimestamp() {
		return updateTimestamp;
	}

	public void setUpdateTimestamp(Date updateTimestamp) {
		this.updateTimestamp = updateTimestamp;
	}
}


User クラス作成

続いて、User エンティティを作成する。



@Entity アノテーションを設定すると、JPA が自動的に「このクラスはエンティティである」と判断してくれる。

テーブル名は User_ とする。

mailAddress, hashedPassword フィールドを持つ。BaseEntity を継承しているので、id, createTimestamp, updateTimestamp も持つ。

mailAddress にはユニークキーを @UniqueConstraint で設定している。

@Column(nullable = false) で mailAddress, hashedPassword フィールドは null のまま DB に追加できないよう設定している。


package test.test.entity;

@Entity(name = "Users")
public class User extends BaseEntity {
	private static final long serialVersionUID = 1L;

	@Column(nullable = false, length = 255, unique = true)
	private String mailAddress;

	@Column(nullable = false, length = 32)
	private String password;

	public String getMailAddress() {
		return mailAddress;
	}

	public void setMailAddress(String mailAddress) {
		this.mailAddress = mailAddress;
	}

	public String getPassword() {
		return password;
	}

	public void setPassword(String hashedPassword) {
		this.password = hashedPassword;
	}
}


利用プログラム作成

insert - エンティティ追加
まずはデータの追加を行うプログラム。

src/test/java フォルダの test.test パッケージの中に InsertSample クラスを作成する。

DB に対して insert や update などを行うときはトランザクションの中で行う。


package test.test;

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

import test.test.entity.User;

public class InsertSample {
	public static void main(String[] args) {
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("persistenceUnit");
		EntityManager em = emf.createEntityManager();

		EntityTransaction tx = em.getTransaction();
		tx.begin();
		try {
			User user = new User();
			user.setMailAddress("test1@example.com");
			user.setHashedPassword("test");

			em.persist(user);

			tx.commit();
		} finally {
			em.close();
		}
	}
}


select - ネイティブクエリによる検索

次は SelectSample1 クラスを作成。


package test.test;

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

import test.test.entity.User;

public class SelectSample1 {
	public static void main(String[] args) {
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("persistenceUnit");
		EntityManager em = emf.createEntityManager();

		String sql = "select * from user_ where mailAddress=?";

		User user = (User) em.createNativeQuery(sql, User.class)
			.setParameter(1, "test1@example.com")
			.getSingleResult();
		System.out.println(user);

		em.close();
	}
}


select - HSQL による検索

次の SelectSample2 クラスでは HSQL による検索を行っている。


package test.test;

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

import test.test.entity.User;

public class SelectSample2 {
	public static void main(String[] args) {
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("persistenceUnit");
		EntityManager em = emf.createEntityManager();

		String sql = "from User_ where mailAddress=?";

		User user = (User) em.createQuery(sql)
			.setParameter(1, "test1@example.com")
			.getSingleResult();
		System.out.println(user);

		em.close();
	}
}


update - データ更新

次の UpdateSample1 クラスではオブジェクトの値を書き換えることで更新を行っている。

package test.test;

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

import test.test.entity.User;

public class UpdateSample1 {
	public static void main(String[] args) {
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("persistenceUnit");
		EntityManager em = emf.createEntityManager();

		EntityTransaction tx = em.getTransaction();
		tx.begin();
		try {
			String sql = "select * from user_ where mailAddress=?";

			User user = (User) em.createNativeQuery(sql, User.class)
				.setParameter(1, "test1@example.com")
				.getSingleResult();
			System.out.println(user);

			user.setHashedPassword("test4");

			em.persist(user);

			tx.commit();
		} finally {
			em.close();
		}
	}
}


update - ネイティブクエリによる更新

次の UpdateSample2 クラスではネイティブクエリによる更新処理を行っている。

生成される SQL を見ると分かるように、自分でネイティブクエリを書いたほうが最適な更新処理を行える。

ただし、１つの EntityManager セッションの中でキャッシュされているオブジェクトの値とずれが生じている点に注意。


package test.test;

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

import test.test.entity.User;

public class UpdateSample2 {
	private static final String SELECT_SQL = "select * from user_ where mailAddress=?";
	private static final String UPDATE_SQL = "update user_ set hashedPassword=? where id=?";

	public static void main(String[] args) {
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("persistenceUnit");
		EntityManager em = emf.createEntityManager();

		EntityTransaction tx = em.getTransaction();
		tx.begin();
		try {

			User user = (User) em.createNativeQuery(SELECT_SQL, User.class)
				.setParameter(1, "test1@example.com")
				.getSingleResult();
			System.out.println("[1]" + user);

			em.createNativeQuery(UPDATE_SQL)
			.setParameter(1, "test5")
			.setParameter(2, user.getId())
			.executeUpdate();

			tx.commit();

			user = (User) em.createNativeQuery(SELECT_SQL, User.class)
			.setParameter(1, "test1@example.com")
			.getSingleResult();
			System.out.println("[2]" + user);
		} finally {
			em.close();
		}

		em = emf.createEntityManager();

		User user = (User) em.createNativeQuery(SELECT_SQL, User.class)
			.setParameter(1, "test1@example.com")
			.getSingleResult();
		System.out.println("[3]" + user);

		em.close();
	}
}


delete - エンティティの削除

次の DeleteSample ではエンティティを削除している。

package test.test;

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

import test.test.entity.User;

public class DeleteSample {
	public static void main(String[] args) {
		EntityManagerFactory emf = Persistence.createEntityManagerFactory("persistenceUnit");
		EntityManager em = emf.createEntityManager();

		EntityTransaction tx = em.getTransaction();
		tx.begin();
		try {
			String sql = "select * from user_ where mailAddress=?";

			User user = (User) em.createNativeQuery(sql, User.class)
				.setParameter(1, "test1@example.com")
				.getSingleResult();
			System.out.println(user);

			em.remove(user);

			tx.commit();
		} finally {
			em.close();
		}
	}
}


参考文献


	 日経BP EJB3.0入門講座
	 Hibernate EntityManager User guide (英語)
	 Hibernate Reference Documentation (英語)

日	月	火	水	木	金	土
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30

Java Persistence API(JPA) とは

概要

開発環境

まずは環境構築

Maven プロジェクト作成

Java コンパイラー準拠レベルの設定

pom.xml を設定する

設定ファイル作成

META-INF/persistence.xml

ehcache.xml

log4j.properties

エンティティ作成

BaseEntity クラス作成

User クラス作成

利用プログラム作成

insert - エンティティ追加

select - ネイティブクエリによる検索

select - HSQL による検索

update - データ更新

update - ネイティブクエリによる更新

delete - エンティティの削除

参考文献

カテゴリ:

タグ:

トラックバック(0)

コメントする

カテゴリ

2010年9月

検索

最近のブログ記事

Hibernateを使ったシンプルなJPA環境構築

Java Persistence API(JPA) とは

概要

開発環境

まずは環境構築

Maven プロジェクト作成

Java コンパイラー準拠レベルの設定

pom.xml を設定する

設定ファイル作成

META-INF/persistence.xml

ehcache.xml

log4j.properties

エンティティ作成

BaseEntity クラス作成

User クラス作成

利用プログラム作成

insert - エンティティ追加

select - ネイティブクエリによる検索

select - HSQL による検索

update - データ更新

update - ネイティブクエリによる更新

delete - エンティティの削除

参考文献

カテゴリ:

タグ:

トラックバック(0)

コメントする

カテゴリ

2010年9月

タグクラウド

検索

最近のブログ記事