Java Swing アプリケーションでの Hibernate の使用

このチュートリアルでは、NetBeans IDE を使用して、データベースからのデータを表示する Java Swing アプリケーションを作成し、配備します。このアプリケーションでは Hibernate フレームワークを持続性レイヤーとして使用し、リレーショナルデータベースから POJO (plain old Java objects) を取得します。

Hibernate は、ORM (object relational mapping) のためのツールを提供するフレームワークです。このチュートリアルでは、IDE に含まれる Hibernate フレームワークのサポートと、必要な Hibernate ファイルを作成するためのウィザードの使用方法を示します。Java オブジェクトを作成し、Hibernate を使用するようにアプリケーションを構成したあと、データを検索および表示する GUI インタフェースを作成します。

このチュートリアルで構築するアプリケーションは、DVD ストア Web アプリケーションの関係管理アプリケーションです。このチュートリアルでは、俳優のプロフィールを姓または名の一致に基づいてクエリーできるアプリケーションの作成方法を取り上げます。必要に応じて、映画の詳細のクエリー、項目の追加、更新、削除ができるように、アプリケーションを拡張することもできます。このチュートリアルでは、MySQL データベースと Sakila データベースを使用しますが、Hibernate アプリケーションでサポートされるデータベースサーバーであれば、どれでも使用できます。Sakila データベースは、MySQL のサイトからダウンロードできるサンプルデータベースです。Sakila DB の設定に関する情報は、次の節で説明します。

このチュートリアルを開始する前に、必要に応じて次のドキュメントをお読みください。

• hibernate.org の Hibernate ドキュメント
• GUI 構築入門
• 「MySQL データベースへの接続」チュートリアル

Maven を使用してこのアプリケーションを構築するには、「Hibernate を使用した Maven Swing アプリケーションの作成」を参照してください。

目次

• データベースの作成
• Java Swing アプリケーションプロジェクトの作成
• プロジェクトへの Hibernate サポートの追加
  • Hibernate 構成ファイルの作成
  • Hibernate 構成ファイルの変更
  • HibernateUtil.java ヘルパーファイルの作成
• Hibernate のマッピングファイルおよび Java クラスの生成
  • リバースエンジニアリングファイルの作成
  • データベースからの Hibernate のマッピングファイルと POJO の作成
• アプリケーション GUI の作成
  • JFrame フォームの作成
  • 要素のフォームへの追加
• HQL クエリーエディタでのクエリーの作成
• クエリーのフォームへの追加
• プロジェクトの実行
  • ソリューションプロジェクトのダウンロード
• 個別の POJO およびマッピングファイルの作成 (省略可能)

このチュートリアルに従うには、次のソフトウェアとリソースが必要です。

ソフトウェアまたはリソース	必須バージョン
NetBeans IDE	6.7, 6.8, 6.9, 7.0, Java
Java Development Kit (JDK)	version 6 または version 5
MySQL データベースサーバー	version 5.x
Sakila データベース	アップデートセンターから入手できるプラグイン

完了したプロジェクトの ZIP アーカイブはダウンロードできます。

データベースの作成

このチュートリアルでは、sakila という名前の MySQL データベースを使用します。IDE のインストールにはサンプルデータベースが含まれていないため、このチュートリアルを開始する前に、まずデータベースを作成する必要があります。

Sakila データベースは無料の MySQL サンプルデータベースで、MySQL のサイトから入手できます。sakila データベースを作成するには、プラグインマネージャーを使用して Sakila サンプルデータベースプラグインをダウンロードしてインストールできます。プラグインのインストール後、「サービス」ウィンドウから Sakila データベースを作成できます。Sakila データベースは、「MySQL データベースの作成」ダイアログのデータベース一覧に追加されます。

MySQL を操作するための IDE の構成については、「MySQL データベースへの接続」チュートリアルを参照してください。

