メインコンテンツまでスキップ

エンティティの構築

新しいJHipsterアプリケーションの作成については、ビデオチュートリアルを参照してください。

警告

JavaScript/TypeScriptコードの「ライブリロード」を行いたい場合は、npm startを実行する必要があります。詳細については、開発でのJHipsterの使用ページにアクセスしてください。

はじめに​

アプリケーションを作成したら、エンティティ を作成します。たとえば、著者 エンティティと 本 エンティティを作成するとします。エンティティごとに、次の要素が必要です。

  • データベーステーブル
  • Liquibaseチェンジセット
  • JPAエンティティ
  • Spring Data JPAリポジトリ
  • 基本的なCRUD操作を備えたSpring MVC RESTコントローラ
  • Angularルータ、コンポーネント、サービス
  • HTMLビュー
  • すべてが期待どおりに動作することを検証するための統合テスト
  • すべてがスムーズに動作するかどうかを確認するためのパフォーマンステスト

複数のエンティティがある場合は、エンティティ間にリレーションシップを設定する必要があります。そのためには、次の要素が必要です。

  • データベース外部キー
  • このリレーションシップを管理するための特定のJavaScriptおよびHTMLコード

"エンティティ"サブジェネレータは、必要なファイルをすべて作成し、エンティティごとにCRUDフロントエンドを提供します（Angularプロジェクトの構成およびReactプロジェクトの構成を参照）。サブジェネレータは、jhipster entity <entityName> --[options]を実行することで呼び出すことができます。これらのオプションの参照は、jhipster entity--helpと入力することで見つけることができます。

サポートされているオプションは次のとおりです。

  • --table-name <table_name> - デフォルトでは、JHipsterはエンティティ名に基づいてテーブル名を生成します。別のテーブル名が必要な場合は、このオプションを渡すことで生成できます
  • --angular-suffix <suffix> - すべてのAngularルートにカスタム接尾辞を付けたい場合は、このオプションを使用してそれを渡すことができます
  • --client-root-folder <folder-name> - クライアント側のエンティティにルートフォルダ名を使用します。デフォルトでは、モノリスの場合は空で、ゲートウェイの場合はマイクロサービスの名前です
  • --regenerate - 何も質問せずに既存のエンティティを再生成します
  • --skip-server - サーバ側のコードをスキップし、クライアント側のコードのみを生成します
  • --skip-client - クライアント側のコードをスキップし、サーバ側のコードのみを生成します
  • --skip-db-changelog - データベース変更ログの生成をスキップします（SQLデータベースにはLiquibaseを使用します）
  • --db - サーバ側の生成をスキップする場合にデータベースを指定します。それ以外の場合の影響はありません
警告

エンティティに短い名前を付けないでください（このチケットを参照）。

JHipster UMLとJDL Studio​

このページでは、標準のコマンドライン・インタフェースを使用してJHipsterでエンティティを作成する方法について説明します。多数のエンティティを作成する場合は、グラフィカル・ツールを使用することをお薦めします。

この場合、次の2つのオプションを使用できます。

  • JHipster UML：UMLエディタを使用できます。
  • JDL Studio：ドメイン固有の言語JDLを使用してエンティティとリレーションシップを作成するためのオンライン・ツールです。

JDL Studioを使用した場合は以下の通りです。

  • jhipster jdl your-jdl-file.jhを実行することにより、jdlサブジェネレータを使用してJDLファイルからエンティティを生成できます。

    • JDLのインポート中にエンティティを再生成しない場合は、--json-onlyフラグを使用してエンティティ作成部分をスキップし、.jhipsterフォルダにjsonファイルのみを作成できます。
    jhipster jdl ./my-jdl-file.jdl --json-only
    • デフォルトでは、jdlは変更されたエンティティのみを再生成します。すべてのエンティティを再生成したい場合は、--forceフラグを渡してください。これにより、エンティティファイルに対するローカルの変更がすべて上書きされることに注意してください。
    jhipster jdl ./my-jdl-file.jdl --force

  • jdlサブジェネレータの代わりにJHipster UMLを使用したい場合は、npm install -g jhipster-umlを実行してインストールしてから、jhipster-uml yourFileName.jhを実行する必要があります。

エンティティのフィールド​

エンティティごとに、必要な数のフィールドを追加できます。フィールド名とその型を入力する必要があり、JHipsterはAngular HTMLビューからLiquibase changelogまで、必要なすべてのコードと構成を生成します。

これらのフィールドには、使用しているテクノロジで予約されているキーワードを含めることはできません。たとえば、MySQLを使用している場合は、次のようになります。

  • Javaの予約キーワードは使用できません（コードがコンパイルされません）
  • MySQLの予約キーワードは使用できません（データベーススキーマの更新が失敗します）

フィールドの型​

