Spring Hibernate 統合の例チュートリアル（Spring 4 + Hibernate 3 および Hibernate 4）

チュートリアル
Hibernate Spring

Springは、最も使用されているJava EEフレームワークの1つであり、Hibernateは最も人気のあるORMフレームワークの一つです。それが企業アプリケーションでよく使用される理由です。最近、私はSpringチュートリアルおよびHibernateチュートリアルに多くの記事を書いてきましたので、spring hibernate 統合の投稿が長い間待たれていました。

Spring Hibernate

今日のチュートリアルでは、Spring 4を使用してHibernate 3と統合し、その後同じプロジェクトをHibernate 4を使用するように更新します。SpringとHibernateの両方には多くのバージョンがありますが、Spring ORMのアーティファクトはHibernate 3とHibernate 4の両方をサポートしているため、プロジェクトで使用したすべての依存関係をリストアップするのが良いです。注意してください、私はすべてのSpringとHibernateのバージョンが互換性がないことに気付きました。以下のバージョンは私の場合には動作しましたので、互換性があると考えられます。もし他のバージョンを使用していてjava.lang.NoClassDefFoundErrorが発生する場合は、それらのバージョンは互換性がないことを意味します。これは主にHibernateのクラスが一つのパッケージから別のパッケージに移動したために発生するエラーです。例えば、最新のHibernateのバージョンではorg.hibernate.engine.FilterDefinitionクラスがorg.hibernate.engine.spi.FilterDefinitionに移動されています。

  • Spring Frameworkのバージョン：4.0.3.RELEASE
  • Hibernate CoreおよびHibernate EntityManagerのバージョン：3.6.9.Finalおよび4.3.5.Final
  • Spring ORMのバージョン：4.0.3.RELEASE

データベースのセットアップ

I am using MySQL database for my project, so below setup.sql script will create the necessary table for this example.

CREATE TABLE `Person` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT '',
  `country` varchar(20) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;
commit;

Spring Hibernate統合の例のプロジェクト構造

以下の画像は最終プロジェクト構造を示しています。各コンポーネントを一つずつ見ていきます。

Maven 依存関係

まず、pom.xml ファイルをチェックして、すべての必要な依存関係とそのバージョンを確認します。