1. プラグインマネージャーを開き、Sakila サンプルデータベースプラグインをインストールします。
2. プラグインをインストールしたあと、「サービス」ウィンドウで「データベース」ノードを展開し、「MySQL サーバー」ノードを右クリックして「起動」を選択して、MySQL データベースサーバーを起動します。
3. 「MySQL サーバー」ノードを右クリックし、「データベースを作成」を選択します。
4. 「MySQL データベースの作成」ダイアログで「新規データベース名」ドロップダウンリストから「Sakila データベース」を選択します。「了解」をクリックします。
   

   「了解」をクリックすると、「MySQL サーバー」ノードの下に「Sakila」ノードが表示されます。

5. 「Sakila」ノードを右クリックし、「接続」を選択します。

「接続」をクリックすると、「Sakila」データベースのデータベース接続のノード (jdbc:mysql://localhost:3306/sakila [デフォルトのユーザー名]) が「データベース」ノードに一覧表示されます。接続が開いたら、接続ノードを展開してデータベースのデータを確認できます。

Java Swing アプリケーションプロジェクトの作成

この課題では、DVDStoreAdmin という名前の簡単な Java Swing アプリケーションプロジェクトを作成します。

1. 「ファイル」>「新規プロジェクト」(Ctrl-Shift-N) を選択します。「Java」カテゴリから「Java アプリケーション」を選択し、「次へ」をクリックします。
2. プロジェクト名に「DVDStoreAdmin」と入力し、プロジェクトの場所を設定します。
3. 専用フォルダを使用するオプションが選択されている場合は選択を解除します。
   このチュートリアルでは、ライブラリをほかのユーザーと共有する必要がないので、プロジェクトライブラリを専用のフォルダにコピーする理由はほとんどありません。
4. 「主クラスを作成」の選択を解除します。「完了」をクリックします。

「完了」をクリックすると、IDE で Java アプリケーションプロジェクトが作成されます。このプロジェクトには主クラスが設定されていません。フォームを作成し、このフォームを主クラスとして設定します。

プロジェクトへの Hibernate サポートの追加

Hibernate サポートを J2SE プロジェクトに追加するには、Hibernate ライブラリをプロジェクトに追加する必要があります。Hibernate ライブラリは IDE に含まれており、「プロジェクト｣ウィンドウで「ライブラリ」ノードを右クリックして「ライブラリを追加」を選択し、「ライブラリを追加」ダイアログで「Hibernate」ライブラリを選択することで、任意のプロジェクトに追加できます。

IDE には、プロジェクトに必要な Hibernate ファイルの作成に役立つウィザードが複数用意されています。IDE のウィザードを使用し、Hibernate 構成ファイルとユーティリティーヘルパークラスを作成できます。ウィザードを使用して Hibernate 構成ファイルを作成すると、自動的に Hibernate ライブラリがプロジェクトに追加されます。

Hibernate のマッピングファイルおよび Java クラスの生成

このチュートリアルでは、POJO (Plain Old Java Objects) である Actor.java を使用してデータベース内の ACTOR 表のデータを表示します。このクラスは、表内の列のフィールドを指定し、データを取得および書き込みするための単純な取得メソッドおよび設定メソッドを使用します。Actor.java を ACTOR 表にマップするには、Hibernate のマッピングファイルを使用するか、クラスの注釈を使用します。

「リバースエンジニアリング」ウィザードと「データベースからの Hibernate のマッピングファイルと POJO」ウィザードを使用して、選択するデータベース表に基づいて複数の POJO とマッピングファイルを作成できます。代わりに、IDE のウィザードを使用して個別の POJO とマッピングファイルを最初から作成することもできます。

注:

これで、POJO と必要な Hibernate 関連ファイルが準備できたので、アプリケーションの簡単な Java GUI フロントエンドを作成できます。また、データベースにクエリーを行なってデータを取得する HQL クエリーを作成し、追加できます。また、この過程で HQL エディタを使用してクエリーを構築およびテストします。

アプリケーション GUI の作成

この課題では、データを入力および表示するためのフィールドを含む、簡単な JFrame フォーム作成します。また、データを取得するためのデータベースクエリーをトリガーするボタンを追加します。

GUI ビルダーを使用したフォームを作成に習熟していない場合、「GUI 構築入門」チュートリアルを見直すことをお勧めします。

HQL クエリーエディタでのクエリーの作成

IDE で、HQL クエリーエディタを使用して Hibernate クエリー言語 (HQL) に基づくクエリーを構築およびテストできます。クエリーを入力すると、それに相当する (変換された) SQL クエリーがエディタに表示されます。ツールバーの「HQL クエリーを実行」ボタンをクリックすると、IDE がクエリーを実行し、エディタ下部に結果が表示されます。

この課題では、HQL エディタを使用して、姓または名の一致に基づいて俳優の詳細リストを取得する、簡単な HQL クエリーを構築します。クエリーをクラスに追加する前に、HQL クエリーエディタを使用して、接続が正しく動作し、クエリーで目的の結果が生成されることをテストします。

1. 「プロジェクト」ウィンドウで、<デフォルトパッケージ> ソースパッケージノードを展開します。
2. 「hibernate.cfg.xml」を右クリックし、「HQL クエリーを実行」を選択して HQL クエリーエディタを開きます。
3. HQL クエリーエディタに「from Actor」と入力して、接続をテストします。ツールバーの「HQL クエリーを実行」ボタン ) をクリックします。

   「HQL クエリーを実行」をクリックすると、クエリー結果が HQL クエリーエディタの下の区画に表示されるはずです。

   

   結果の上にある「SQL」ボタンをクリックすると、次のような SQL クエリーが表示されるはずです。

   select actor0_.actor_id as col_0_0_ from sakila.actor actor0_

   