JHipsterは多くのフィールドタイプをサポートしています。このサポートはデータベースバックエンドに依存するため、Javaの型を使用してそれらを記述します。JavaのStringはOracleとCassandraでは格納方法が異なります。正しいデータベースアクセスコードを生成することは、JHipsterの強みの1つです。

  • String：JavaのString型です。デフォルトのサイズは基盤となるバックエンドに依存します（JPAを使用している場合、デフォルトでは255です）が、検証ルールを使用して変更できます（たとえば、maxサイズを1024に設定します）。
  • Integer：JavaのInteger型です。
  • Long：JavaのLong型です。
  • Float：JavaのFloat型です。
  • Double：JavaのDouble型です。
  • BigDecimal：java.math.BigDecimalです。正確な数学的計算が必要な場合に使用されます（財務操作によく使用されます）。
  • LocalDate：java.time.LocalDateです。Javaで日付を正しく管理するために使用されます。
  • Instant：java.time.Instantです。タイムライン上の瞬間的なポイントであるタイムスタンプを表すために使用されます。
  • ZonedDateTime：java.time.ZonedDateTimeです。特定のタイムゾーン（通常はカレンダーの予定）のローカル日時を表すために使用されます。タイムゾーンはRESTと永続化層のいずれもサポートされていないので、代わりにInstantを使用するべきであることに注意してください。
  • Duration：java.time.Durationです。時間の量を表すために使用されます。
  • UUID：java.util.UUIDです。
  • Boolean：JavaのBoolean型です。
  • Enumeration：JavaのEnumeration型です。オブジェクトこのタイプを選択すると、サブジェネレータは列挙に必要な値を尋ね、それらを格納するための特定のenumクラスを作成します。
  • Blob：バイナリデータを格納するために使用されるBlobオブジェクトです。このタイプを選択すると、サブジェネレータは汎用バイナリデータ、イメージオブジェクト、またはCLOB（ロングテキスト）を格納するかどうかを確認します。イメージは特にAngular側で処理されるため、エンドユーザに表示できます。

検証​

検証はフィールドごとに設定できます。使用できる検証のオプションは、フィールドの種類によって異なります。

検証は以下の要素に対して自動的に生成されます。

  • Angular、React、またはVue検証メカニズムを使用したHTMLビュー
  • Bean Validationを用いたJavaのドメインオブジェクト

Bean検証は、ドメインオブジェクトが以下の場所で使用されるときに、ドメインオブジェクトを自動的に検証するために使用されます。

  • Spring MVC RESTコントローラ（@Validアノテーションを使用）
  • Hibernate/JPA（エンティティは保存される前に自動的に検証されます）

検証情報は、より正確なデータベース列のメタデータを生成するためにも使用されます。

  • 必須フィールドにはNULL入力不可のマークが付けられます。
  • 固有のフィールドでは、固有の制約が作成されます。
  • 最大長のフィールドは、列の長さが同じになります。

検証にはいくつかの制限があります。

  • Angular、React、Bean Validationのすべての検証オプションをサポートしているわけではありません。クライアントAPIとサーバAPIの両方に共通するもののみをサポートしています。
  • 正規表現パターンはJavaScriptとJavaでは同じように動作しないため、正規表現パターンを設定する場合は、生成されたパターンの微調整が必要な場合があります。
  • JHipsterは、検証ルールを知らずに汎用エンティティに対して機能するユニット・テストを生成します。そのため、生成されたテストが検証ルールに合格しない可能性があります。その場合は、ユニット・テストで使用されるサンプル値を検証ルールに合格するよう更新する必要があります。

エンティティのリレーションシップ​

エンティティのリレーションシップは、SQLデータベースでのみ使用できます。これはかなり複雑な主題であり、リレーションシップの管理という独自のドキュメント・ページがあります。

ビジネス・ロジック用に別のサービス・クラスを生成する​

独立したサービスクラスを持つことで、Spring RESTコントローラを直接使用する場合と比較して、より複雑なロジックを持つことができます。サービスレイヤ（インタフェースの有無にかかわらず）を持つことでDTO（次のセクションを参照してください）を使用できるようになります。

これは、Springサービスサブジェネレータを使用するのと同じロジックであるため、詳細については参照先のドキュメントを読むことをお勧めします。

データ・トランスファー・オブジェクト（DTO）​

デフォルトでは、JHipsterエンティティはDTOを使用しませんが、サービス・レイヤーを使用する場合はオプションとして使用できます（前のセクションを参照）。ドキュメントはDTOを使用するを参照してください。

フィルタリング​

オプションとして、SQLデータベースに格納されたエンティティは、JPAを使用してフィルタ処理できます。ドキュメントエンティティのフィルタ処理を参照してください。

ページネーション​

注意点として、Cassandraを使用してアプリケーションを作成した場合、ページネーションは使用できないことに注意してください。これは将来のリリースで追加される予定です。

