Table Of Contents

アプリケーションのレイアウトと編成

ディレクトリ・ファイル構成

Creamyでは、開発環境としてNetBeansの利用を想定しています。 そのため、Creamyのディレクトリ構成はNetBeansプロジェクトを 基本として構成されています。

実際のディレクトリ構成は以下のようになっています。

ディレクトリ
概要
lib
依存jarを配置
nbproject
NetBeansのプロジェクトファイルを配置
conf
設定ファイルを配置
src
ソースコードを配置
src/{userapp}
エントリポイントを配置。任意の名前で作成
src/models
モデルクラスを配置
src/controllers
コントローラクラスを配置
src/views
コントローラクラス毎のディレクトリを配置
src/helpers
全てのビューで利用可能なVelocityマクロを配置

lib ディレクトリ

ライブラリを配置するディレクトリです。 アプリケーションで利用するjarファイルはこのディレクトリに配置してください。 デフォルトでは、Creamyが依存する以下のファイルが配置されています。

  • creamy-1.0.jar
  • ebean-2.7.3.jar
  • hibernate-validator-4.3.0.Final.jar
  • javax.validation-1.0.0.GA.jar
  • jsonic-1.2.11.jar
  • persistence-api-1.0.jar
  • velocity-1.7.jar
  • velocity-1.7-dep.jar

開発時に特に利用することになるものについては、 使用するライブラリ を参照してください

confディレクトリ

Creamyの設定ファイルを配置するディレクトリです。 デフォルトでは、以下のファイルが配置されています。

ファイル名
概要
creamy.properties
Creamyの設定ファイル
ebean.properties
Ebeanの設定ファイル
velocity.properties
Velocityの設定ファイル

各設定ファイルの詳細については プロパティファイル を参照してください。

srcディレクトリ

アプリケーションのソースコードを配置するディレクトリです。 srcディレクトリの配下には以下のディレクトリが配置されています。

それぞれのディレクトリの詳細については後述します。

  • {userapp}
  • models
  • controllers
  • views
  • helpers

src/{userapp} ディレクトリ

アプリケーションのエントリポイントとなるクラスを配置するディレクトリ(パッケージ)です。 デフォルトでは存在しないので、任意の名前(アプリケーション名など)のディレクトリを作成してください。 また、その配下にエントリポイントとなるクラスを作成してください。

src/models ディレクトリ

モデルクラスを配置するディレクトリです。 詳細は モデルクラス の項を参照してください。

src/controllers ディレクトリ

コントローラクラスを配置するディレクトリです。 詳細は コントローラクラス の項を参照してください。

src/views ディレクトリ

ビュー関連のファイルを配置するディレクトリです。 コントローラクラスに対応するコントローラクラスと同名のディレクトリが配置されます。 その配下には、それぞれコントローラメソッドに対応するファイルが配置されます。 配置されるファイルは以下の三種類です。

  • ‘メソッド名’.vm.fxml
  • ‘メソッド名’.java
  • ‘メソッド名’.css

詳細は ビュー の項を参照してください。

src/helpers ディレクトリ

全てのビューで利用可能なVelocityマクロを配置するディレクトリです。 デフォルトではbody.vmとrender.vmが配置されています。

  • body.vm
  • render.vm

これらのマクロはビューを作成するする際に利用可能です。 開発時には必要に応じて任意のvmファイルを追加、配置してください。