SpringのCriteriaBuilderでcountDistinctメソッドを使ったユニークデータ数の取得方法を解説

1. CriteriaBuilderとは？

1. CriteriaBuilderとは？

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

特に、データのカウントやユニークなデータ数の取得、条件付きの検索などに便利です。countDistinctメソッドを使用すれば、重複を除いたデータの数を効率的に取得できます。

2. countDistinctメソッドとは？

2. countDistinctメソッドとは？

CriteriaBuilderのcountDistinctメソッドは、特定の列においてユニークなデータの数をカウントするためのメソッドです。たとえば、商品のカテゴリ数を取得したい場合に使用できます。

通常のcountメソッドは全データをカウントしますが、countDistinctは重複を除外したデータのみを対象とする点が異なります。

3. 実際のコード例

3. 実際のコード例

以下は、商品のカテゴリ数を取得する具体的な例です。

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 Long getDistinctCategoryCount() {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<Long> query = cb.createQuery(Long.class);
        Root<Product> root = query.from(Product.class);

        query.select(cb.countDistinct(root.get("category")));

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

このコードの重要なポイント：

• CriteriaBuilderを使用して動的にクエリを作成している点。
• countDistinctメソッドを使い、ユニークなデータ数を取得している点。
• Rootを利用して、対象の列（ここではカテゴリ）を指定している点。

4. 実行結果例

4. 実行結果例

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

ID | 商品名      | カテゴリ
1  | 商品A       | 食品
2  | 商品B       | 食品
3  | 商品C       | 電化製品
4  | 商品D       | 日用品

この場合、カテゴリ「食品」「電化製品」「日用品」の3つがユニークな値として認識され、結果は3になります。

3

5. 応用：条件付きのユニークデータ数取得

5. 応用：条件付きのユニークデータ数取得

条件を指定してユニークなデータ数を取得することも可能です。たとえば、「在庫が10以上の商品のカテゴリ数」を取得したい場合、以下のようにwhere句を追加します。

query.where(cb.greaterThanOrEqualTo(root.get("stock"), 10));

この方法により、条件に一致するユニークなカテゴリの数を取得できます。プロジェクトによっては頻繁に使用される機能ですので、ぜひ試してみてください。

6. まとめ

6. まとめ

本記事では、SpringのCriteriaBuilderを使用してユニークなデータ数を取得する方法について解説しました。特にcountDistinctメソッドの基本的な使い方から、条件付きのユニークデータ取得まで、実践的な内容を取り上げました。

countDistinctメソッドを利用すると、特定の列における重複を除いたデータ数を効率的に取得できます。これにより、データの集計や分析を効率よく行うことが可能です。さらに、条件を指定することで、柔軟にユニークデータを絞り込むこともできます。

CriteriaBuilderには、他にもsumやavgなどの集計メソッドがあり、これらを組み合わせることで、より高度なデータ処理が可能です。今回学んだcountDistinctを第一歩として、ぜひ他のメソッドにも挑戦してみてください。

以下は、複数条件を指定してユニークデータ数を取得する例です。

query.where(
    cb.and(
        cb.equal(root.get("status"), "active"),
        cb.greaterThan(root.get("stock"), 50)
    )
);
query.select(cb.countDistinct(root.get("category")));

この例では、ステータスがactiveで、在庫が50以上の商品カテゴリ数を取得するクエリを構築しています。実際のプロジェクトで応用できるシナリオの一つです。