[Java] 47. JPAのEntityクラスのリファレンス設定(cascade, fetch)

こんにちは。明月です。

この投稿はJPAのEntityクラスのリファレンス設定(cascade, fetch)に関する説明です。

以前の投稿でIDEツール(eclipse)でJPAのEntityを自動生成して基本的に設定しなければならない方法に関して説明しました。

link - [Java] 46. JPAのEntityクラスの基本設定(@GeneratedValue、 @ManyToMany)

基本的な設定でプロジェクトを運用及び作成することは問題ないですが、パフォーマンスのためにもっと修正しなければならないことがあります。

例えば、以前投稿で使ったデータベースでuserテーブルを検索してinfoテーブルのデータを読み込むことで基本的な設定ではuserのリファレンステーブルのinfoデータがありません。

import java.util.List;
import java.util.Optional;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.Persistence;
import model.User;
import model.Info;

public class Main {
  // ラムダ式のインタフェース
  interface Expression {
    void run(EntityManager em);
  }
  // PersistenceからEntityManagerを呼び出してから実行と終了する関数
  private static void transaction(Expression lambda) {
    // FactoryManagerを生成する。"JpaExample"はpersistence.xmlに書いている名だ。
    EntityManagerFactory emf = Persistence.createEntityManagerFactory("JpaExample");
    // Managerを生成する。
    EntityManager em = emf.createEntityManager();
    try {
      // transactionを取得。
      EntityTransaction transaction = em.getTransaction();
      try {
        // transaction実行
        transaction.begin();
        // ラムダ式を実行する。
        lambda.run(em);
        // transactionをコミットする。
        transaction.commit();
      } catch (Throwable e) {
        // エラーが発生すればrollbackする。
        if (transaction.isActive()) {
          transaction.rollback();
        }
        // エラー出力
        e.printStackTrace();
      }
    } finally {
      // 各FactoryManagerとManagerを閉める。
      em.close();
      emf.close();
    }
  }
  // 実行関数
  @SuppressWarnings("unchecked")
  public static void main(String... args) {
    transaction((em) -> {
      // userテーブルでデータを取得
      List<User> users = em.createNamedQuery("User.findAll").getResultList();
      // nowonbunデータ取得
      User user = users.stream().filter(x -> "nowonbun".equals(x.getId())).findFirst().get();
      // Stream式の場合、リファレンスデータを取得しない。
      Optional<Info> info = user.getInfos().stream().findFirst();
      // info値が開いているか確認
      if(info.isEmpty()) {
        // コンソール表示
        System.out.println("Empty");
      } else {
        // データがあればコンソール表示
        System.out.println(info.get().getIdx());
      }
      // get(0)でリファレンスデータデータを取得してidxを出力する。
      System.out.println(user.getInfos().get(0).getIdx());
    });
  }
}

上の例をみればuserクラスでgetInfos()を呼び出してstream式でデータを出力すればデータがないことで出力します。

でも、get(0)やforeachを使ったら関数の呼び出す共にリファレンスデータをデータベースから取得します。

つまり、始めのuserクラスにはデータが無いですが、getとiteratorを呼び出したらその時にデータをデータベースから取得します。

仕様によりstream式を使わなかったら構いないですが、最近のプログラムコードはstream式を使わなかったらすごく複雑になるので、今は必須になっています。

これを解決する方法にはfetch設定です。

fetch

fetchは当該なクラスをデータベースから検索して取得する時、同時にリファレンスデータを取得するかgetの関数を使う時に取得するかのオプションです。

オプションの終了はEAGERとLAZYがあります。EAGERのオプションは当該なクラスの取得する時にJoinして取得するし、LAZYのオプションは関数の呼び出しがある時に取得します。

つまり、上の例みたいにgetの関数の呼び出しがある時に取得することはLAZYのオプションです。別に設定しなくても構いないのデフォルト設定です。

当該な変数にfetch = FetchType.EAGERを設定しました。

始めの例を、また実行したら今回にはコンソール出力にEmptyではなく、データが表示されます。

デバッグでポインタを掛けてuserを取得する段階で確認すればもうデータがあることを確認できます。

これをなぜオプションで選択することになったかと思えばデータ戦略により設定が変わります。

もしかして、我々がMasterテーブルから連結されているReferenceデータが一万件、十万件ならそのデータを取得する時、Joinデータを取得することだけで時間がすごくかかります。

