JPAの仕様を洗っていく【株式会社ライトコード】

※弊社エンジニアの記事になります。

前提

話がややこしくなるので事前に説明しておくと、Javaを介したDB操作をする上で JPA と Spring Data JPA という似ている2つのワードが出てきます。簡単に違いを説明すると JPA はJavaオブジェクトとDBカラムのマッピングを仕様として定義したものです。その仕様（JPA）に則ったライブラリを提供しているのが Spring Data JPA になります。JPAそのままでもDBとやり取りすることは可能ですが、仕組みがかなりややこしく学習コストが高いです。そのため簡易的にJPAを使用できるようにしてくれるSpring Data JPAが用意されています。今回の記事ではJPAをメインに解説を進めつつ、Spring Data JPAにも触れていきたいと思います。

仕様確認に至った経緯

ここ数ヶ月で Spring Data JPA に触れる機会が増えたにも関わらず、動作の詳細について把握していなかったことが原因で実装が手間取ったことがありました。

具体的には下記のようにDBを更新する場面で、saveメソッドの実行時に裏でUPDATEのSQLが走る想定をしていたのですが、実際には別のタイミングでSQLは実行されていました。（詳細については後述）

try {
  userRepository.save(userEntity);
} catch (ObjectOptimisticLockingFailureException e) {
  // 例外をスロー
}

そのため Spring Data JPA ないしはその大元にある JPA について根っこから概要を押さえる必要があると感じ、そのアウトプットも兼ねて本記事の投稿に至りました。

JPA

まずJPAの重要な要素として Entity と Entity Manager があります。

EntityはDBのテーブルと1対1で対応するJavaオブジェクトです。コード上では @Entity がついているクラスが該当します。

Entity ManagerはEntityのライフサイクル管理を PersistenceContext という領域で行います。その際に使用することができるEntity Managerのメソッドとして主に以下のものがあります。

persist

引数にエンティティを渡すとそのエンティティをPersistenceContextに格納し、管理状態として永続化する。（INSERT）

find

管理状態のエンティティの中から、引数で渡したIDに紐づくエンティティを返却する。（SELECT）

merge

引数で指定したエンティティの状態をPersistenceContext内にあるエンティティに反映する。（UPDATE）remove

引数で指定したエンティティの状態を削除状態にする。（DELETE）

flush

上記メソッドで行ったエンティティへの変更をDBに反映する。このメソッドを実行して初めてPersistenceContext内のエンティティとDBの状態が同期される。

detach

PersistenceContextで管理しているエンティティを削除し管理対象から外します。removeと似ていますがライフサイクル的には削除状態にはならず "分離状態" として扱われます。※分離状態のエンティティに対する変更はDBに反映されません（管理対象外のため）

contain

引数で指定したエンティティがPersistenceContext内に存在するかチェックする。

refresh

管理状態のエンティティにDBの情報を反映させる。 ※管理状態でないエンティティを指定した場合例外が発生します。

clear

PersistenceContextをクリアし、全ての管理状態のエンティティを分離状態にする。

例としてUserテーブルにレコードをINSERTする場合のコードを用意しました。

// PersistenceContextとEntityManagerを紐づけ
@PersistenceContext(unitName="ExampleUnit")
private EntityManager em;
 
public void insertUser() {
  // UserEntity取得
  var userEntity = new UserEntity();
 
  // 名前を変更
  userEntity.setName("佐藤");
 
  // PersistenceContextでの管理対象に指定
  this.em.persist(userEntity);
 
  // 変更内容をコミット ※JPAはコミット時にEntityへの変更をDBに反映する
  this.em.getTransaction().commit();
}

※今回あえてcommitメソッドを書いていますがJPAでは自動コミット機能があり、insertUser()の処理が全て終了した時点で勝手にコミットしてくれるため本来は記載不要です。

例として今回はINSERTのコードを記載しましたが、UPDATEしたい場合はnewの箇所をfind()によるエンティティ取得に置き換えるだけで実現できます。

JPAでは上記のように様々なメソッドを使用しエンティティのライフサイクル管理を行いDBを操作します。しかし、単純な参照や更新ならともかく複雑なDB操作を行いたい場合にややこしくなります。そのためJPAをそのまま使用するのではなく、簡易的に使用することができる Spring Data JPA の使用を検討する方が多いと思います。（検討する方が多いのはあくまでJPAを使う前提がある人の話です。そもそもJPAの使用自体避けられている印象、、、）

…