Hibernate を使用した Maven Swing アプリケーションの作成 - NetBeans IDE チュートリアル

このチュートリアルでは、NetBeans IDE を使用して、Maven の原型から Java Swing アプリケーションを作成します。このアプリケーションでは Hibernate フレームワークを持続性レイヤーとして使用し、リレーショナルデータベースから POJO (plain old Java objects) を取得します。このチュートリアルでは、IDE のウィザードを使用して必要な Hibernate ファイルを作成し、Hibernate の依存リソースを POM に追加する方法をデモンストレーションします。Java オブジェクトを作成し、Hibernate を使用するようにアプリケーションを構成したあと、データを検索および表示する GUI インタフェースを作成します。

Maven のサポートは NetBeans IDE に完全に統合され、Maven 3 は NetBeans IDE 7.0 以降の IDE にバンドルされています。バンドルされた Maven の原型から、または「新規プロジェクト」ウィザード内のリモートリポジトリの原型からアプリケーションを作成できます。「Maven リポジトリブラウザ」では、ローカルおよびリモートの Maven リポジトリの操作、アーティファクトの調査、プロジェクトの POM へのプロジェクト依存リソースの追加を行えます。

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

Maven Java EE アプリケーションを構築するには、「Maven を使用したエンタープライズアプリケーションの作成」を参照してください。

目次

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

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

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

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

• NetBeans 6.x での Apache Maven のベストプラクティス
• Chapter 1. Introducing Apache Maven (『Maven: The Definitive Guide』)
• hibernate.org の Hibernate ドキュメント
• GUI 構築入門
• 「MySQL データベースへの接続」チュートリアル

完了したプロジェクトの 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 データベース」を選択します。「了解」をクリックします。
   

   「了解」をクリックすると、Sakila データベースを作成し、データベース表を生成するためのスクリプトが IDE によって実行されます。スクリプトを実行した結果は、「出力」ウィンドウで確認できます。「MySQL サーバー」ノードの下に Sakila データベースのノードも追加されます。

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

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

Maven の構成

以前に IDE で Maven プロジェクトを作成したことがない場合は、最初に IDE で Maven モジュールを有効化する必要があります。これは、「新規プロジェクト」ウィザードで Maven プロジェクトの原型を選択することによって実行できます。原型を選択すると、IDE によって、このモジュールが自動的に有効にされます。IDE で Maven を有効にするために、このウィザードを完了する必要はありません。

これがはじめての Maven プロジェクトである場合は、「オプション」ウィンドウで Maven の構成設定を確認します。このチュートリアルを完了するには、ローカルシステムに Maven がインストールされている必要があります。NetBeans IDE 7.0 または 7.1 を使用している場合、Maven は IDE にバンドルされており、IDE をインストールするとインストールされます。以前のバージョンの IDE を使用している場合は、Maven のサイトからインストーラをダウンロードできます。

1. 「オプション」ウィンドウの「その他」カテゴリを選択して、「Maven」タブをクリックします。
2. 「Maven のホーム」が指定されていることを確認します。

   NetBeans IDE 7.0 で IDE にバンドルされ、デフォルトで指定されている Maven 3 インストールを使用するか、または Maven のローカルインストールの場所を指定することができます (2.0.9 以降が必要です)。

3. Maven のローカルリポジトリの場所が正しいことを確認します。
4. 「了解」をクリックします。

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

このチュートリアルでは、DVDStoreAdmin という名前の、簡単な Java Swing アプリケーションプロジェクトを作成します。バンドルされた Maven の原型の 1 つからプロジェクトを作成し、デフォルトのプロジェクト設定を変更します。

Hibernate のファイルと依存リソースの追加

Hibernate に対するサポートを追加するには、必要なアーティファクトを POM で依存リソースとして宣言することで、Hibernate ライブラリを使用可能にする必要があります。IDE には、プロジェクトに必要な Hibernate ファイルの作成に役立つウィザードが複数用意されています。IDE のウィザードを使用し、Hibernate 構成ファイルとユーティリティーヘルパークラスを作成できます。ウィザードを使用して Hibernate 構成ファイルを作成すると、自動的に POM が更新され、Hibernate の依存リソースがプロジェクトに追加されます。

