SpringのCriteriaBuilderとcreateCriteriaDeleteの使い方を徹底解説！初心者でもわかるデータ削除方法

1. CriteriaBuilderとcreateCriteriaDeleteとは？

1. CriteriaBuilderとcreateCriteriaDeleteとは？

SpringのCriteriaBuilderは、JPA（Java Persistence API）で用意されている機能のひとつで、プログラムから安全にクエリを組み立てるためのクラスです。SQLのように文字列で直接クエリを書くのではなく、Javaコードで条件を組み立てるため、ミスを防ぎやすいのが特徴です。

その中でもcreateCriteriaDeleteは、条件を指定してデータを削除するための専用メソッドです。たとえば「特定のステータスのデータだけ削除したい」といったケースで活躍します。条件をあとから変更しやすいため、検索条件が変わるシステムでも柔軟に対応できます。

初心者の方は、まず「条件をJavaで書ける削除処理」とイメージすると理解しやすいです。以下は、とてもシンプルな使い方のイメージです。

CriteriaBuilder cb = entityManager.getCriteriaBuilder();
CriteriaDelete<Employee> delete = cb.createCriteriaDelete(Employee.class);
Root<Employee> root = delete.from(Employee.class);

// statusが"Inactice"のデータを削除する条件
delete.where(cb.equal(root.get("status"), "Inactive"));

このように、削除対象のテーブルと条件を順番に指定するだけで、シンプルかつ安全にデータ削除処理を構築できます。SQLに慣れていない方でも扱いやすい点が大きなメリットです。

2. createCriteriaDeleteの基本的な使い方

2. createCriteriaDeleteの基本的な使い方

ここでは、createCriteriaDeleteを使って「条件に一致するデータを削除する基本的な流れ」を、初心者の方でも理解できるように解説します。ポイントは、「削除対象」「条件」「実行」の3ステップで考えることです。例えば、"Inactive"ステータスの従業員データだけを削除したい場合、この流れに沿って処理を組み立てます。

また、SQLのDELETE文と違い、Javaコードで安全に条件を組み立てられるため、タイプミスや構文エラーを防ぎやすいのも特徴です。まずは以下のシンプルなサンプルコードを確認しながら、全体の動きをつかんでいきましょう。

import javax.persistence.*;
import javax.persistence.criteria.*;

public class CriteriaDeleteExample {
    public static void main(String[] args) {
        EntityManagerFactory emf = Persistence.createEntityManagerFactory("examplePU");
        EntityManager em = emf.createEntityManager();

        try {
            em.getTransaction().begin();

            // 1. CriteriaBuilderを取得（クエリ作成の準備）
            CriteriaBuilder cb = em.getCriteriaBuilder();

            // 2. 削除クエリを作成（Employeeテーブル対象）
            CriteriaDelete<Employee> delete = cb.createCriteriaDelete(Employee.class);

            // 3. 削除対象のテーブル情報を取得
            Root<Employee> root = delete.from(Employee.class);

            // 4. 条件を設定（statusが"Inactive"のデータ）
            delete.where(cb.equal(root.get("status"), "Inactive"));

            // 5. クエリを実行して削除
            int deletedRows = em.createQuery(delete).executeUpdate();

            System.out.println("Deleted rows: " + deletedRows);

            em.getTransaction().commit();
        } finally {
            em.close();
            emf.close();
        }
    }
}

このように、「条件を指定してまとめて削除する」処理を、シンプルな手順で実装できます。最初は難しく感じるかもしれませんが、流れを覚えてしまえば応用もしやすく、実務でもよく使われる重要な書き方です。

3. createCriteriaDeleteの実行結果

3. createCriteriaDeleteの実行結果

上記のコードを実行すると、"Inactive"ステータスの従業員データがデータベースからまとめて削除されます。executeUpdate()の戻り値には「実際に削除された件数」が数値で返されるため、処理結果を確認する際の目安になります。

例えば、削除対象のデータが4件存在していた場合は、以下のように「4件削除された」という結果が出力されます。対象データが存在しない場合は「0」と表示されるため、条件が正しく設定されているかの確認にも役立ちます。

Deleted rows: 4

初心者の方は、「削除された件数がそのまま結果として表示される」と覚えておくと理解しやすいです。開発中はこの値をログやコンソールに出力しておくことで、意図したデータだけが削除されているか安全に確認できます。

4. createCriteriaDeleteを使うメリット

4. createCriteriaDeleteを使うメリット

createCriteriaDeleteを使用することで、以下のようなメリットがあります。特に、手動でSQLを書く場合と比べて、コードの可読性や保守性が向上する点が大きな特徴です。