4. 検索文字列が「PE」の場合、次のクエリーを HQL クエリーエディタに入力して「HQL クエリーを実行」をクリックし、クエリーの結果を確認します。

   from Actor a where a.firstName like 'PE%'

   クエリーによって名前が「PE」で始まる俳優の詳細リストが返されます。

5. 新しい HQL クエリーエディタのタブを開き、次のクエリーをエディタ区画に入力します。「HQL クエリーを実行」をクリックします。

   from Actor a where a.lastName like 'MO%'

   クエリーによって姓が「MO」で始まる俳優の詳細リストが返されます。

クエリーのテストによって、そのクエリーが目的の結果を返すことがわかります。次の手順では、フォームで「クエリー」ボタンをクリックすると適切なクエリー呼び出されるように、クエリーをアプリケーションに実装します。

クエリーのフォームへの追加

DVDStoreAdmin.java を変更して、クエリー文字列を追加し、入力変数を組み込むクエリーを構築して呼び出すメソッドを作成する必要があります。また、ボタンイベントハンドラを変更して、正しいクエリーを呼び出し、クエリー結果を表に表示するメソッドを追加する必要があります。

1. DVDStoreAdmin.java を開き、「ソース」タブをクリックします。
2. このクラスに、次のクエリー文字列 (ボールド部分) を追加します。

   public DVDStoreAdmin() {
       initComponents();
   }
   
   private static String QUERY_BASED_ON_FIRST_NAME="from Actor a where a.firstName like '";
   private static String QUERY_BASED_ON_LAST_NAME="from Actor a where a.lastName like '";

   クエリーを HQL クエリーエディタのタブからファイルにコピーし、コードを変更できます。

3. 次のメソッドを追加し、ユーザー入力文字列に基づくクエリーを作成します。

   private void runQueryBasedOnFirstName() {
       executeHQLQuery(QUERY_BASED_ON_FIRST_NAME + firstNameTextField.getText() + "%'");
   }
       
   private void runQueryBasedOnLastName() {
       executeHQLQuery(QUERY_BASED_ON_LAST_NAME + lastNameTextField.getText() + "%'");
   }

   このメソッドは、executeHQLQuery() というメソッドを呼び出し、クエリー文字列とユーザーが入力した検索文字列とを組み合わせてクエリーを作成します。

