Interstage Studio V12.0.0 ユーザーズガイド Java EE 6編

4.2.3 開発手順

以下に、実際にアプリケーションを開発する手順を説明します。

1) データベースの準備

2) 永続性ユニットの作成

3) Entityの作成

4) ロジッククラスの作成

5) Webアプリケーションの作成

6) Interstage Application ServerのJDBC設定

7) アプリケーションの動作確認

8) 運用環境へのアプリケーションの配布

1) データベースの準備

データベースはDerby(Java DB)を使用します。国名と総人口のデータを格納するデータベースのテーブルを作成し、アプリケーションの実行に必要なデータを挿入します。また、ワークベンチからデータベースに接続できる環境を整える必要があります。
これらについては、"8.2 入門"で説明していますので、そちらを参照してください。

2) 永続性ユニットの作成

2-1) プロジェクトの作成

メニューバーから[ファイル] > [新規] > [プロジェクト]を選択すると、[新規プロジェクト]ウィザードが表示されます。

[新規プロジェクト]ウィザードから[Web] > [動的 Web プロジェクト]を選択して、[次へ]をクリックします。

以下の設定項目を確認、入力してください。

設定項目	設定内容
プロジェクト名	JPASample6
ターゲット・ランタイム	Interstage Application Server V12.0 (Java EE 6)

次に[構成]の[変更]をクリックします。

[プロジェクト・ファセット]ページで[JPA]をチェックして[OK]をクリックします。

[次へ]をクリックすると、[Java]ページが表示されます。

以下の情報を確認後、[次へ]をクリックします。

設定項目	設定内容
ビルド・パス上のソース・フォルダー	src
デフォルト出力フォルダー	build\classes

[JPA ファセット]ページが表示されます。

以下の設定項目を確認、入力後、[次へ]をクリックします。

設定項目	設定内容
プラットフォーム	Generic 2.0
JPA実装	ライブラリー構成を無効
接続	Derby_Studio
永続化クラス管理	注釈付きクラスを自動的に発見

[Webモジュール]ページが表示されます。

以下の設定項目を確認、入力後、[完了]をクリックします。

設定項目	設定内容
コンテキスト・ルート	JPASample6
コンテンツ・ディレクトリー	WebContent
web.xmlデプロイメント記述子の生成	チェックする

ポイント

• プラットフォームには"Generic 2.0"のほかに、参照実装の"EclipseLink"が利用できます。

• [接続]には、データベースに接続している接続プロファイルを指定することで、データベースのテーブルや列の情報をJPA詳細ビューなどで利用することができます。

2-2) persistence.xmlファイルの編集

Entityに関連付けるデータベースのJDBC Resourceをpersistence.xmlに記述します。
作成したプロジェクト（JPASample6）を選択して、[JPA コンテンツ] > [persistence.xml]をダブルクリックして永続化 XMLエディタで開きます。
永続化 XMLエディタの[接続]タブを選択して、JDBC Resourceの定義を以下のように設定します。

設定項目	設定内容
トランザクション・タイプ	デフォルト(JTA)
JTA データ・ソース	jdbc/Derby

3) Entityの作成

データベースのテーブルとマッピングするEntityを作成します。

ポイント

以下では、JPA構造ビューとJPA詳細ビューの使用方法を説明するため、Javaクラスを作成して、それにデータベースを対応付ける方法を説明していますが、データベースのテーブルからEntityを生成することもできます。詳細は、"4.3.3.4 テーブルからエンティティクラスを生成する"を参照してください。

3-1)エンティティの作成

作成したプロジェクトを選択して、右クリックでコンテキストメニューから[新規] > [JPA エンティティー]を選択します。

以下の設定項目を確認、入力してください。情報を設定後、[次へ]をクリックします。

設定項目	設定内容
プロジェクト	JPASample6
ソース・フォルダー	\JPASample6\src
Java パッケージ	sample6.jpa
クラス名	CountryData
継承	エンティティー
XMLのエンティティー・マッピングに追加	チェックしない

[エンティティー・プロパティー]ページが表示されます。

