SpringのCriteriaBuilderでconjunctionメソッドを使った条件付きクエリ作成方法を解説

1. CriteriaBuilderとは？

「1. CriteriaBuilderとは？」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

1. CriteriaBuilderとは？

CriteriaBuilderは、SpringのJPAを使用して動的なクエリを作成するためのクラスです。これを利用すれば、SQLを直接記述せずにJavaコードで柔軟なクエリを作成することが可能です。

特に、動的な条件付きデータ検索や、複雑な検索ロジックが必要な場合に役立ちます。今回紹介するconjunctionメソッドは、初期状態で空の条件を作成する際に使用されます。

2. conjunctionメソッドとは？

2. conjunctionメソッドとは？

CriteriaBuilderのconjunctionメソッドは、初期状態で空の条件（true条件）を作成するためのメソッドです。これを利用すると、後から条件を追加していく形式で動的なクエリを作成することができます。

例えば、特定の条件を後から動的に設定する場合に役立ちます。また、条件がない場合でもクエリが正常に動作するようにするための初期状態を提供します。

3. 実際のコード例

3. 実際のコード例

以下は、conjunctionメソッドを使用して動的に条件を追加する例です。

import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;
import jakarta.persistence.criteria.Predicate;
import jakarta.persistence.criteria.Root;

import org.springframework.stereotype.Repository;
import org.springframework.beans.factory.annotation.Autowired;

import jakarta.persistence.EntityManager;

@Repository
public class ProductRepository {

    @Autowired
    private EntityManager entityManager;

    public List<Product> findProductsDynamically(Double minPrice, String category) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<Product> query = cb.createQuery(Product.class);
        Root<Product> root = query.from(Product.class);

        Predicate predicate = cb.conjunction();

        if (minPrice != null) {
            predicate = cb.and(predicate, cb.greaterThanOrEqualTo(root.get("price"), minPrice));
        }
        if (category != null) {
            predicate = cb.and(predicate, cb.equal(root.get("category"), category));
        }

        query.select(root).where(predicate);

        return entityManager.createQuery(query).getResultList();
    }
}

このコードのポイント：

• conjunctionメソッドで初期状態の条件を作成している点。
• 条件が動的に追加されるため、柔軟なクエリ作成が可能である点。
• 条件がない場合でも、空の条件でクエリが動作する点。

4. 実行結果例

「4. 実行結果例」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

4. 実行結果例

データベースに以下のデータがある場合：

ID | 商品名      | 価格  | カテゴリ
1  | 商品A       | 120   | 食品
2  | 商品B       | 90    | 電化製品
3  | 商品C       | 80    | 食品

例えば、「価格が100以上、カテゴリが『食品』」の商品を検索すると、結果は以下の通りです：

商品A

5. 応用：conjunctionメソッドを使った柔軟なクエリ作成

5. 応用：conjunctionメソッドを使った柔軟なクエリ作成

conjunctionメソッドは、他の条件メソッドと組み合わせて柔軟なクエリを作成することが可能です。例えば、「価格が100以上、またはカテゴリが『食品』」の商品を検索する場合、以下のように記述します。

query.where(
    cb.or(
        cb.greaterThanOrEqualTo(root.get("price"), 100),
        cb.equal(root.get("category"), "食品")
    )
);

このように、conjunctionメソッドを起点に条件を組み立てることで、動的かつ効率的なクエリ作成が可能になります。

6. まとめ

6. まとめ

この記事では、SpringのCriteriaBuilderクラスのconjunctionメソッドを使用して、動的なクエリを作成する方法を解説しました。conjunctionメソッドは、空の条件を作成するための便利な機能で、後から動的に条件を追加できる柔軟性が特徴です。

特に、複数の条件を動的に組み立てる必要がある場合や、条件が存在しない場合でもクエリが正常に動作するようにする場面で役立ちます。また、他のCriteriaBuilderメソッド（andやor）と組み合わせることで、複雑なクエリを簡潔に構築することが可能です。

以下に応用例として、「価格が100以上、カテゴリが『食品』でない商品」を検索するクエリを紹介します。この例では、conjunctionメソッドを使って、複数の条件を組み合わせています。

query.where(
    cb.and(
        cb.greaterThanOrEqualTo(root.get("price"), 100),
        cb.not(cb.equal(root.get("category"), "食品"))
    )
);

このように、conjunctionメソッドを起点に柔軟な条件を設定することで、プロジェクト要件に合わせた効率的なクエリを構築できます。

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

「この記事を読んだ人からの質問」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

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

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

SpringのCriteriaBuilderとは、初心者向けに一言で言うとどのような役割を持つクラスなのですか？

Spring Framework（スプリングフレームワーク）のJPA環境において、データベースへの命令文であるSQLを直接文字列で書かなくても、Javaのプログラムコードとして「動的なクエリ」を組み立てられるようにするための非常に便利なクラスです。これを使うことで、検索条件がその時々で変わるような複雑な検索システムを、ミスを少なく柔軟に作成できるようになります。