4. executeHQLQuery() メソッドを追加します。

   private void executeHQLQuery(String hql) {
       try {
           Session session = HibernateUtil.getSessionFactory().openSession();
           session.beginTransaction();
           Query q = session.createQuery(hql);
           List resultList = q.list();
           displayResult(resultList);
           session.getTransaction().commit();
       } catch (HibernateException he) {
           he.printStackTrace();
       }
   }

   executeHQLQuery() メソッドは、Hibernate を呼び出して、選択したクエリーを実行します。このメソッドは、HibernateUtil.java ユーティリティークラスを使用して Hibernate セッションを取得します。

5. Hibernate ライブラリ (org.hibernate.Query、org.hibernate.Session) と java.util.List に対するインポート文を追加するように、インポートを修正します。
6. デザインビューに切り替えて「クエリー」ボタンをダブルクリックすることで、「クエリー」ボタンイベントハンドラを作成します。

   IDE で queryButtonActionPerformed メソッドが作成され、このメソッドがソースビューに表示されます。

7. ユーザーがボタンをクリックしたときにクエリーが実行されるよう、ソースビューの queryButtonActionPerformed メソッドに次のコードを追加して変更します。

   private void queryButtonActionPerformed(java.awt.event.ActionEvent evt) {                                            
       if(!firstNameTextField.getText().trim().equals("")) {
           runQueryBasedOnFirstName();
       } else if(!lastNameTextField.getText().trim().equals("")) {
           runQueryBasedOnLastName();
       }
   }

8. 次のメソッドを追加し、結果が JTable に表示されるようにします。

   private void displayResult(List resultList) {
       Vector<String> tableHeaders = new Vector<String>();
       Vector tableData = new Vector();
       tableHeaders.add("ActorId"); 
       tableHeaders.add("FirstName");
       tableHeaders.add("LastName");
       tableHeaders.add("LastUpdated");
   
       for(Object o : resultList) {
           Actor actor = (Actor)o;
           Vector<Object> oneRow = new Vector<Object>();
           oneRow.add(actor.getActorId());
           oneRow.add(actor.getFirstName());
           oneRow.add(actor.getLastName());
           oneRow.add(actor.getLastUpdate());
           tableData.add(oneRow);
       }
       resultTable.setModel(new DefaultTableModel(tableData, tableHeaders));
   }

9. java.util.Vector を追加するようにインポートを修正し、変更内容を保存します。

フォームの保存後、プロジェクトを実行できます。

プロジェクトの実行

これでコーディングが終了したので、アプリケーションを起動できます。プロジェクトを実行する前に、プロジェクトのプロパティーのダイアログでアプリケーションの主クラスを指定する必要があります。主クラスが指定されていない場合は、アプリケーションの初回起動時に主クラスを設定するよう求められます。

1. 「プロジェクト」ウィンドウでプロジェクトのノードを右クリックし、「プロパティー」を選択します。
2. 「プロジェクトプロパティー」ダイアログで「実行」カテゴリを選択します。
3. 「主クラス」に「sakila.ui.DVDStoreAdmin」と入力します。「了解」をクリックします。

   または、「参照」ボタンをクリックし、ダイアログで主クラスを選択できます。

   
4. メインツールバーの「主プロジェクトを実行」をクリックし、アプリケーションを起動します。

検索文字列を「名」または「姓」テキストフィールドに入力し、「クエリー」をクリックして俳優を検索し、詳細を確認します。

IDE の「出力」ウィンドウを見ると、表示された結果を取得した SQL クエリーを確認できます。

個別の POJO およびマッピングファイルの作成

POJO は単純な Java クラスのため、新規「Java クラス」ウィザードを使用してクラスを作成し、そのクラスをソースエディタで編集して、必要なフィールドや取得メソッドおよび設定メソッドを追加できます。POJO の作成後、ウィザードを使用して Hibernate マッピングファイルを作成し、そのクラスを表にマップしてマッピング情報を hibernate.cfg.xml に追加します。マッピングファイルを最初から作成する場合、XML エディタでフィールドを列にマップする必要があります。

注: この課題は任意であり、「データベースからの Hibernate のマッピングファイルと POJO」ウィザードを使用して作成した POJO とマッピングファイルの作成方法を説明します。