以下の設定項目を確認、入力してください。以下の情報を設定後、[完了]をクリックします。

設定項目	設定内容
エンティティー名	CountryData
デフォルトを使用	チェックしない(チェックを外す)
テーブル名	C_DATA
エンティティー・フィールド	以下のフィールドを追加します
アクセス・タイプ	フィールド

キー	名前	型
チェックする	id	int
チェックしない	countryName	java.lang.String
チェックしない	totalPopulation	int

3-2) テーブルとの関連付け

EntityのCountryDataクラスとデータベースのC_DATAテーブルを関連付けます。

まず、[ウィンドウ] > [パースペクティブ] > [パースペクティブを開く] > [JPA]をクリックし、JPAパースペクティブを開きます。

CountryDataクラスをJavaエディタで開き、[JPA構造]ビューでCountryDataクラスを選択します。[JPA詳細]ビューで[テーブル]グループの[名前]に"C_DATA"が設定されていることを確認します。

ポイント

データベースに接続していない場合にはコンボボックスに候補は表示されませんが、テーブル名を直接指定することはできます。

以下の設定項目を確認、選択してください。

設定項目	設定内容
テーブル：名前	C_DATA
テーブル：カタログ	デフォルト
テーブル：スキーマ	STUDIO
名前	デフォルト (CountryData)

3-3) 列との関連付け

エンティティフィールドとテーブルの列を関連付けます。

[JPA構造]ビューと[JPA詳細]ビューを使い、以下のように各フィールドと列を対応付けます。

フィールド	列：名前	列：テーブル
id	ID	デフォルト(C_DATA)
countryName	C_NAME	デフォルト(C_DATA)
totalPopulation	T_POP	デフォルト(C_DATA)

これまでの手順で以下のようなソースが作成されます。

CountryDataクラス

package sample6.jpa;

import java.io.Serializable;
import java.lang.String;
import javax.persistence.*;
 
/**
 * Entity implementation class for Entity: CountryData
 *
 */
@Entity
@Table(name="C_DATA", schema = "STUDIO")
public class CountryData implements Serializable {

    @Id
    @Column(name="ID")
    private int id;
    @Column(name="C_NAME")
    private String countryName;
    @Column(name="T_POP")
    private int totalPopulation;
    private static final long serialVersionUID = 1L;

    public CountryData() {
        super();
    }
    public int getId() {
        return this.id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getCountryName() {
        return this.countryName;
    }
    public void setCountryName(String countryName) {
        this.countryName = countryName;
    }
    public int getTotalPopulation() {
        return this.totalPopulation;
    }
    public void setTotalPopulation(int totalPopulation) {
        this.totalPopulation = totalPopulation;
    }

}

4) ロジッククラスの作成

データベースへの問合せなどを行うPopulationRankingクラスを作成します。

4-1) クラスの作成

作成したプロジェクトを選択して、右クリックでコンテキストメニューから[新規] > [クラス]を選択します。[新規Javaクラス]ウィザードが表示されます。

以下の設定項目を確認、入力してください。以下の情報を設定後、[完了]をクリックします。

設定項目	設定内容
ソース・フォルダー	JPASample6/src
パッケージ	sample6.jpa
名前	PopulationRanking

4-2) ロジッククラスの実装

Entityは、javax.persistence.EntityManagerクラスにより管理されています。このクラスを作成するjavax.persistence.EntityManagerFactoryクラスを引数にしたコンストラクタを追加します。PopulationRankingクラスはWebアプリケーションのサーブレットクラスで使用されるので、この引数はサーブレットクラスから渡されます。以下のコードをPopulationRankingクラスに追加します。

コンストラクタの追加

package sample6.jpa;

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

public class PopulationRanking {
    private EntityManager em;
    
    public PopulationRanking(EntityManagerFactory factory) {
        this.em = factory.createEntityManager();
    }
}

ポイント

必要な実装をコーディングした後にJavaエディタ上で右クリックし、コンテキストメニューから[ソース] > [インポートの編成]を行うと、プロジェクトに設定されたクラスパスに従った適切なimport文が挿入できます。