プロジェクトへの依存リソースの追加は、「プロジェクト」ウィンドウで行うか、または pom.xml を直接編集して行います。「プロジェクト」ウィンドウで依存リソースを追加するには、「プロジェクト」ウィンドウの「ライブラリ」ノードを右クリックし、ポップアップメニューから「依存リソースを追加」を選択して「依存リソースを追加」ダイアログを開きます。依存リソースを追加すると、POM が更新され、まだローカルにない必須のアーティファクトがローカルリポジトリにダウンロードされます。

pom.xml を直接編集するには、「プロジェクト」ウィンドウで「プロジェクトファイル」ノードを展開し、pom.xml をダブルクリックしてファイルを開きます。

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

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

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

注: 複数の表用にファイルを作成する場合は、このウィザードを使用すると便利です。このチュートリアルでは、POJO を 1 つとマッピングファイルを 1 つ作成する必要があるだけなので、ファイルを個々に作成するほうがはるかに簡単です。POJO とマッピングファイルを個別に作成する手順については、このチュートリアルの最後に紹介します。

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

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

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

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

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

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

この課題では、HQL エディタを使用して、姓または名の一致に基づいて俳優の詳細リストを取得する、簡単な HQL クエリーを構築します。クエリーをクラスに追加する前に、HQL クエリーエディタを使用して、接続が正しく動作し、クエリーで目的の結果が生成されることをテストします。このクエリーを実行するには、まずアプリケーションをコンパイルする必要があります。

1. プロジェクトノードを右クリックし、「構築」を選択します。

   「構築」をクリックすると、IDE によって、必要なアーティファクトが Maven のローカルリポジトリにダウンロードされます。

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

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

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

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

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

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

   select actor0_.actor_id as col_0_0_ from sakila.actor actor0_ where (actor0_.first_name like 'PE%' )

6. 新しい 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 を追加するようにインポートを修正し (Ctrl-Shift-I)、変更内容を保存します。

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

Maven プロジェクトの実行

これでコーディングが終了したので、プロジェクトを構築してアプリケーションを起動できます。IDE で Maven プロジェクトを構築すると、Maven はプロジェクトの POM を読み取ってプロジェクトの依存リソースを特定します。依存リソースとして指定されたすべてのアーティファクトは、プロジェクトの構築のため、ローカルの Maven リポジトリ内にある必要があります。必須のアーティファクトがローカルリポジトリにない場合、Maven は、プロジェクトを構築および実行する前に、アーティファクトをリモートリポジトリからチェックアウトします。プロジェクトの構築後、Maven は結果のバイナリをアーティファクトとしてローカルリポジトリにインストールします。

注:

このアプリケーションをコンパイルして起動するには、次のタスクを実行します。

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

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

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

IDE の Maven プロジェクトで「実行」アクションを呼び出すと、IDE は「実行」アクションに関連付けられた Maven ゴールを実行します。IDE には、プロジェクトのパッケージに応じて IDE のアクションにバインドされたデフォルトのゴールがあります。プロジェクトの「プロパティー」ウィンドウの「アクション」区画で、「実行」アクションにバインドされたゴールを表示できます。

アクションに対するゴールのバインドは、プロジェクトの「プロパティー」ウィンドウにある「アクション」区画でカスタマイズできます。

アプリケーションを起動すると、GUI フォームが表示されます。検索文字列を「名」または「姓」テキストフィールドに入力し、「クエリー」をクリックして俳優を検索し、詳細を確認します。

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/main/resources/sakila/entity に設定します。「次へ」をクリックします。
4. 「マップするクラス」に「sakila.entity.Actor」と入力します。
5. 選択されていない場合、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>

6. 次のボールド部分の変更を 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>

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

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

関連項目

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

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