1. 「プロジェクト」ウィンドウの「ソースパッケージ」ノードを右クリックし、「新規」>「Java クラス」を選択して「新規 Java クラス」ウィザードを開きます。
2. このウィザードで、クラス名に「Actor」と入力し、パッケージに「sakila.entity」と入力します。「完了」をクリックします。
3. 次のボールドで表示されている変更をクラスに加え、シリアライズ可能なインタフェースを実装して、表の列のフィールドを追加します。

   public class Actor implements Serializable {
       private Short actorId;
       private String firstName;
       private String lastName;
       private Date lastUpdate;
   }

4. フィールドに対する取得メソッドと設定メソッドは、挿入カーソルをソースエディタに置き、Alt-Insert キーを押して「取得メソッドおよび設定メソッド」を選択することで生成します。
5. 「取得メソッドおよび設定メソッドの生成」ダイアログですべてのフィールドを選択し、「生成」をクリックします。
   

   「取得メソッドおよび設定メソッドの生成」ダイアログでは、キーボードの上矢印キーを使用して、選択した項目を Actor ノードまで移動してから、スペースバーを押して Actor 内のすべてのフィールドを選択できます。

6. インポートを修正して変更内容を保存します。

表のための POJO の作成後、Actor.java の Hibernate マッピングファイルを作成します。

1. 「プロジェクト」ウィンドウで「sakila.entity」ノードを右クリックし、「新規」>「その他」を選択して「新規ファイル」ウィザードを開きます。
2. 「Hibernate」カテゴリの「Hibernate のマッピングファイル」を選択します。「次へ」をクリックします。
3. 「ファイル名」に「Actor.hbm」と入力し、フォルダが「src/sakila/entity」であることを確認します。「次へ」をクリックします。
4. 「マップするクラス」に「sakila.entity.Actor」と入力し、「データベース表」ドロップダウンリストから「actor」を選択します。「完了」をクリックします。
   

   「完了」をクリックすると、Actor.hbm.xml Hibernate のマッピングファイルがソースエディタで開きます。また、IDE でマッピングリソースに対するエントリが hibernate.cfg.xml に自動的に追加されます。このエントリの詳細は、hibernate.cfg.xml のデザインビューで「マッピング」ノードを展開するか、または XML ビューで表示できます。XML ビューの mapping エントリは、次のようになります。

           <mapping resource="sakila/entity/Actor.hbm.xml"/>
       </session-factory>
   </hibernate-configuration>

5. 次のボールド部分の変更を Actor.hbm.xml に行なって、Actor.java のフィールドを ACTOR 表の列にマップします。

   <hibernate-mapping>
     <class name="sakila.entity.Actor" table="actor">
       <id name="actorId" type="java.lang.Short">
         <column name="actor_id"/>
         <generator class="identity"/>
       </id>
       <property name="firstName" type="string">
         <column length="45" name="first_name" not-null="true"/>
       </property>
       <property name="lastName" type="string">
         <column length="45" name="last_name" not-null="true"/>
       </property>
       <property name="lastUpdate" type="timestamp">
         <column length="19" name="last_update" not-null="true"/>
       </property>
     </class>
   </hibernate-mapping>

   エディタでコード補完を使用し、マッピングファイルの変更時に値を補うことができます。

   注: デフォルトでは、生成される class 要素には終了タグがあります。開始と終了の class 要素タグの間にプロパティー要素を追加する必要があるため、次のボールドの変更を加えます。変更後、class タグの間でコード補完を使用できます。

   <hibernate-mapping>
     <class name="sakila.entity.Actor" table="actor">
     </class>
   </hibernate-mapping>

6. ツールバーの「XML の妥当性検査」ボタンをクリックし、変更内容を保存します。

POJO と Hibernate のマッピングファイルを個別に作成すると、アプリケーションをさらにカスタマイズするときに役立つ場合があります。

関連項目

Swing GUI アプリケーションの作成に関する追加情報は、次のチュートリアルを参照してください。

• NetBeans IDE での Swing GUI のデザイン
• Java デスクトップデータベースアプリケーションの構築
• GUI 構築入門
• Java GUI アプリケーションの学習