C_DATAテーブルからIDに対する総人口ランキングを取得するメソッドを追加します。C_DATAテーブルとマッピングしているCountryDataクラスを取得するには、EntityManagerインスタンスのfindメソッドを使用します。テーブルのデータが総人口の多い順番に格納されているので、順位とIDは同じ値になります。

以下のコードをPopulationRankingクラスに追加します。

総人口ランキングを取得するメソッドの追加

public CountryData getCountryData(int rank) {
    if (rank < 1 || rank > 10) {
        return null;
    }
    CountryData country = em.find(CountryData.class, rank);
    return country;
}

5) Webアプリケーションの作成

JPAアプリケーションを呼び出すWebアプリケーションを作成します。

5-1) サーブレットクラスの作成

サーブレットクラスを作成します。プロジェクトを選択して、右クリックでコンテキストメニューから[新規] > [サーブレット]を選択します。[サーブレット作成]ウィザードが表示されます。

以下の設定項目を確認、入力してください。以下の情報を設定後、[次へ]をクリックします。

設定項目	設定内容
プロジェクト	JPASample6
ソース・フォルダー	/JPASample6/src
Java パッケージ	sample6.jpa
クラス名	ServletController
スーパークラス	javax.servlet.http.HttpServlet

以下の設定項目を確認、何も変更せずに、[次へ]をクリックします。

設定項目	設定内容
名前	ServletController
URL マッピング	/ServletController

設定項目	設定内容
修飾子	public
どのメソッド・スタブを作成しますか?	スーパークラスからのコンストラクター 継承された抽象メソッド doPost（doGetのチェックを外す）

5-2) Dependency Injectionの指定

ロジッククラスを呼び出すための実装をサーブレットクラスに行います。
PopulationRankingクラスを作成するためには、コンストラクタにjavax.persistence.EntityManagerFactoryが必要になります。EntityManagerFactoryのフィールドを作成して、以下のようにPersistenceUnitアノテーションを設定し、Dependency Injectionの指定を行います。

PersistenceUnitアノテーションの定義

@PersistenceUnit
private EntityManagerFactory emf;

ポイント

J2EE1.4までのlookupメソッドの代わりに、Java EEではDependency Injectionを利用することで、オブジェクトを取得して使用することができます。(オブジェクトは実行時に自動的にJava EEコンテナによってフィールドに設定されます。)

5-3) サーブレットクラスの実装

以下のようにロジッククラスのインスタンスを作成し、メソッドを呼び出します。

Entityの呼び出しメソッドの定義

PopulationRanking ranking = new PopulationRanking(emf);
CountryData country = ranking.getCountryData(rank);

実装を行ったサーブレットクラスは以下のようになります。
赤字の部分が追加した定義になります。

サーブレットクラス(ServletController.java)

package sample6.jpa;

import java.io.IOException;

import javax.persistence.EntityManagerFactory;
import javax.persistence.PersistenceUnit;
import javax.servlet.RequestDispatcher;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.Webservlet;
import javax.servlet.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Servlet implementation class ServletController
 */
@WebServlet("/ServletController")
public class ServletController extends javax.servlet.http.HttpServlet {
    private static final long serialVersionUID = 1L;

    //@PersistenceUnit
    @PersistenceUnit
    private EntityManagerFactory emf;

   /**
    * @see HttpServlet#HttpServlet()
    */
    public ServletController() {
        super();
        // TODO Auto-generated constructor stub
    }

   /**
    * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
    */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        request.setCharacterEncoding("UTF-8");
        ServletContext sc = getServletContext();

        // 呼び出すファイル種別取得
        String mode = request.getParameter("mode");
        if (mode != null && mode.equals("top")) {
            // 入力画面のHTMLファイル呼出し
            RequestDispatcher inRd = getServletContext().getRequestDispatcher("/default.jsp");
            inRd.forward(request, response);
            return;
        }

        int rank;

        // 入力チェック
        try{
            rank = Integer.parseInt(request.getParameter("rank"));
        } catch (NumberFormatException e){
            RequestDispatcher errRd = sc.getRequestDispatcher("/error.jsp");
            errRd.forward(request, response);
            return;
        }

