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

1. CriteriaBuilderとは？

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

1. CriteriaBuilderとは？

CriteriaBuilderは、SpringのJPAで動的なクエリを作成するためのクラスです。このクラスを使うことで、SQLを直接記述する必要がなく、Javaコード内で柔軟なクエリを構築できます。

動的クエリを利用する場面では、特定の条件を否定したデータを取得したいケースもよくあります。notメソッドを使えば、簡単に条件を反転させたクエリを作成できます。

2. notメソッドとは？

2. notメソッドとは？

CriteriaBuilderのnotメソッドは、指定された条件を否定するクエリを作成するためのメソッドです。つまり、「特定の条件に一致しないデータ」を検索する際に使用します。

例えば、「価格が100未満の商品を検索する」や「特定のカテゴリ以外の商品を検索する」といった場合に役立ちます。notメソッドを使うことで、柔軟かつ明確な条件付きクエリを簡単に作成できます。

3. 実際のコード例

3. 実際のコード例

以下は、価格が100未満の商品を検索する例です。

import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;
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> findProductsNotAbovePrice(double maxPrice) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<Product> query = cb.createQuery(Product.class);
        Root<Product> root = query.from(Product.class);

        query.select(root).where(
            cb.not(
                cb.greaterThanOrEqualTo(root.get("price"), maxPrice)
            )
        );

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

このコードのポイント：

• CriteriaBuilderを使用して動的なクエリを作成している点。
• notメソッドを使い、条件を否定するクエリを簡単に作成している点。
• 価格条件を反転させることで、指定した条件を満たさないデータを検索している点。

4. 実行結果例

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

4. 実行結果例

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

ID | 商品名      | 価格
1  | 商品A       | 120
2  | 商品B       | 90
3  | 商品C       | 80

価格が100以上でない商品を検索すると、結果は以下の通りです：

商品B, 商品C

5. 応用：複数条件を組み合わせたnotメソッドの活用

5. 応用：複数条件を組み合わせたnotメソッドの活用

notメソッドは他のメソッドと組み合わせることで、さらに複雑なクエリを作成することが可能です。例えば、「価格が100以上ではなく、かつ在庫が50未満の商品」を検索する場合、以下のように記述します。

query.where(
    cb.and(
        cb.not(cb.greaterThanOrEqualTo(root.get("price"), 100)),
        cb.lessThan(root.get("stock"), 50)
    )
);

このように、notメソッドを使用すると、さまざまな否定条件を簡単に組み合わせて検索することができます。

6. equalやlikeと組み合わせたnotメソッドの活用

6. equalやlikeと組み合わせたnotメソッドの活用

CriteriaBuilderのnotメソッドは、equalやlikeと組み合わせることで、特定の値や文字列に一致しないデータを取得することも可能です。

例えば、「特定のカテゴリに属さない商品」や「商品名に特定のキーワードを含まない商品」を検索したい場合に活用できます。

query.where(
    cb.not(
        cb.equal(root.get("category"), "Electronics")
    )
);

また、文字列検索で否定条件を使う場合は次のように記述します。

query.where(
    cb.not(
        cb.like(root.get("name"), "%Sale%")
    )
);

このように、notメソッドはさまざまな比較条件と組み合わせることができ、柔軟な動的クエリ作成を実現します。

7. Predicateを使った可読性の高い実装方法

「7. Predicateを使った可読性の高い実装方法」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

7. Predicateを使った可読性の高い実装方法

複雑な条件を扱う場合は、Predicateを利用するとコードの可読性が向上します。条件を変数として分離することで、メンテナンス性の高い実装が可能になります。

Predicate priceCondition = cb.greaterThanOrEqualTo(root.get("price"), 100);
Predicate notPriceCondition = cb.not(priceCondition);

query.where(notPriceCondition);

この方法を使えば、条件を段階的に構築できるため、ビジネスロジックが複雑になっても整理されたコードを保てます。

動的検索条件が増える場面では、Predicateをリストにまとめてからandやorで結合する実装もよく使われます。

8. notメソッド使用時の注意点

8. notメソッド使用時の注意点

notメソッドを使用する際は、条件の意味が分かりづらくならないように注意が必要です。特に否定条件が多重に重なると、クエリの意図が読み取りにくくなります。

また、データベースのインデックスや実行計画によっては、否定条件を多用するとパフォーマンスに影響を与える可能性があります。そのため、大量データを扱う場合は実行計画を確認しながら設計することが重要です。

可読性と性能を意識しながらCriteriaBuilderのnotメソッドを活用することで、安全かつ効率的な動的クエリを実装できます。

まとめ

まとめ

今回の記事では、SpringのCriteriaBuilderクラスのnotメソッドを使用した条件付きクエリ作成方法について詳しく解説しました。notメソッドを使うと、特定の条件を否定してデータを検索できるため、動的なクエリ作成の幅が広がります。

例えば、「特定の価格以上でない商品」や「特定のカテゴリ以外の商品」といった検索条件を簡単に構築できます。また、他のメソッドと組み合わせることで、さらに複雑な否定条件を実現できる点が魅力です。

実際の開発現場では、否定条件を使用するケースが多々あります。notメソッドを正しく理解し、活用することで、効率的で柔軟なデータ検索が可能になります。

以下に応用例として、「価格が100未満、かつ在庫が50未満ではない商品」を検索するクエリを紹介します。

query.where(
    cb.not(
        cb.and(
            cb.lessThan(root.get("price"), 100),
            cb.lessThan(root.get("stock"), 50)
        )
    )
);

このように、notメソッドと他の条件メソッドを組み合わせることで、複雑な検索条件を簡潔に記述できます。プロジェクト要件に応じて適切に活用してください。