S-JIS[2017-10-08] 変更履歴

Spring Boot JPA 1:多（コレクション）

Spring Boot 1.5.6のJPAの1:多（ElementCollection）について。

概要 EAGERの例 save 2つ以上のEAGER LAZYの例 LazyInitializationException Embeddedの例テーブル定義	Accessing Data with JPA Spring Data JPA - Reference Documentation
	JPAサンプル 1:多（OneToMany）多:1（ManyToOne） JPQLのjoin

概要

あるエンティティーTで別のエンティティーDを複数保持する（T:D＝1:n、すなわち1:多）場合、JPAではエンティティーTの中でDのコレクションを持つ形で書ける。

import javax.persistence.ElementCollection;
import javax.persistence.Entity;

@Entity
public TEntity {
～
	@ElementCollection
	private List<DEntity> dList;
～
}

フィールドにコレクション書き、@ElementCollectionアノテーションを付ける。

（→@OneToManyアノテーションを使用する方法）

EntityだけでなくList<String>のように基本型もコレクションにして複数持つことが出来る。
ただしこの場合も、実現方法としては基本型のデータを持つテーブルが作られ、そこに複数レコード保持することになる。
（扱いとしてはEmbedded相当のようで、関連付けテーブルは作られない）

LAZYの例

@ElementCollectionのデフォルトは、fetch=LAZY（遅延）となっている。
Entityの扱い方（インスタンス生成やメソッド呼び出し方法）はEAGERの場合と同じ。

内部的には、エンティティー（下記の例のCollectionExampleEntity）を取得した時点では、@ElementCollectionが付けられたフィールドのデータ（下記の例のdetailList）はまだ取得されない。
フィールドのデータを取得しようとしたときにDBアクセスされる。

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：

package com.example.demo.db.domain;

import java.util.List;

import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class CollectionExampleEntity {

	@Id
	@GeneratedValue
	private Long id;

	private String value;

	@ElementCollection(fetch = FetchType.LAZY)
	private List<DetailEntity> detailList;

	～setter/getter～
}

LazyInitializationException

fetch=LAZYにした@ElementCollectionを使っていると、LazyInitializationExceptionが発生することがある。

org.hibernate.LazyInitializationException: failed to lazily initialize a collection of role: com.example.demo.db.domain.CollectionExampleEntity.detailList, could not initialize proxy - no Session
	at org.hibernate.collection.internal.AbstractPersistentCollection.throwLazyInitializationException(AbstractPersistentCollection.java:587)
	at org.hibernate.collection.internal.AbstractPersistentCollection.withTemporarySessionIfNeeded(AbstractPersistentCollection.java:204)
	at org.hibernate.collection.internal.AbstractPersistentCollection.initialize(AbstractPersistentCollection.java:566)
	at org.hibernate.collection.internal.AbstractPersistentCollection.read(AbstractPersistentCollection.java:135)
	～

これは、コレクション（Entityのフィールド）の値をDBから取得しようとしたがDBのセッションが無い（切断されている）、という時に発生する。
要するに、トランザクションの外側でEntityのフィールドの値を取得しようとすると発生する。

したがって、トランザクションの中だけでEntityを操作していれば、この例外は発生しない。
この例外でググると「EAGERにしろ」という打開策をよく見かけるが、それは根本的な解決策ではない。

src/main/java/com/example/demo/db/service/CollectionExampleService.java：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class CollectionExampleService {

	@Autowired
	private CollectionExampleRepository repository;

	@Transactional(readOnly = true)
	public void 何らかの処理(long id) {
		CollectionExampleEntity entity = repository.findOne(id);

		// entityの操作（フィールドの取得）はトランザクションの中だけで完結させる
	}
}

Embeddedの例

エンティティーのコレクションをフィールドに持つと、実際のテーブルとしては、2つのエンティティーを関連付けるテーブル（2つのエンティティーのIdを持つテーブル）も用意される。

コレクションをEmbeddedにすると、関連テーブルは作られず、データ側のテーブルに外部キー項目が用意される。
この場合、データ側はEntityではなくEmbeddableにする。
EmbeddableはEntityではないので、Id項目は不要となる。
（Entityではないので、独立したテーブルとしてアクセスする事は出来ない）
（関連テーブルを作らずにEntityで扱いたい場合は@OneToManyアノテーションを使う）

src/main/java/com/example/demo/db/domain/DetailEmbed.java：

package com.example.demo.db.domain;

import javax.persistence.Embeddable;

@Embeddable
public class DetailEmbed {

	private String value;

	～setter/getter～
}

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：

package com.example.demo.db.domain;

import java.util.List;

import javax.persistence.ElementCollection;
import javax.persistence.Embedded;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class CollectionExampleEntity {

	@Id
	@GeneratedValue
	private Long id;

	private String value;

	@ElementCollection(fetch = FetchType.LAZY)
	@Embedded // このアノテーションは無くても構わないっぽい
	private List<DetailEmbed> embedList;

	～setter/getter～
}

呼び出し例：

		CollectionExampleEntity entity = new CollectionExampleEntity();
		entity.setValue("zzz");
		entity.setEmbedList(new ArrayList<>(Arrays.asList(embed("aa"), embed("bb"), embed("cc"))));
		repository.saveAndFlush(entity);

		CollectionExampleEntity result = repository.findOne(entity.getId());

	private DetailEmbed embed(String value) {
		DetailEmbed entity = new DetailEmbed();
		entity.setValue(value);
		return entity;
	}

参考： megascusさんのJPAの@Embeddableと@ElementCollectionでEntityの責務を明確化する。

Embeddedのテーブル定義

Embeddedによって作られるテーブルのテーブル名やカラム名を定義することが出来る。

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：

import java.util.List;

import javax.persistence.AttributeOverride;
import javax.persistence.AttributeOverrides;
import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Embedded;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;

	@ElementCollection(fetch = FetchType.LAZY)
	@Embedded
	@CollectionTable(name = "DETAIL_EMBED", joinColumns = { @JoinColumn(name = "DETAIL_ID") })
	@AttributeOverrides({
		@AttributeOverride(name = "value", column = @Column(name = "DETAIL_VALUE"))
	})
	private List<DetailEmbed> embedList;

JPAサンプルに戻る / JPAへ戻る / Spring Bootへ戻る / Spring Frameworkへ戻る / 技術メモへ戻る

メールの送信先：ひしだま

Spring Boot JPA 1:多（コレクション）

概要

EAGERの例

src/main/java/com/example/demo/db/domain/DetailEntity.java：

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：

src/main/java/com/example/demo/db/repository/ManyExampleRepository.java：

save

呼び出し例：

2つ以上のEAGER

LAZYの例

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：

LazyInitializationException

src/main/java/com/example/demo/db/service/CollectionExampleService.java：

Embeddedの例

src/main/java/com/example/demo/db/domain/DetailEmbed.java：

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：

呼び出し例：

Embeddedのテーブル定義

src/main/java/com/example/demo/db/domain/CollectionExampleEntity.java：