        PopulationRanking ranking = new PopulationRanking(emf);
        CountryData country = ranking.getCountryData(rank);

        //取得した値の確認
        if (country == null){
            RequestDispatcher errRd = sc.getRequestDispatcher("/error.jsp");
            errRd.forward(request, response);
            return;
        }

        sc.setAttribute("ranking", country);

        RequestDispatcher outRd = sc.getRequestDispatcher("/result.jsp");
        outRd.forward(request, response);
    }
}

ポイント

必要な実装をコーディングした後にJavaエディタ上で右クリックし、コンテキストメニューから[ソース] > [インポートの編成]を行うと、プロジェクトに設定されたクラスパスに従った適切なimport文が挿入できます。

5-4) 入出力画面の作成

入出力画面のJSPを作成します。作成したプロジェクトを選択して、右クリックでコンテキストメニューから[新規] > [JSP ファイル]を選択します。[新規 JSP ファイル]ウィザードが表示されます。

以下の設定項目を確認、入力してください。以下の情報を設定後、[次へ]をクリックします。

設定項目	設定内容
親フォルダーを入力または選択	JPASample6/WebContent
ファイル名	default.jsp

以下の設定項目を確認、入力してください。以下の情報を設定後、[完了]をクリックします。

設定項目	設定内容
JSP テンプレートの使用	チェックする
名前	新規 JSP ファイル (html)

作成されたJSPファイルの赤字の部分を修正します。JSPファイルの編集については、"2.3.4.2 JSPファイルの編集"を参照してください。

入力画面(default.jsp)

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>世界総人口ランキング</title>
</head>
<body>
<h1>入力画面</h1>
<p>1～10の間で順位を入力してください。</p>
<p></p>
<form action="ServletController" method="post">
    順位：<br>
    <input name="rank" type="text" size="10">位<br>
    <p></p>
    <input type="submit" value="OK">
    <input type="reset" value="クリア">
</form>

</body>
</html>

入力画面と同様に、出力画面とエラー画面をウィザードで作成して赤字の部分を修正します。

出力画面(result.jsp)

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>世界総人口ランキング</title>
</head>
<body>
<h1>出力画面</h1>
総人口ランキング${param.rank}位は「${applicationScope.ranking.countryName}」です。<br>
総人口は${applicationScope.ranking.totalPopulation}人です。
<br>
<hr>
<form action="ServletController" method="post">
    <input type="submit" value="入り口に戻る">
    <input type="hidden" name="mode" value="top">
</form>

</body>
</html>

エラー画面(error.jsp)

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>世界総人口ランキング</title>
</head>
<body>
<h1>エラー画面</h1>
指定された範囲内の順位が入力されていないか、またはサーバエラーです。<br>
<br>
<hr>
<form action="ServletController" method="post">
    <input type="submit" value="入り口に戻る">
    <input type="hidden" name="mode" value="top">
</form>

</body>
</html>

6) Interstage Application ServerのJDBC設定

Java EEコンテナからDerbyデータベースを使用できるように、JDBCの環境を設定します。

JDBCドライバのクラスパスの設定など、Interstage Application ServerのJDBC設定の詳細については、"Interstage Application Server Java EE運用ガイド(Java EE 6編)"の"データベースの環境設定"を参照してください。

なお、Derbyの場合、JDBCドライバはアプリケーションサーバに同梱されているため、クラスパスの設定は不要です。

6-1) JDBC Connection Poolの作成

asadminコマンドのcreate-jdbc-connection-poolサブコマンドを使って、DerbyのJDBC Connection Poolを作成します。

asadmin create-jdbc-connection-pool --datasourceclassname org.apache.derby.jdbc.ClientDataSource40 --restype javax.sql.DataSource --property User=user:Password=usr:DatabaseName=COUNTRYDATA:ServerName=localhost:PortNumber=1527 DerbyPool_Studio

6-2) JDBC Resourceの作成

作成したJDBC Connection Poolに対応するJDBC Resourceを作成します。

