リレーションシップ（以下「関係」と記載）の管理

JPAを使用すると、エンティティ・サブジェネレーターによってエンティティ間の関係を作成できます。

プレゼンテーション

関係は、JPAが使用されている場合にのみ機能します。Cassandraの使用を選択した場合は使用できません。MongoDB、Couchbase、またはNeo4jの関係を使用する場合、セマンティクスは異なりますが、すべて使用できます。CouchbaseとMongoDBの関係の詳細については、CouchbaseとMongoDBの組込みエンティティを参照してください。

関係は2つのエンティティ間で機能し、JHipsterは次のコードを生成します。

生成されたエンティティでのJPAとの関係を管理します
関係がデータベースに存在するように、正しいLiquibase変更ログを作成します
Angular/Reactフロントエンドを生成して、この関係をユーザインタフェースでグラフィカルに管理できるようにします

JHipster UMLとJDL Studio

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

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

JDL Studioは、ドメイン固有の言語を使用してエンティティと関係を作成するためのオンライン・ツールです。
JHipster IDEは、よく使われるIDEのJDLファイルのテキスト編集サポートを提供するプラグインです。
非推奨：JHipster UMLでは、UMLエディタを使用できます。

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

使用可能な関係

JPAを使用すると、通常の1対多（one-to-many）、多対1（many-to-one）、多対多（many-to-many）、1対1（one-to-one）の関係が使用可能になります。

リレーションシップの管理

ヒント: Userエンティティ

これについての情報はここにあります。

エンティティと関係の生成に関する小さな警告：以下の例では、コンパイル時に関係先のエンティティが生成されないために失敗することがありますが、これは正常なことです（この警告は無視できます）。これを回避するには、次の2つの方法があります。

最初にエンティティを生成し、次に関係を生成します
JDLを使用します

双方向の1対多の関係

「所有者（Owner）」と「車（Car）」という2つのエンティティから始めましょう。1人の所有者は複数の車を持つことができ、1台の車の所有者は1人だけです。

これは、一方の側では1対多の関係（1人の所有者が多くの車を所有）であり、もう一方の側では多対1の関係（多くの車が1人の所有者を所有）です。

Owner (1) <-----> (*) Car

エンティティの生成後、生成中にエラーが発生したことを知らせるメッセージが表示されます。これは、参照先のエンティティがまだ生成されていないので、正常な動作です。したがって、この警告は無視してもかまいません。

最初にOwnerを作成します。Ownerに関連するJHipsterの質問は次のとおりです。

jhipster entity Owner ... Generating relationships to other entities（他のエンティティとの関係の生成） ? Do you want to add a relationship to another entity?（別のエンティティに関係を追加しますか？） Yes ? What is the name of the other entity?（他のエンティティの名前は何ですか？） Car ? What is the name of the relationship?（関係の名前は何ですか？） car ? What is the type of the relationship?（関係のタイプは何ですか） one-to-many ? What is the name of this relationship in the other entity?（他のエンティティにおけるこの関係の名前は何ですか） owner

関係の名前に関するデフォルトのオプションを選択したことに注意してください。

これでCarを生成できます。

jhipster entity Car ... Generating relationships to other entities ? Do you want to add a relationship to another entity? Yes ? What is the name of the other entity? Owner ? What is the name of the relationship? owner ? What is the type of the relationship? many-to-one ? When you display this relationship with Angular, which field from 'Owner' do you want to use?（Angularでこの関係を表示する場合'Owner'のどのフィールドを使用しますか？） id

以下のJDLを使用しても同じことができます。

entity Owner
entity Car

relationship OneToMany {
  Owner{car} to Car{owner}
}

これで、これら2つのエンティティ間に1対多の関係ができました！　生成されたAngular/ReactクライアントUIではCarにドロップダウンが表示され、Ownerを選択できます。

双方向の多対1の関係

これは、JDLファイルの内容を反転した後の双方向の1対多の関係と同じです。

entity Owner
entity Car

relationship ManyToOne {
  Car{owner} to Owner{car}
}

単一方向の多対1の関係

前の例では、双方向の関係がありました。Carインスタンスからその所有者を見つけることができ、Ownerインスタンスからそのすべての車を取得できます。

多対1の一方向の関係は、車がその所有者を知っていることを意味しますが、その逆はありません。

Owner (1) <----- (*) Car

このような関係にする理由は2つあります。