newでクラスを生成することは考えより時間がすごくかかります。その時にはLAZY設定でデータを取得することがシステムに負担がありません。

でも、TransactionテーブルのReferenceデータがMasterの場合、システムの仕様によりデータチェックと分岐処理をする時によく使います。その時にデータベースに接続してデータを取得するコネクションが多くなると逆にシステムが遅くなります。

コネクションは結局Socketのリソースを使うことですが、IOと同じく使うシステムリソースなのですごく遅いです。

プログラム設計もこれをすごく注意しながらstream式よりはforeachとforを利用して検索することに設計するほうが良いです。

Cascade

Cascadeとはデータベースから永続性遷移ということのデータの一貫性を設定するオプションです。

例えば、DatabaseでUserのデータを削除するためには連結したinfoデータを削除しなければならないし、infoデータを削除するためには連結したinfo2データを削除しなければならないです。

もちろん、これがプログラムで順番でinfo2を削除してinfoを削除してuserを削除すればよいです。

この場合は二つの問題があります。一つはソースがすごく複雑になるし、関連データベースが変更するたびにソースをすべて修正しなければならない問題があります。こんなことになると我々がJPAを使う必要がありません。

もう一つ、問題がある部分がもしinfo2テーブルのデータを削除してinfoテーブルのデータを削除する動作でエラーが発生します。その場合はinfo2が削除されたので完全にrollbackができません。でも、これはtransactionの問題ですが、永続性遷移と関係があります。

つまり、一括で削除されなければならないです。

Cascadeオプションで設定することができます。

import java.util.List;
import java.util.Optional;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.Persistence;
import model.User;
import model.Info;

public class Main {
  // ラムダ式のインタフェース
  interface Expression {
    void run(EntityManager em);
  }
  // PersistenceからEntityManagerを呼び出してから実行と終了する関数
  private static void transaction(Expression lambda) {
    // FactoryManagerを生成する。"JpaExample"はpersistence.xmlに書いている名だ。
    EntityManagerFactory emf = Persistence.createEntityManagerFactory("JpaExample");
    // Managerを生成する。
    EntityManager em = emf.createEntityManager();
    try {
      // transactionを取得。
      EntityTransaction transaction = em.getTransaction();
      try {
        // transaction実行
        transaction.begin();
        // ラムダ式を実行する。
        lambda.run(em);
        // transactionをコミットする。
        transaction.commit();
      } catch (Throwable e) {
        // エラーが発生すればrollbackする。
        if (transaction.isActive()) {
          transaction.rollback();
        }
        // エラー出力
        e.printStackTrace();
      }
    } finally {
      // 各FactoryManagerとManagerを閉める。
      em.close();
      emf.close();
    }
  }
  // 実行関数
  @SuppressWarnings("unchecked")
  public static void main(String... args) {
    transaction((em) -> {
      // userテーブルからデータ取得
      List<User> users = em.createNamedQuery("User.findAll").getResultList();
      // nowonbunデータ取得
      User user = users.stream().filter(x -> "nowonbun".equals(x.getId())).findFirst().get();
      // データ削除
      em.remove(user);
    });
  }
}

上の例はuserテーブルでnowonbunを検索して削除するコードです。別にinfoテーブルのデータとinfo2テーブルのデータは検索もしてなかったし、削除する時にエラーが発生しませんでした。

当該なデータベースを確認しても綺麗に削除されていました。

でも、cascade設定もかってに設定するとダメです。

もしtransactionテーブルを削除する時にmasterテーブルのデータが削除されるか、間違いロジックコードで重要なデータが続けて削除されたらNGです。

もちろん、削除だけではなく、修正、追加もルールによって動作しなければならないです。

ここのcascadeオプションはEntityManagerのクラスの関数と関係があります。

つまり、各Entityクラスのインスタンスをどの関数で使って追加、削除、修正する時にリファレンスクラスに影響になることです。

fetchオプションとcascadeオプションは状況により設定しなくてもORMを運用することで問題がありません。しかし、パフォーマンスには差異がなりますね。

そしてコードを作成して後にテーブルが変更があればメンテナンスする時も差異があります。

ここまでJPAのEntityクラスのリファレンス設定(cascade, fetch)に関する説明でした

ご不明なところや間違いところがあればコメントしてください。