コンテナ用RESTfulウェブサービスプロジェクトの初期セットアップ¶
コンテナ用RESTfulウェブサービスプロジェクトの初期セットアップでは以下を行う。
- RESTfulウェブサービスプロジェクトの生成
- RESTfulウェブサービスプロジェクトの動作確認
- コンテナイメージの作成
- コンテナイメージの実行
生成するプロジェクトの概要¶
本手順で生成するプロジェクトの概要は以下の通りである。
| 項目 | 説明 |
|---|---|
| プロジェクト種別 | Mavenプロジェクト |
| プロジェクト構成 | 単一プロジェクト構成 |
| 使用DB | H2 Databaes Engine(アプリケーションに組み込み) |
| 組み込まれているアダプタ |
|
| 生成するプロジェクトに含まれるもの | 生成されたプロジェクトには以下が含まれる。
|
他のプロジェクトとの関係、及びディレクトリ構成は、 Mavenアーキタイプの構成 を参照。
ブランクプロジェクト作成¶
Nablarchが提供するアーキタイプを使用してブランクプロジェクトを生成する。
mvnコマンドの実行¶
Maven Archetype Plugin(外部サイト、英語) を使用して、ブランクプロジェクトを生成する。
カレントディレクトリを、ブランクプロジェクトを作成したいディレクトリ(任意のディレクトリで可)に変更する。
その後、以下のコマンドを実行する。
mvn archetype:generate -DarchetypeGroupId=com.nablarch.archetype -DarchetypeArtifactId=nablarch-container-jaxrs-archetype -DarchetypeVersion=6u2
上記コマンドで使用されているNablarchのバージョンは 6u2 となっている。バージョンを変更したい場合は、以下のパラメータを変更すること。
| 設定値 | 説明 |
|---|---|
| archetypeVersion | 使用したいアーキタイプのバージョンを指定する。（Nablarch 6u2以降を指定すること） |
プロジェクト情報の入力¶
上記コマンドを実行すると、以下の項目について入力を求められるので、 生成されるブランクプロジェクトに関する情報を入力する。
| 入力項目 | 説明 | 設定例 |
|---|---|---|
| groupId | グループID（通常はパッケージ名を入力） | com.example |
| artifactId | アーティファクトID | myapp-container-jaxrs |
| version | バージョン番号 | 0.1.0 |
| package | パッケージ(通常はグループIDと同じ) | com.example |
重要
項目groupIdおよびpackageは、Javaのパッケージ名にマッピングされる。 よって、これらの入力値には、英小文字、数字、ドットを使用し、ハイフンは使用しないこと。
プロジェクト情報の入力が終わると、Y: :と表示される。
- 入力した内容をもとに、ひな形を生成する場合には「Y」を入力してください。
- プロジェクト情報の入力をやり直したい場合には「N」を入力してください。
コマンドが正常終了した場合、ブランクプロジェクトがカレントディレクトリ配下に作成される。
疎通確認¶
疎通確認の仕組みや手順は通常のRESTfulウェブサービスプロジェクトと同じなので、 RESTfulウェブサービスプロジェクトの初期セットアップ を参照。
注釈
アーティファクトID が myapp-container-jaxrs になっている点は、適宜読み替えてディレクトリやコマンドを指定すること。
コンテナイメージを作成する¶
コンテナイメージの作成方法はコンテナ用のウェブプロジェクトと同じなので、 コンテナ用ウェブプロジェクトの初期セットアップ を参照。
注釈
アーティファクトID が myapp-container-jaxrs になっている点は、適宜読み替えてディレクトリやコマンドを指定すること。
コンテナイメージを実行する¶
コンテナイメージの実行方法はコンテナ用のウェブプロジェクトと同じなので、 コンテナ用ウェブプロジェクトの初期セットアップ を参照。
注釈
アーティファクトID が myapp-container-jaxrs になっている点は、適宜読み替えてディレクトリやコマンドを指定すること。
注釈
動作確認は、以下のURLで行える。
http://localhost:8080/find/jsonhttp://localhost:8080/find/xml
データベースに関する設定を行う¶
ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、使用するRDBMSの変更手順 を参照して設定すること。
またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は gsp-dba-maven-plugin(DBA作業支援ツール)の初期設定方法 を参照。
補足¶
H2のデータの確認方法や、ブランクプロジェクトに組み込まれているツールに関しては、 初期セットアップ手順 補足事項 を参照すること。