8.3.1. ウェブプロジェクトの初期セットアップ

ウェブプロジェクトの初期セットアップでは以下を行う。

  • ウェブプロジェクトの生成
  • ウェブプロジェクトの動作確認

8.3.1.1. 生成するプロジェクトの概要

本手順で生成するプロジェクトの概要は以下の通りである。

項目 説明
プロジェクト種別 Mavenプロジェクト
プロジェクト構成 単一プロジェクト構成
使用DB H2 Databaes Engine(アプリケーションに組み込み)
組み込まれているアダプタ ルーティングアダプタ(詳細は、 ルーティングアダプタ を参照)
生成するプロジェクトに含まれるもの

生成されたプロジェクトには以下が含まれる。

  • Nablarchのウェブアプリケーション用の基本的な設定
  • 疎通確認用ウェブアプリケーション
  • Mavenと連動して動作するツールの初期設定( nablarch-archetype-parent(親プロジェクト) を参照することによって取り込んでいる)。

他のプロジェクトとの関係、及びディレクトリ構成は、 Mavenアーキタイプの構成 を参照。

8.3.1.2. ブランクプロジェクト作成

Nablarchが提供するアーキタイプを使用してブランクプロジェクトを生成する。

8.3.1.2.1. mvnコマンドの実行

Maven Archetype Plugin(外部サイト、英語) を使用して、ブランクプロジェクトを生成する。

カレントディレクトリを、ブランクプロジェクトを作成したいディレクトリ(任意のディレクトリで可)に変更し、以下のファイルを配置する。

バッチファイル

配置後、引数に必要なパラメータを指定しbatファイルを実行する。

generateWebProject.bat 5u20 <<groupId>> <<artifactId>> <<version>> <<package(任意)>>

上記コマンドに設定するパラメータは以下の通り。 なお、nablarchのバージョンを変更したい場合には 5u20 を変更すること。

入力項目 説明 設定例
groupId グループID（通常はパッケージ名を入力） com.example
artifactId アーティファクトID myapp-web
version バージョン番号 0.1.0
package パッケージ(通常はグループIDと同じ) com.example

重要

項目groupIdおよびpackageは、Javaのパッケージ名にマッピングされる。 よって、これらの入力値には、英小文字、数字、ドットを使用し、ハイフンは使用しないこと。

コマンドが正常終了した場合、ブランクプロジェクトがカレントディレクトリ配下に作成される。

8.3.1.3. 疎通確認

8.3.1.3.1. 自動テスト

アーキタイプから生成したプロジェクトには、以下のユニットテストが含まれている。

ユニットテストのクラス テスト内容
SampleActionRequestTest Nablarchのテスティングフレームワークを使用して、画面が表示可能であるかを確認する。

ユニットテストを実行することで、ブランクプロジェクトの生成に成功していることを確認する。

以下のコマンドを実行する。

cd myapp-web
mvn test

補足

ここで使用しているMavenの「clean」「test」は、MavenのBuilt-in Lifecycleである。

他にどのようなLifecycleが存在するかについては、 Built-in Lifecycle Bindings(外部サイト、英語) を参照。

実行に成功すると、以下のようなログがコンソールに出力される。

(中略)
[INFO] ------------------------------------------------------------------------
[INFO] Building myapp-web 0.1.0
[INFO] ------------------------------------------------------------------------
(中略)
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
(以下略)

8.3.1.3.2. 起動確認

生成したプロジェクトには、以下の画面が含まれている。

画面表示に使用するクラス 内容
SampleAction ウェブアプリケーション実装する際に一般的に使用するNablarchの機能についての動作確認。

ブラウザで画面を表示することで、ブランクプロジェクトの生成に成功していることを確認する。

まだ、生成したプロジェクトにカレントディレクトリを移動していない場合は移動する。

cd myapp-web

次に、以下のコマンドを実行し、ウェブアプリケーションをビルドする。

mvn compile

その後、以下のコマンドを実行することで、モジュールwebで疎通確認用のアプリケーションを起動する。

mvn waitt:run

補足

上記のコマンド例で使用しているMavenの「waitt:run」は、 waitt maven pluginのrunゴールを使用するという指定である。

waitt maven pluginについては waitt maven plugin(外部サイト、英語) を参照。

起動に成功するとブラウザが自動的に立ち上がり、疎通確認画面が表示される。表示されたページの内容を読み、成功していることを確認する。

また、ログを確認しエラーが出ていないことを確認する。

8.3.1.3.3. 疎通確認になぜか失敗する場合

原因は分からないが疎通確認に失敗する場合、どこかで手順を誤っている可能性がある。

原因が分からない場合は、ブランクプロジェクト作成 からやり直してみること。

8.3.1.4. 補足（web.xml）

JNDI経由で接続を取得させる場合、web.xmlに<resource-ref>要素を定義する必要があるが、 管理を容易にするため、web.xmlは、環境別にわけず、共用するようにしている。

本番環境のみJNDI経由で接続を取得する場合、<resource-ref>要素の定義はローカルＰＣの開発環境向けの設定としては不要なものとなるが、 アプリケーション内でその定義を使用するコードを書かない限り、<resource-ref>要素は使用されない。 よって、ローカルＰＣの開発環境内でのアプリケーションの動作において問題は発生しない。

補足

waitt maven pluginが起動するTomcatには、独自のserver.xmlを読み込ませることができない。 そのため、waitt maven pluginを使用してアプリケーションを実行する場合、web.xmlに<resource-ref>要素を定義しても、 JNDIは使用できない。

8.3.1.5. 補足

H2のデータの確認方法や、ブランクプロジェクトに組み込まれているツールに関しては、 初期セットアップ手順　補足事項 を参照すること。