「TomcatのJNDIデータソースに関する例を使ったHibernateチュートリアル」

1年 ago
桜, 春樹
7 minutes

「Hibernate Tomcat JNDI DataSourceの例のチュートリアルへようこそ。既に独立したJavaアプリケーションでHibernate ORMツールを使用する方法を見てきましたが、今日はTomcatサーブレットコンテナでDataSourceを使ったHibernateの使い方を学びます。WebアプリケーションでHibernateを使用するのは非常に簡単で、必要なのはHibernate設定ファイルでのDataSourceプロパティの設定です。まず、テストデータベースとTomcatコンテナ内のJNDI DataSourceをセットアップする必要があります。」

HibernateのデータソースJNDI例のデータベース設定

私は例としてMySQLを使用しています。以下のスクリプトは、簡単なテーブルを作成し、その中にいくつかの値を挿入するために実行されます。employee.sql

CREATE TABLE `Employee` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) DEFAULT NULL,
  `role` varchar(20) DEFAULT NULL,
  `insert_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=26 DEFAULT CHARSET=utf8;

INSERT INTO `Employee` (`id`, `name`, `role`, `insert_time`)
VALUES
	(3, 'Pankaj', 'CEO', now());
INSERT INTO `Employee` (`id`, `name`, `role`, `insert_time`)
VALUES
	(14, 'David', 'Developer', now());

データベーススキーマの名前はTestDBです。

TomcatのJNDIデータソースの設定

TomcatコンテナをDataSourceを初期化するために設定するには、server.xmlとcontext.xmlファイルにいくつかの変更を加える必要があります。

<Resource name="jdbc/MyLocalDB" 
      global="jdbc/MyLocalDB" 
      auth="Container" 
      type="javax.sql.DataSource" 
      driverClassName="com.mysql.jdbc.Driver" 
      url="jdbc:mysql://localhost:3306/TestDB" 
      username="scdev" 
      password="scdev123" 
      
      maxActive="100" 
      maxIdle="20" 
      minIdle="5" 
      maxWait="10000"/>

サーバーのserver.xmlのGlobalNamingResources要素に、上記のリソースを追加してください。context.xml

<ResourceLink name="jdbc/MyLocalDB"
              global="jdbc/MyLocalDB"
              auth="Container"
              type="javax.sql.DataSource" />

context.xmlファイルに上記のResourceLinkを追加してください。これにより、アプリケーションは名前がjdbc/MyLocalDBのJNDIリソースにアクセスできるようになります。サーバーを再起動するだけで、tomcatサーバーログにエラーが表示されることはありません。パスワードが間違っているなどの誤った設定がある場合は、サーバーログに対応する例外が表示されます。また、MySQLのドライバーjarファイルがtomcatのlibディレクトリ内にあることを確認する必要もあります。そうでないと、tomcatはデータベース接続を作成できないため、ログにClassNotFoundExceptionが表示されます。これで、データベースとtomcatサーバーのJNDI設定が完了しましたので、hibernateを使用してウェブアプリケーションを作成しましょう。

HibernateのDataSourceの例は、動的ウェブプロジェクトです。

Eclipseで動的なウェブプロジェクトを作成し、それをMavenプロジェクトとして設定してください。最終的なプロジェクトの構造は以下の画像のようになります。なお、このプロジェクトの展開にはTomcat-7を使用しており、ビルドパスに追加済みですので、プロジェクトにServlet APIの依存関係を別途追加する必要はありません。Tomcat-7はServlet 3の仕様をサポートしており、私たちはアノテーションを使用してServletを作成します。Servlet 3のアノテーションに不慣れである場合は、初心者向けのServletチュートリアルを参照してください。それでは、各コンポーネントを順に見ていきましょう。

ヒバネートのメイブン依存関係

私たちの最終的な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>HibernateDataSource</groupId>
	<artifactId>HibernateDataSource</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>
	
	<dependencies>
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-core</artifactId>
			<version>4.3.5.Final</version>
		</dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.0.5</version>
			<scope>provided</scope>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<artifactId>maven-war-plugin</artifactId>
				<version>2.3</version>
				<configuration>
					<warSourceDirectory>WebContent</warSourceDirectory>
					<failOnMissingWebXml>false</failOnMissingWebXml>
				</configuration>
			</plugin>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.1</version>
				<configuration>
					<source>1.7</source>
					<target>1.7</target>
				</configuration>
			</plugin>
		</plugins>
		<finalName>${project.artifactId}</finalName>
	</build>
</project>

私はHibernateの最新バージョン4.3.5.Finalを使用しています。Hibernateのために、hibernate-coreの依存関係が追加されました。MySQLデータベースを使用しているため、mysql-connector-javaの依存関係も追加されていますが、スコープはプロジェクトのtomcatコンテナライブラリの一部となっているため、提供されました。MySQLドライバーの依存関係を追加しなくても、プロジェクトはコンパイルおよび実行できます。ただし、MySQLデータベースを使用していることがプロジェクトの依存関係を調べる人に明確にわかるように、含める方が良いでしょう。

ネイティブ日本語で次の文章を言い換えてください。1つのオプションのみで構いません：
Hibernateのデータソース設定

私たちのデータソースを含むHibernateの設定ファイルは、以下のようになっています。hibernate.cfg.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
		"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
		"https://hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <property name="hibernate.connection.driver_class">com.mysql.jdbc.Driver</property>
        <property name="hibernate.dialect">org.hibernate.dialect.MySQLDialect</property>
        <property name="hibernate.connection.datasource">java:comp/env/jdbc/MyLocalDB</property>
        <property name="hibernate.current_session_context_class">thread</property>
        
        <!-- Mapping with model class containing annotations -->
	<mapping class="com.scdev.servlet.hibernate.model.Employee"/>
    </session-factory>
</hibernate-configuration>

hibernate.connection.datasourceプロパティは、Hibernateがデータベース操作に使用するDataSourceの名前を提供するために使用されます。

ネイティブな日本語で以下の文を言い換えます。1つのオプションだけ必要です。

HibernateのDataSourceの例を使用したモデルクラス

私たちのモデルクラスであるEmployeeでは、Hibernateの設定ファイルで注釈を使用していることがわかります。以下のように私たちのモデルビーンは見えます。Employee.java

package com.scdev.servlet.hibernate.model;

import java.util.Date;

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

@Entity
@Table(name="Employee", 
	   uniqueConstraints={@UniqueConstraint(columnNames={"ID"})})
public class Employee {

	@Id
	@GeneratedValue(strategy=GenerationType.IDENTITY)
	@Column(name="ID", nullable=false, unique=true, length=11)
	private int id;
	
	@Column(name="NAME", length=20, nullable=true)
	private String name;
	
	@Column(name="ROLE", length=20, nullable=true)
	private String role;
	
	@Column(name="insert_time", nullable=true)
	private Date insertTime;
	
	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 getRole() {
		return role;
	}
	public void setRole(String role) {
		this.role = role;
	}
	public Date getInsertTime() {
		return insertTime;
	}
	public void setInsertTime(Date insertTime) {
		this.insertTime = insertTime;
	}
}

モデルビーンは、Hibernate初心者チュートリアルで使用したものと同じですので、使用されているアノテーションに関して何か疑問がある場合は、ぜひ参照してみてください。

ヒバネイトデータソーストムキャットJNDIサーブレットリスナー

私達はアプリケーションでHibernate SessionFactoryを使用するため、そしてWebアプリケーションが破棄されるときにも利用するため、Hibernate SessionFactoryを初期化する必要があります。したがって、最適な場所はServletContextListenerの実装でSessionFactoryを破棄することです。HibernateSessionFactoryListener.javaがあります。

package com.scdev.servlet.hibernate.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

import org.hibernate.SessionFactory;
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.cfg.Configuration;
import org.hibernate.service.ServiceRegistry;
import org.jboss.logging.Logger;

@WebListener
public class HibernateSessionFactoryListener implements ServletContextListener {

	public final Logger logger = Logger.getLogger(HibernateSessionFactoryListener.class);
	
    public void contextDestroyed(ServletContextEvent servletContextEvent) {
    	SessionFactory sessionFactory = (SessionFactory) servletContextEvent.getServletContext().getAttribute("SessionFactory");
    	if(sessionFactory != null && !sessionFactory.isClosed()){
    		logger.info("Closing sessionFactory");
    		sessionFactory.close();
    	}
    	logger.info("Released Hibernate sessionFactory resource");
    }

    public void contextInitialized(ServletContextEvent servletContextEvent) {
    	Configuration configuration = new Configuration();
    	configuration.configure("hibernate.cfg.xml");
    	logger.info("Hibernate Configuration created successfully");
    	
    	ServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder().applySettings(configuration.getProperties()).build();
    	logger.info("ServiceRegistry created successfully");
    	SessionFactory sessionFactory = configuration
				.buildSessionFactory(serviceRegistry);
    	logger.info("SessionFactory created successfully");
    	
    	servletContextEvent.getServletContext().setAttribute("SessionFactory", sessionFactory);
    	logger.info("Hibernate SessionFactory Configured successfully");
    }
	
}

Servletリスナーについて詳しく知りたい場合は、Servletリスナーのチュートリアルをお読みください。

HibernateとTomcatを使用したJNDIのサーブレット実装の例

簡単なサーブレットを作成しましょう。リクエストパラメータとして従業員IDを渡し、データベースから従業員情報を出力します。当然ながら、データベースのクエリにはHibernateを使用し、従業員情報を取得します。GetEmployeeByID.java

package com.scdev.servlet.hibernate;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.jboss.logging.Logger;

import com.scdev.servlet.hibernate.model.Employee;

@WebServlet("/GetEmployeeByID")
public class GetEmployeeByID extends HttpServlet {
	private static final long serialVersionUID = 1L;
	
	public final Logger logger = Logger.getLogger(GetEmployeeByID.class);
       
	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		int empId = Integer.parseInt(request.getParameter("empId"));
		logger.info("Request Param empId="+empId);
		
		SessionFactory sessionFactory = (SessionFactory) request.getServletContext().getAttribute("SessionFactory");
		
		Session session = sessionFactory.getCurrentSession();
		Transaction tx = session.beginTransaction();
		Employee emp = (Employee) session.get(Employee.class, empId);
		tx.commit();
		PrintWriter out = response.getWriter();
        response.setContentType("text/html");
        if(emp != null){
        out.print("<html><body><h2>Employee Details</h2>");
        out.print("<table border=\"1\" cellspacing=10 cellpadding=5>");
        out.print("<th>Employee ID</th>");
        out.print("<th>Employee Name</th>");
        out.print("<th>Employee Role</th>");
        
            out.print("<tr>");
            out.print("<td>" + empId + "</td>");
            out.print("<td>" + emp.getName() + "</td>");
            out.print("<td>" + emp.getRole() + "</td>");
            out.print("</tr>");
        out.print("</table></body><br/>");
        
        out.print("</html>");
        }else{
        	out.print("<html><body><h2>No Employee Found with ID="+empId+"</h2></body></html>");
        }
	}

}

非常にシンプルなサーブレットクラスです。@WebServletアノテーションを使用して、それに対するURIパターンを指定しています。

HibernateのデータソースをテストするためのTomcat JNDIの例のアプリケーションを試す

私たちのアプリケーションは、すでに準備ができています。warファイルとしてエクスポートして、Tomcatコンテナにデプロイしてください。以下は、私たちのアプリケーションのサーブレットを呼び出した際のいくつかのスクリーンショットです。リクエストURLのクエリストリングにempIdというリクエストパラメータを渡していることに注目してください。また、サーバーログには私たちのアプリケーションが生成したログが表示されます。

May 08, 2014 8:14:16 PM org.hibernate.cfg.Configuration configure
INFO: HHH000043: Configuring from resource: hibernate.cfg.xml
May 08, 2014 8:14:16 PM org.hibernate.cfg.Configuration getConfigurationInputStream
INFO: HHH000040: Configuration resource: hibernate.cfg.xml
May 08, 2014 8:14:16 PM org.hibernate.cfg.Configuration doConfigure
INFO: HHH000041: Configured SessionFactory: null
May 08, 2014 8:14:16 PM com.scdev.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: Hibernate Configuration created successfully
May 08, 2014 8:14:16 PM com.scdev.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: ServiceRegistry created successfully
May 08, 2014 8:14:16 PM org.hibernate.dialect.Dialect <init>
INFO: HHH000400: Using dialect: org.hibernate.dialect.MySQLDialect
May 08, 2014 8:14:17 PM org.hibernate.engine.jdbc.internal.LobCreatorBuilder useContextualLobCreation
INFO: HHH000423: Disabling contextual LOB creation as JDBC driver reported JDBC version [3] less than 4
May 08, 2014 8:14:17 PM org.hibernate.engine.transaction.internal.TransactionFactoryInitiator initiateService
INFO: HHH000399: Using default transaction strategy (direct JDBC transactions)
May 08, 2014 8:14:17 PM org.hibernate.hql.internal.ast.ASTQueryTranslatorFactory <init>
INFO: HHH000397: Using ASTQueryTranslatorFactory
May 08, 2014 8:14:17 PM com.scdev.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: SessionFactory created successfully
May 08, 2014 8:14:17 PM com.scdev.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: Hibernate SessionFactory Configured successfully
May 08, 2014 8:14:32 PM com.scdev.servlet.hibernate.GetEmployeeByID doGet
INFO: Request Param empId=3
May 08, 2014 8:15:22 PM com.scdev.servlet.hibernate.GetEmployeeByID doGet
INFO: Request Param empId=3

アプリケーションのデプロイ解除またはサーバーの停止を行うと、SessionFactoryの破棄に関するサーバーログが表示されます。

May 08, 2014 11:31:16 PM com.scdev.servlet.hibernate.listener.HibernateSessionFactoryListener contextDestroyed
INFO: Closing sessionFactory
May 08, 2014 11:31:16 PM com.scdev.servlet.hibernate.listener.HibernateSessionFactoryListener contextDestroyed
INFO: Released Hibernate sessionFactory resource

それで〇〇コンテナ用のHibernate DataSourceの例は以上です。理解しやすく実装できるといいですね。以下のリンクからサンプルプロジェクトをダウンロードして、さらに学習するために試してみてください。

Hibernateのデータソースプロジェクトをダウンロードする

コメントを残す 0

Your email address will not be published. Required fields are marked *