asadmin create-jdbc-resource --target server --connectionpoolid DerbyPool_Studio jdbc/Derby

7) アプリケーションの動作確認

7-1) プロジェクトとサーバの関連付け

サーバビューでサーバを選択し、コンテキストメニューから[追加および除去]を選択します。
使用可能から作成した動的Webプロジェクトを選択し、[追加]をクリックします。

以下の情報を確認後、[完了]をクリックします。

設定項目	設定内容
構成済み	JPASample6

ポイント

サーバビューに配備先となるサーバが登録されていない場合は、サーバを追加する必要があります。サーバを追加する方法については、"6.2.7 アプリケーションの動作確認"を参照してください。

7-2) ブレークポイントの設定

ロジッククラスのgetCountryData()メソッドの先頭行にブレークポイントを設定します。ブレークポイントは、エディタの左側のルーラー部分をダブルクリックして、設定または解除します。

7-3) サーバの起動

サーバビューでサーバを選択し、コンテキストメニューから[デバッグ]を選択します。

ポイント

デバッガを使用せず単純にアプリケーションを起動したい場合には、コンテキストメニューから[開始]を選択します。

サーバビューで以下の情報を確認してください。

確認項目	確認内容
サーバの状態	デバッグ
サーバの状況	同期済み
動的Webプロジェクト（JPASample6）の状況	同期済み

7-4) アプリケーションの実行

サーバビューで、配備されているWebプロジェクト（JPASample6）を選択して、コンテキストメニューから[Webブラウザ]を選択します。Webブラウザが起動されて、入力画面が開きます。

設定項目	設定内容(例)
入力画面のURL	http://localhost:28282/JPASample6/

[順位:]の入力フィールドに人口ランキングの順位を入力して、[OK]をクリックします。

注意

接続確認のURLに指定されるポート番号については、"6.2.7 アプリケーションの動作確認"のHTTPポート番号を参照してください。

ポイント

プロジェクトを選択し、コンテキストメニューから[実行] > [サーバーで実行]または[デバッグ] > [サーバーでデバッグ]を選択することで、サーバの追加、プロジェクトの追加、サーバの起動、クライアントの起動をまとめて行うことができます。
また、クライアントとして使用するWebブラウザは、メニュー [ウィンドウ] > [Web ブラウザ] から変更することができます。

7-5) アプリケーションのデバッグ

アプリケーションが動作し、ブレークポイントで中断されます。変数ビューの表示を確認します。メニューから[実行] > [ステップ・オーバー]を選択し、変数ビューでプログラムの状況を確認します。デバッグについては、"6.2.7.1 デバッグする"を参照してください。

ポイント

変数ビューでは値の確認だけでなく、変更も行うことができます。

デバッガで中断している処理は、メニューから[実行] > [再開]を選択することで再開され、サーバ側での処理が終了し、Webブラウザに出力画面が表示されます。入力した順位の国名と総人口が表示されることを確認してください。

8) 運用環境へのアプリケーションの配布

アプリケーションを運用環境に配布するには、WARファイルを作成する必要があります。作成したWARファイルは、サーバの配備機能を利用して、サーバに配備します。

8-1) アプリケーションのエクスポート

WARファイルの作成は、エクスポートウィザードから行います。エクスポートウィザードを起動するには、[ファイル] > [エクスポート]を選択します。[エクスポート]ウィザードから[Web] > [WARファイル]を選択し、[次へ]をクリックします。

[WARエクスポート]ページが表示されます。

以下の設定項目を確認、入力してください。以下の情報を設定後、[完了]をクリックします。

設定項目	設定内容
Web プロジェクト	動的Webプロジェクトを指定します。
宛先	WARファイルの作成先を指定します。

"Interstage Application Server V12.0 (Java EE 6)"の場合、[エクスポート]ウィザードの[特定のサーバー・ランタイムに最適化]の指定は、エクスポート結果に影響しません。

8-2) 運用環境に配備する

運用環境への配備はサーバの配備機能を利用します。asadminコマンドを使い、WARファイルを配備してください。