ビジネスの観点からは、この方法でのみエンティティを使用します。そのため、開発者に意味のないことを実行させるAPIは必要ありません。
Ownerエンティティを使用する際に、パフォーマンスがわずかに向上します（Carのコレクションを管理する必要がないため）。

その場合でも、最初にOwnerを作成し、今度は関係なしで作成します。

jhipster entity Owner
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? No

次に、前の例のようにCarエンティティを作成します。

jhipster entity Car
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Owner
? What is the name of the relationship? owner
? What is the type of the relationship? many-to-one
? When you display this relationship with Angular, which field from 'Owner' do you want to use? id

これは前の例と同じように動作しますが、Ownerエンティティから車を追加または削除はできません。生成されたAngular/ReactクライアントUIでは、Ownerを選択するためのドロップダウンがCarにあります。

対応するJDLは以下のとおりです。

entity Owner
entity Car

relationship ManyToOne {
  Car{owner} to Owner
}

単一方向の1対多の関係

1対多の単方向関係は、Ownerインスタンスが車のコレクションを取得できることを意味しますが、その逆はありません。これは、前の例とは逆です。

Owner (1) -----> (*) Car

このタイプの関係は、現時点ではJHipsterのデフォルトでは提供されていません。詳細については、#1569を参照してください。

これには2つの解決策があります。

双方向マッピングを行い、それを変更せずに使用します。そても単純であるため推奨されるアプローチです。
双方向マッピングを実行し、それを修正して単方向マッピングに変換します：
- @OneToManyアノテーションの"mappedBy"属性を削除します。
- 必要な結合テーブルを生成します。mvn liquibase:diffを実行してそのテーブルを生成できます。Liquibase diffの使用に関するドキュメントを参照してください。

これはJHipsterではサポートされていないため、JDLでもサポートされていません。

同じ2つのエンティティ上の2つの1対多の関係

この例では、Personは多くの車の所有者になることができ、多くの車の運転手になることもできます。

Person (1) <---owns-----> (*) Car
Person (1) <---drives---> (*) Car

このためには、前の例でデフォルト値のままにしておいた関係名を使用する必要があります。

Personエンティティを生成します。このエンティティは、Carエンティティに対して2つの1対多の関係を持ちます。

jhipster entity Person
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Car
? What is the name of the relationship? ownedCar
? What is the type of the relationship? one-to-many
? What is the name of this relationship in the other entity? owner
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Car
? What is the name of the relationship? drivenCar
? What is the type of the relationship? one-to-many
? What is the name of this relationship in the other entity? driver

同じ関係名を使用するCarエンティティを生成し、Personエンティティで設定します。

jhipster entity Car
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Person
? What is the name of the relationship? owner
? What is the type of the relationship? many-to-one
? When you display this relationship with Angular, which field from 'Person' do you want to use? id
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Person
? What is the name of the relationship? driver
? What is the type of the relationship? many-to-one
? When you display this relationship with Angular, which field from 'Person' do you want to use? id

以下のJDLを使用しても同じことができます。

entity Person
entity Car

relationship OneToMany {
  Person{ownedCar} to Car{owner}
}

relationship OneToMany {
  Person{drivenCar} to Car{driver}
}

Carはドライバと所有者を持つことができ、どちらもPersonエンティティです。生成されたAngular/ReactクライアントUIでは、Carにドロップダウンを設け、ownerフィールドとdriverフィールドのためのPersonを選択します。

多対多の関係

Driverは多くの車を運転できますが、Carも多くのドライバーを持つことができます。

Driver (*) <-----> (*) Car

データベースレベルでは、これはDriverテーブルとCarテーブルの間に結合テーブルがあることを意味します。

JPAの場合、これら2つのエンティティのうちの1つが関係を管理する必要があります。この例では、ドライバの追加または削除を担当するCarエンティティです。

エンティティの生成後、生成中にエラーが発生したことが通知されます。これは、参照先のエンティティがまだ生成されていないので、正常な動作です。したがって、この警告は無視してもかまいません。

多対多の関係を持つ、関係の所有される側であるDriverを生成しましょう。

jhipster entity Driver
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Car
? What is the name of the relationship? car
? What is the type of the relationship? many-to-many
? Is this entity the owner of the relationship? No
? What is the name of this relationship in the other entity? driver

次に、多対多の関係の所有する側となるCarを生成します。