<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>org.springframework.samples</groupId>
	<artifactId>SpringHibernateExample</artifactId>
	<version>0.0.1-SNAPSHOT</version>

	<properties>

		<!-- Generic properties -->
		<java.version>1.6</java.version>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

		<!-- Spring -->
		<spring-framework.version>4.0.3.RELEASE</spring-framework.version>

		<!-- Hibernate / JPA -->
		<!-- <hibernate.version>4.3.5.Final</hibernate.version> -->
		<hibernate.version>3.6.9.Final</hibernate.version>

		<!-- Logging -->
		<logback.version>1.0.13</logback.version>
		<slf4j.version>1.7.5</slf4j.version>

	</properties>

	<dependencies>
		<!-- Spring and Transactions -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>${spring-framework.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-tx</artifactId>
			<version>${spring-framework.version}</version>
		</dependency>

		<!-- Spring ORM support -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-orm</artifactId>
			<version>${spring-framework.version}</version>
		</dependency>

		<!-- Logging with SLF4J & LogBack -->
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-api</artifactId>
			<version>${slf4j.version}</version>
			<scope>compile</scope>
		</dependency>
		<dependency>
			<groupId>ch.qos.logback</groupId>
			<artifactId>logback-classic</artifactId>
			<version>${logback.version}</version>
			<scope>runtime</scope>
		</dependency>

		<!-- Hibernate -->
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-entitymanager</artifactId>
			<version>${hibernate.version}</version>
		</dependency>
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-core</artifactId>
			<version>${hibernate.version}</version>
		</dependency>

		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.9</version>
		</dependency>
		<dependency>
			<groupId>commons-dbcp</groupId>
			<artifactId>commons-dbcp</artifactId>
			<version>1.4</version>
		</dependency>
	</dependencies>
</project>

Spring と Hibernate 統合プロジェクトの重要な依存関係は次のとおりです：

  • spring-context および spring-tx は、コア Spring 機能のためのものです。バージョン 4.0.3.RELEASE を使用していることに注意してください。
  • Spring ORM サポートのための spring-orm 依存関係は、当社の Spring プロジェクトで Hibernate 統合が必要です。
  • ハイバーナートフレームワーク用の hibernate-entitymanager および hibernate-core 依存関係です。バージョンは 3.6.9.Final で、Hibernate 4 を使用するには、上記の pom.xml ファイルでコメントアウトされているように、4.3.5.Final に変更する必要があります。
  • データベース接続用の MySQL ドライバーである mysql-connector-java です。

モデルクラスまたはエンティティビーン

Hibernate XMLベースのマッピングとJPAアノテーションベースのマッピングの両方を使用できます。ここでは、HibernateがJPA実装を提供しているため、マッピングにJPAアノテーションを使用しています。

package com.journaldev.model;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

/**
 * Entity bean with JPA annotations
 * Hibernate provides JPA implementation
 * @author pankaj
 *
 */
@Entity
@Table(name="Person")
public class Person {

	@Id
	@Column(name="id")
	@GeneratedValue(strategy=GenerationType.IDENTITY)
	private int id;
	
	private String name;
	
	private String country;

	public int getId() {
		return id;
	}

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

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getCountry() {
		return country;
	}

	public void setCountry(String country) {
		this.country = country;
	}
	
	@Override
	public String toString(){
		return "id="+id+", name="+name+", country="+country;
	}
}

DAOクラス

DAOクラスには、2つのメソッドを実装します。1つ目はPersonオブジェクトをテーブルに保存し、2つ目はテーブルからすべてのレコードを取得してPersonのリストを返します。

package com.journaldev.dao;

import java.util.List;

import com.journaldev.model.Person;

public interface PersonDAO {

	public void save(Person p);
	
	public List<Person> list();
	
}

上記のDAOクラスの実装は以下のようになります。

package com.journaldev.dao;

import java.util.List;

import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;

import com.journaldev.model.Person;

public class PersonDAOImpl implements PersonDAO {

	private SessionFactory sessionFactory;

    public void setSessionFactory(SessionFactory sessionFactory) {
        this.sessionFactory = sessionFactory;
    }
    
	@Override
	public void save(Person p) {
		Session session = this.sessionFactory.openSession();
		Transaction tx = session.beginTransaction();
		session.persist(p);
		tx.commit();
		session.close();
	}

	@SuppressWarnings("unchecked")
	@Override
	public List<Person> list() {
		Session session = this.sessionFactory.openSession();
		List<Person> personList = session.createQuery("from Person").list();
		session.close();
		return personList;
	}

}

注意すべきは、Hibernate関連のクラスを使用しているのはこの場所だけであることです。このパターンにより、実装が柔軟になり、他の技術に移行しやすくなります。たとえば、iBatis ORMフレームワークを使用したい場合、iBatis用のDAO実装を提供し、SpringのBean構成ファイルを変更するだけです。上記の例では、Hibernateセッションのトランザクション管理を使用しています。しかし、@Transactionalアノテーションを使用したSpringの宣言型トランザクション管理も使用できます。詳細はSpringトランザクション管理を参照してください。

Hibernate 3 統合用のSpring Bean構成ファイル

最初に、Hibernate 3の統合に必要なSpring Bean構成を見てみましょう。後で詳細を調べます。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="https://www.springframework.org/schema/beans"
	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:aop="https://www.springframework.org/schema/aop"
	xmlns:tx="https://www.springframework.org/schema/tx"
	xsi:schemaLocation="https://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		https://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop-4.0.xsd
		https://www.springframework.org/schema/tx https://www.springframework.org/schema/tx/spring-tx-4.0.xsd">

	<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
		destroy-method="close">
		<property name="driverClassName" value="com.mysql.jdbc.Driver" />
		<property name="url" value="jdbc:mysql://localhost:3306/TestDB" />
		<property name="username" value="pankaj" />
		<property name="password" value="pankaj123" />
	</bean>

<!-- Hibernate 3 XML SessionFactory Bean definition-->
<!-- 	<bean id="hibernate3SessionFactory"
		class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="mappingResources">
			<list>
				<value>person.hbm.xml</value>
			</list>
		</property>
		<property name="hibernateProperties">
			<value>
				hibernate.dialect=org.hibernate.dialect.MySQLDialect
			</value>
		</property>
	</bean> -->

<!-- Hibernate 3 Annotation SessionFactory Bean definition-->
	<bean id="hibernate3AnnotatedSessionFactory"
		class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="annotatedClasses">
			<list>
				<value>com.journaldev.model.Person</value>
			</list>
		</property>
		<property name="hibernateProperties">
			<props>
				<prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
				<prop key="hibernate.current_session_context_class">thread</prop>
				<prop key="hibernate.show_sql">false</prop>
			</props>
		</property>
	</bean>
	
	<bean id="personDAO" class="com.journaldev.dao.PersonDAOImpl">
		<property name="sessionFactory" ref="hibernate3AnnotatedSessionFactory" />
	</bean>
</beans>

Hibernateにデータベース接続の詳細を提供する方法は2つあります。1つはすべてをhibernatePropertiesに渡すこと、もう1つはDataSourceを作成し、それをHibernateに渡すことです。私は後者の方法を好みます。そのため、Apache Commons DBCPの依存関係があるBasicDataSourceを作成してデータベース接続プロパティを設定します。SpringとHibernate 3の統合のために、Spring ORM は2つのクラスを提供しています – org.springframework.orm.hibernate3.LocalSessionFactoryBean（HibernateのマッピングがXMLベースの場合）およびorg.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean（注釈ベースのマッピングの場合）。XMLベースのマッピングを使用している場合は、LocalSessionFactoryBeanのシンプルなBean構成がコメントで提供されています。 AnnotationSessionFactoryBeanはLocalSessionFactoryBeanクラスを拡張しているため、Hibernate統合のための基本的なプロパティをすべて持っています。プロパティは自己説明的で、ほとんどがHibernateに関連しているため、それほど詳しく説明しません。ただし、hibernateProperties、annotatedClassesがどこから来るのか疑問に思っている場合は、Beanクラスのソースコードを確認する必要があります。 personDAOのBean定義に注目してください。先に述べたように、他のORMフレームワークに切り替える必要がある場合は、ここで実装クラスを変更し、必要な他のプロパティを設定する必要があります。

Spring 4 Hibernate 3 テストプログラム

セットアップは完了しました。では、アプリケーションをテストするためのシンプルなプログラムを書いてみましょう。

package com.journaldev.main;

import java.util.List;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.journaldev.dao.PersonDAO;
import com.journaldev.model.Person;

public class SpringHibernateMain {

	public static void main(String[] args) {

		ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring.xml");
		
		PersonDAO personDAO = context.getBean(PersonDAO.class);
		
		Person person = new Person();
		person.setName("Pankaj"); person.setCountry("India");
		
		personDAO.save(person);
		
		System.out.println("Person::"+person);
		
		List list = personDAO.list();
		
		for(Person p : list){
			System.out.println("Person List::"+p);
		}
		// リソースを閉じる
		context.close();	
	}
}

上記のプログラムを実行すると、ログ設定が正しく行われていないため、Hibernateに関連する多くの出力が表示されますが、これはこのチュートリアルの範囲外です。しかし、以下は、私たちのプログラムによって生成された出力です。

Person::id=3, name=Pankaj, country=India
Person List::id=1, name=Pankaj, country=India
Person List::id=2, name=Pankaj, country=India
Person List::id=3, name=Pankaj, country=India

Spring 4 Hibernate 4 統合の変更点

さて、Hibernate 3 の代わりに Hibernate 4 を使用するようにアプリケーションを変更しましょう。この移行には、以下の設定変更のみが必要です。

  1. pom.xml ファイルで Hibernate のバージョンを 4.3.5.Final に変更します。上記のコメントに示されているように。

  2. Spring Beanの設定ファイルを変更してください。今までに、Spring Beanの設定ファイルがSpringとHibernateフレームワークの統合の鍵であることがわかったはずです。以下のSpring Beanの設定ファイルは、Spring 4とHibernate 4のバージョンで動作します。

    <?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="https://www.springframework.org/schema/beans"
	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:aop="https://www.springframework.org/schema/aop"
	xmlns:tx="https://www.springframework.org/schema/tx"
	xsi:schemaLocation="https://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		https://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop-4.0.xsd
		https://www.springframework.org/schema/tx https://www.springframework.org/schema/tx/spring-tx-4.0.xsd">

	<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
		destroy-method="close">
		<property name="driverClassName" value="com.mysql.jdbc.Driver" />
		<property name="url" value="jdbc:mysql://localhost:3306/TestDB" />
		<property name="username" value="pankaj" />
		<property name="password" value="pankaj123" />
	</bean>


<!-- Hibernate 4 SessionFactory Beanの定義 -->
<bean id="hibernate4AnnotatedSessionFactory"
		class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="annotatedClasses">
			<list>
				<value>com.journaldev.model.Person</value>
			</list>
		</property>
		<property name="hibernateProperties">
			<props>
				<prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
				<prop key="hibernate.current_session_context_class">thread</prop>
				<prop key="hibernate.show_sql">false</prop>
			</props>
		</property>
	</bean>

	
	<bean id="personDAO" class="com.journaldev.dao.PersonDAOImpl">
		<property name="sessionFactory" ref="hibernate4AnnotatedSessionFactory" />
	</bean>
</beans>

    Hibernate 4では、SessionFactory beanにorg.springframework.orm.hibernate4.LocalSessionFactoryBeanを使用する必要があります。Spring ORMはHibernate 3の両方のクラスをマージし、今では単一のクラスがあります。これは混乱を避けるために良いです。他のすべての設定は以前と同じです。

以上です、プロジェクトはHibernate 4に正常に移行されました、きれいですね。単にSpringHibernateMainクラスを変更して、spring4.xmlをbeanの設定に使用すれば、以前と同じ出力を得ることができます。以下のリンクから最終プロジェクトをダウンロードして、さらに多くの設定を試して学んでください。

Spring Hibernate Integration Projectをダウンロード

Source:
https://www.digitalocean.com/community/tutorials/spring-hibernate-integration-example-tutorial