• 動的な条件設定：削除対象の条件をプログラム的に変更可能。if文などと組み合わせて柔軟に対応できます。
• 効率的なデータ削除：複数レコードを一度に削除可能。ループ処理を使わず高速に処理できます。
• 型安全性：クエリ内でフィールドや値が型安全に管理されるため、実行前にエラーに気付きやすいです。

例えば「特定の条件があるときだけ削除する」といったケースも、Javaコードとして自然に書けるため、初心者でも扱いやすいのがポイントです。

String status = "Inactive";

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaDelete<Employee> delete = cb.createCriteriaDelete(Employee.class);
Root<Employee> root = delete.from(Employee.class);

// 条件がある場合だけ削除条件を設定
if (status != null) {
    delete.where(cb.equal(root.get("status"), status));
}

このように、通常のJavaの書き方で条件を組み立てられるため、「条件が増えた」「仕様が変わった」といった場合でも修正が簡単です。実務では、大量のデータを安全かつ効率よく削除する場面が多いため、非常に役立つテクニックといえます。

5. 注意点

5. 注意点

createCriteriaDeleteを使用する際には、以下の点に注意してください：

• トランザクション管理：削除操作にはトランザクションが必要です。
• 条件設定の確認：削除条件を正確に設定しないと、予期しないデータが削除される可能性があります。
• 関連データへの影響：削除対象のエンティティに関連するデータの整合性を確認してください。

6. まとめ

6. まとめ

本記事では、SpringのCriteriaBuilderクラスを使用してcreateCriteriaDeleteメソッドを利用したデータ削除の方法について解説しました。createCriteriaDeleteを使うことで、動的な条件設定が可能となり、効率的かつ安全にデータ削除が行えることを学びました。

また、トランザクションの管理や削除条件の設定、関連データへの影響を考慮する重要性についても理解しました。この方法は、大量データを扱うアプリケーションや、柔軟性が求められる環境で非常に役立ちます。

以下に、複数条件を使用したcreateCriteriaDeleteの応用例を示します。

import javax.persistence.*;
import javax.persistence.criteria.*;

public class AdvancedCriteriaDelete {
    public static void main(String[] args) {
        EntityManagerFactory emf = Persistence.createEntityManagerFactory("examplePU");
        EntityManager em = emf.createEntityManager();

        try {
            em.getTransaction().begin();

            // CriteriaBuilderのインスタンスを取得
            CriteriaBuilder cb = em.getCriteriaBuilder();

            // createCriteriaDeleteでCriteriaDeleteを作成
            CriteriaDelete<Employee> delete = cb.createCriteriaDelete(Employee.class);

            // 削除対象のエンティティを指定
            Root<Employee> root = delete.from(Employee.class);

            // 複数の条件を設定
            delete.where(
                cb.and(
                    cb.equal(root.get("status"), "Inactive"),
                    cb.lessThan(root.get("yearsOfService"), 2)
                )
            );

            // 削除クエリの実行
            int deletedRows = em.createQuery(delete).executeUpdate();

            System.out.println("Deleted rows: " + deletedRows);

            em.getTransaction().commit();
        } finally {
            em.close();
            emf.close();
        }
    }
}

このコードでは、"Inactive"ステータスで勤務年数が2年未満の従業員データを削除しています。

以下は実行結果の例です。

Deleted rows: 2

この記事を読んだ人からの質問

この記事を読んだ人からの質問

プログラミング初心者からのよくある疑問／質問を解決します

Spring FrameworkのCriteriaBuilderとは何ですか？初心者にもわかりやすく教えてください。

Spring Frameworkで利用されるCriteriaBuilderとは、JPA（Java Persistence API）というデータ操作の規格に含まれる非常に便利なクラスです。最大の特徴は、データベースに対する命令（クエリ）を文字列として直接書くのではなく、Javaのプログラムコードとして組み立てられる点にあります。これにより、プログラムの実行前に間違いに気づきやすくなる「型安全」な開発が可能になります。特に検索条件が途中で変わるような「動的クエリ」を作成する際に、プログラミング初心者にとっても非常に頼りになるツールです。

createCriteriaDeleteメソッドはどのような目的で使用する機能ですか？

createCriteriaDeleteメソッドは、CriteriaBuilderクラスの中に用意されているメソッドの一つで、その名の通り「データの削除（Delete）」に特化した機能を提供します。通常、データベースからデータを消すときはSQL文を書きますが、このメソッドを使うことで、Javaのオブジェクト指向の考え方を保ったまま、特定の条件に合致するレコードを安全かつ効率的に削除するための「削除専用のクエリ」を作成することができます。