jhipster entity Car ... Generating relationships to other entities ? Do you want to add a relationship to another entity? Yes ? What is the name of the other entity? Driver ? What is the name of the relationship? driver ? What is the type of the relationship? many-to-many ? Is this entity the owner of the relationship? Yes ? What is the name of this relationship in the other entity? car ? When you display this relationship on client-side, which field from 'Driver' do you want to use? This field will be displayed as a String, so it cannot be a Blob（この関係をクライアント側で表示する場合Driverのどのフィールドを使用しますか？　このフィールドは文字列として表示されるためBlobにはできません） id

以下のJDLを使用しても同じことができます。

entity Driver
entity Car

relationship ManyToMany {
  Car{driver} to Driver{car}
}

これで、これら2つのエンティティ間に多対多の関係ができました！　生成されたAngular/ReactクライアントUIでは、Carが所有側であるため、複数のDriverを選択するための複数選択ドロップダウンがCarに表示されます。

1対1の関係

1対1の関係の例として、Driverは1つのCarのみを運転でき、Carは1つのDriverのみを持つことができるとします。

Driver (1) <-----> (1) Car

関係の所有者ではない側、この場合はDriverを作成しましょう。

jhipster entity Driver
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Car
? What is the name of the relationship? car
? What is the type of the relationship? one-to-one
? Is this entity the owner of the relationship? No
? What is the name of this relationship in the other entity? driver

次に、関係を所有するCarを生成します。

jhipster entity Car ... Generating relationships to other entities ? Do you want to add a relationship to another entity? Yes ? What is the name of the other entity? Driver ? What is the name of the relationship? driver ? What is the type of the relationship? one-to-one ? Is this entity the owner of the relationship? Yes ? Do you want to use JPA Derived Identifier - @MapsId?（JPA派生識別子@MapsId?を使用しますか？） No ? What is the name of this relationship in the other entity? car ? When you display this relationship on client-side, which field from 'Driver' do you want to use? This field will be displayed as a String, so it cannot be a Blob id

以下のJDLを使用しても同じことができます。

entity Driver
entity Car

relationship OneToOne {
  Car{driver} to Driver{car}
}

これで、これら2つのエンティティ間に1対1の関係ができました！　生成されたAngular/ReactクライアントUIでは、Carが所有側であるため、Carにドロップダウンが表示され、Driverを選択できます。

JPA派生識別子を使用した1対1の使用に関する詳細がこちらにあります

単一方向の1対1の関係

単一方向の1対1の関係の例として、citizenインスタンスはそのパスポートを取得できるが、passportインスタンスはその所有者に取得できないものとします。

Citizen (1) -----> (1) Passport

まず、所有者との関係を持たないPassportエンティティを生成します。

jhipster entity Passport
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? No

次に、Citizenエンティティを生成します。

jhipster entity Citizen
...
Generating relationships to other entities
? Do you want to add a relationship to another entity? Yes
? What is the name of the other entity? Passport
? What is the name of the relationship? passport
? What is the type of the relationship? one-to-one
? Is this entity the owner of the relationship? Yes
? Do you want to use JPA Derived Identifier - @MapsId? No
? What is the name of this relationship in the other entity? citizen
? When you display this relationship with Angular, which field from 'Passport' do you want to use? id

これを行うと、Citizenはパスポートを所有しますが、PassportにはCitizenインスタンスが定義されていません。生成されたAngular/ReactクライアントUIでは、Citizenが所有側であるため、Citizenにドロップダウンが表示され、Passportを選択できます。対応するJDLは次のとおりです。

entity Citizen
entity Passport

relationship OneToOne {
  Citizen{passport} to Passport
}

JPA派生識別子(@MapsId)を使用した1対1の関係

JPA派生識別子を使用すると最も効率的なマッピングを行うことができます。

これは、前述の単方向1対1の例に対応するJDLです。

entity Citizen
entity Passport

relationship OneToOne {
  Citizen{passport} to @Id Passport
}

これは、前述の双方向1対1の例に対応するJDLです。

entity Driver
entity Car

relationship OneToOne {
  Car{driver} to @Id Driver{car}
}

ただし、ビジネス要件によっては、次の制約があるため、これを回避する必要があります。 ID（主キー）が所有側で設定されると、JPA/Hibernateを使用しての変更はできません。いずれにしても変更しないでください。

使用方法に関するいくつかの提案があります:

次の場合には@MapsIdを使用してください。