ページネーション機能は、リンクヘッダーをGitHub APIのように使用します。JHipsterは、サーバ側（Spring MVC REST）とクライアント側（Angular/React）の両方で、この仕様のカスタム実装を提供します。

エンティティが生成されると、JHipsterは4つのページネーションのオプションを提供します。

既存のエンティティの更新​

エンティティの設定は、.jhipsterディレクトリ内の特定の.jsonファイルに保存されます。そのため、既存のエンティティ名を使用してサブジェネレータを再度実行すると、エンティティを更新または再生成できます。

既存のエンティティに対してエンティティサブジェネレータを実行すると、「エンティティを更新しますか？　これにより、このエンティティの既存のファイルが置き換えられ、すべてのカスタムコードが上書きされます（Do you want to update the entity? This will replace the existing files for this entity, all your custom code will be overwritten）」というメッセージが表示され、次のオプションが表示されます。

  • はい、エンティティを再生成します（Yes, re generate the entity） - これにより、エンティティが再生成されます。ヒント：これは、サブジェネレータの実行時に--regenerateフラグを渡すことによって強制できます。
  • はい、フィールドとリレーションシップをさらに追加します（Yes, add more fields and relationships） - これにより、フィールドとリレーションシップをさらに追加するための質問が表示されます。
  • はい、フィールドとリレーションシップを削除します（Yes, remove fields and relationships） - 既存のフィールドとリレーションシップをエンティティから削除するかどうかを確認するメッセージが表示されます。
  • いいえ、終了します（No, exit） - 何も変更せずにサブジェネレータを終了します。

以下のような理由がある場合に、エンティティを更新することになるでしょう。

  • 既存のエンティティに対してフィールドとリレーションシップを追加または削除したい
  • エンティティのコードを元の状態にリセットしたい
  • JHipsterを更新し、新しいテンプレートを使用してエンティティを生成したい
  • .json設定ファイルを変更して（このフォーマットはジェネレーターが尋ねる質問に非常に近いので、それほど複雑ではありません）、新しいバージョンのエンティティーを作成する
  • 既存のエンティティに類似している新しいエンティティが必要のため、.jsonファイルをコピー/ペーストした
ヒント

すべてのエンティティを一度に再生成するには、次のコマンドを使用します（ファイルが変更されたときに質問を表示するには、--forceを削除します）。

  • Linux & Mac: for f in `ls .jhipster`; do jhipster entity ${f%.*} --force ; done
  • Windows: for %f in (.jhipster/*) do jhipster entity %~nf --force

チュートリアル​

これは、1対多のリレーションシップを持つ2つのエンティティとして「著者（Author）と本（Book）」の作成に関する簡単なチュートリアルです。

警告

JavaScript/TypeScriptコードの「ライブリロード」を行いたい場合は、npm startを実行する必要があります。詳細については、開発でのJHipsterの使用ページにアクセスしてください。

「著者」エンティティの生成​

著者と本の間に1対多のリレーションシップを持ちたいので（1人の著者が多くの本を書くことができます）、最初に著者を作成する必要があります。データベースレベルでは、JHipsterはBookテーブルに外部キーを追加し、Authorテーブルにリンクできるようになります。

jhipster entity author

このエンティティのフィールドに関する次の質問に回答します。著者については以下です。

  • String型の"name"
  • LocalDate型の"birthDate"

次に、リレーションシップに関する質問に回答します。著者については以下です。

  • "book"エンティティ（まだ存在しない）との1対多のリレーションシップ

「本」エンティティの生成​

jhipster entity book

このエンティティのフィールドに関する次の質問に回答します。本については以下です。

  • "String"型の"title"
  • "String"型の"description"
  • "LocalDate"型の"publicationDate"
  • "BigDecimal"型の"price"

次に、リレーションシップに関する質問に回答します。本については以下です。

  • "author"エンティティとの間に多対1のリレーションシップがある
  • このリレーションシップでは、表示される"name"フィールド（著者エンティティから）を使用する

生成されたコードをチェック​

mvn testを使用して、生成されたテストスイートを実行します。これによりAuthorエンティティとBookエンティティがテストされます。

アプリケーションを（例えばmvnで）起動し、ログインして、"エンティティ"メニューで"Author"と"Book"エンティティを選択します。

データベーステーブルをチェックして、データが正しく挿入されているかどうかを確認します。

生成されたコードの改善​

生成されたファイルには基本的なCRUD操作がすべて含まれており、CRUD操作以上の操作が必要ない場合は変更する必要はありません。

生成されたコードまたはデータベーススキーマを変更する場合は、開発ガイドに従ってください。

もっと複雑なビジネス的な振る舞いが必要な場合は、service sub-generator を使用して、Springの@Serviceクラスを追加する必要があります。

完了しました!​

生成されたCRUDページは次のようになります。