依存関係 - 所有する側（子エンティティ）が所有される側（親エンティティ）に強く依存していると思われる場合
関連付けの値が変更されない - 子エンティティのID（主キー）を一度設定したら変更しない場合

以下に例を示します。
```
class User{}
class Profile{ @OneToOne @MapsId private User user; } // プロファイルはそのユーザー専用です
class Preferences{ @OneToOne @MapsId private User user; } // プリファレンスはそのユーザーのみを対象としています
```
ユーザーのプロファイルまたはプリファレンスが作成されると、別のユーザーを参照するように変更されることはありません。

次の場合には@MapsIdを使用しないでください。

依存関係ではない - 所有する側（子エンティティ）が所有される側（親エンティティ）に依存していないと思われる場合

関連付けの値が変更される可能性がある - 子エンティティが将来別の親エンティティを参照すると思われる場合

以下に例を示します。

class Car{ @OneToOne @JoinColumn(name="current_driver_id") Driver currentDriver} // 車は将来別のドライバーによって運転される可能性がある
class Driver{@OneToOne(mappedBy = "currentDriver") Car drivingCar} // ドライバーが将来別の車を運転する可能性がある

車とドライバーの両方の関係は、将来変更される可能性があります。

Note: 注意：@MapsIdで@OneToOneを使用することと、それを回避する方法に関しては既知の問題があります

There is a known issue regarding using @OneToOne with @MapsId and how to avoid it.

フェッチデータストラテジをeagerに設定(FetchType.EAGER)

すべての関係は、デフォルトのJPA FetchTypeを使用します。

OneToMany: LAZY
ManyToOne: EAGER
ManyToMany: LAZY
OneToOne: EAGER

eagerフェッチタイプにおいてはJSONデシリアライズ中のNPEの既知の問題があります。OneToManyまたはManyToMany関係をFetchType.EAGERに設定する場合は、次のいずれかの解決策を使用できます。

関係に @JsonInclude(JsonInclude.Include.NON_EMPTY) を使用する

以下に例を示します。

@OneToMany(mappedBy = "parent", fetch = FetchType.EAGER)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
private Set<Child> child = new HashSet<>();

バックエンドでリソースをフェッチするときにコレクションが空の場合はnullを返す
DTOを使用し、空のコレクションに特化した処理を行う

CouchbaseとMongoDBの組込みエンティティ

CouchbaseとMongoDBは、埋め込みドキュメントを通じた関係をサポートしています。MongoDBの埋め込みドキュメントに関する詳細については、https://docs.mongodb.com/manual/applications/data-models-relationships/を参照してください。Couchbaseについては、https://docs.couchbase.com/server/5.1/data-modeling/modeling-relationships.htmlを参照してください。

@embeddedを使用すると、埋込みドキュメントを簡単に定義できます。たとえば、1対1の関係を定義するには、次のようにします。

entity Country {
  countryName String
}

@embedded
entity Region {
  regionName String
}


relationship OneToOne {
  Country to Region
}

同様に、1対多の関係では以下となります。

entity Country {
  countryName String
}

@embedded
entity Region {
  regionName String
}


relationship OneToMany {
  Country to Region
}

多対多の関係では、単純に両方向に@embeddedキーワードを使用できます。

@embedded
  entity Country {
  countryName String
}

@embedded
entity Region {
  regionName String
}


relationship ManyToMany {
  Country to Region
}

プレゼンテーション​

JHipster UMLとJDL Studio​

使用可能な関係​

双方向の1対多の関係​

双方向の多対1の関係​

単一方向の多対1の関係​

単一方向の1対多の関係​

同じ2つのエンティティ上の2つの1対多の関係​

多対多の関係​

1対1の関係​

単一方向の1対1の関係​

JPA派生識別子(@MapsId)を使用した1対1の関係​

フェッチデータストラテジをeagerに設定(FetchType.EAGER)​

CouchbaseとMongoDBの組込みエンティティ​

プレゼンテーション

JHipster UMLとJDL Studio

使用可能な関係

双方向の1対多の関係

双方向の多対1の関係

単一方向の多対1の関係

単一方向の1対多の関係

同じ2つのエンティティ上の2つの1対多の関係

多対多の関係

1対1の関係

単一方向の1対1の関係

JPA派生識別子(@MapsId)を使用した1対1の関係

フェッチデータストラテジをeagerに設定(FetchType.EAGER)

CouchbaseとMongoDBの組込みエンティティ