SpringDataJPAのJPAクエリメソッド「Containing」の使い方を完全ガイド！初心者向け解説

1. Containingとは？中間一致検索を簡単に実現

「1. Containingとは？中間一致検索を簡単に実現」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

1. Containingとは？中間一致検索を簡単に実現

Spring Data JPAのContainingとは、データベースのレコードの中から「特定の文字が含まれているデータ」を探し出すための魔法のようなキーワードです。 SQLでいうところの「LIKE句（%キーワード%）」による中間一致検索を、Javaのメソッド名だけで自動生成してくれます。

例えば、SNSのユーザー検索や商品のキーワード検索など、「名前の一部しか覚えていないけれど、一致するものをすべて表示したい」というシーンで非常に役立ちます。

実際のプログラムでは、以下のようにリポジトリ（データの操作窓口）にメソッドを定義するだけで、Spring Data JPAが裏側で複雑なSQLを組み立ててくれます。

// ユーザー名に指定した文字列が含まれているか検索する
List<User> findByUsernameContaining(String keyword);

このように、findBy + フィールド名 + Containingというルールに従って書くだけで、初心者でも迷わずに高度な検索機能を実装できるのが最大のメリットです。 プログラミング経験が浅い方でも、難しい検索ロジックを書く必要がないため、コードの可読性が非常に高くなります。

2. クエリメソッドの基本的な書き方

2. クエリメソッドの基本的な書き方

Spring Data JPAでは、メソッド名に特定のキーワードを含めるだけで、SQLを自動生成する「クエリメソッド」という便利な機能があります。 特に「部分一致検索」を行いたい場合に重宝するのが Containing キーワードです。

プログラミング未経験の方でも直感的に理解できるよう、まずはシンプルな 「名前（firstname）の一部で検索する」 サンプルコードを見てみましょう。

public interface UserRepository extends JpaRepository<User, Long> {
    // 苗字や名前に「特定の文字」が含まれている人を検索するメソッド
    List<User> findByFirstnameContaining(String firstname);
}

この findByFirstnameContaining という名前には、「Firstname（名前フィールド）から、Containing（引数の文字列を含む）データを、find（探してくる）」という意味が込められています。

例えば、引数に "子" と入力して実行すると、内部では 「%子%」 という形に変換され、「花子」「子太郎」「節子」といった具合に、指定した文字がどこかに入っているデータをすべて見つけ出します。

本来、データベースでこのような検索を行うには複雑なSQL文を書く必要がありますが、このメソッドを使えば、開発者が %（ワイルドカード）を意識してコードに書き込む必要はありません。 メソッド名を決めるだけで、Java側が自動的に最適な検索の仕組みを整えてくれるのが、このクエリメソッド最大のメリットです。

3. JPQLでの動作イメージ

3. JPQLでの動作イメージ

上記のクエリメソッドは、以下のようなJPQLに変換されます。

SELECT u 
FROM User u 
WHERE u.firstname LIKE ?1

パラメータには、自動的に%が前後に付加されます。 たとえば、"Ali"を指定した場合、"%Ali%"がクエリに使用されます。

4. 実際の使い方例

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

4. 実際の使い方例

以下は、findByFirstnameContainingをサービス層で使用する具体例です。

@Service
public class UserService {
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public List<User> findUsersByPartialName(String partialName) {
        return userRepository.findByFirstnameContaining(partialName);
    }
}

このコードでは、findByFirstnameContainingを呼び出し、指定した文字列を含むユーザーを取得しています。 例えば、findUsersByPartialName("Ali")を実行すると、「Ali」を含むすべてのユーザーが検索されます。

5. Containingを使うときの注意点

5. Containingを使うときの注意点

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

• デフォルトでは大文字小文字が区別されるため、必要に応じてUPPER関数やデータベース設定を確認してください。
• 大規模なデータセットでは、検索パフォーマンスが低下する可能性があります。インデックスを適切に使用してください。
• ワイルドカードが自動で追加されるため、クエリに渡すパラメータを加工する必要がありません。

これらの注意点を考慮しながら、効率的に部分一致検索を行いましょう。

6.まとめ

6.まとめ

今回はSpringDataJPAのクエリメソッドContainingについて解説しました。このメソッドは、指定した文字列を含むデータを簡単に検索できる便利な機能です。 サンプルコードを通じて、どのように実装し、実際のアプリケーションで活用できるかを学びました。 特に、ワイルドカードの追加が自動的に行われる点や、部分一致検索のパフォーマンスを意識することが重要なポイントでした。 今後、データベース検索において柔軟性を求める場面で役立つでしょう。

public interface ProductRepository extends JpaRepository<Product, Long> {
    List<Product> findByNameContaining(String name);
}
    

上記の例では、製品名に指定した文字列を含むデータを検索することができます。 例えば、「findByNameContaining("Phone")」を使用すると、「Phone」を含むすべての製品が検索されます。

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

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

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

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

SpringDataJPAのContainingとは何ですか？

Containingは、SpringDataJPAで部分一致検索を行うためのクエリメソッドです。指定した文字列を含むデータを簡単に検索できます。

Containingを使う基本的な書き方を教えてください。

リポジトリインターフェースに「findByフィールド名Containing」と記述することで、指定したフィールド内に部分一致するデータを検索できます。

ContainingとLIKEクエリの関係は何ですか？

Containingは、JPQLでLIKEクエリに変換されます。自動的にパラメータの前後に%が付与され、部分一致検索が可能になります。

大文字小文字を区別せずに検索するにはどうすれば良いですか？

大文字小文字を区別せずに検索するには、データベース設定で大文字小文字を無視するか、JPQLでUPPER関数を使用して文字列を正規化する方法があります。

Containingを使う際のパフォーマンスに関する注意点は何ですか？

大規模なデータセットでは検索パフォーマンスが低下する可能性があります。インデックスを適切に設定して効率的な検索を実現しましょう。

Containingを使用した実際のシナリオは何ですか？

例えば、ユーザー名や製品名に部分一致するデータを検索する場面で役立ちます。「findByFirstnameContaining」で名前検索が簡単に行えます。

JPQLでContainingはどのように動作しますか？

Containingを使ったクエリメソッドは、JPQLで「WHERE フィールド名 LIKE ?1」に変換され、部分一致検索が行われます。

ContainingとStartingWithやEndingWithの違いは何ですか？

Containingは部分一致、StartingWithは前方一致、EndingWithは後方一致の検索を行います。それぞれ用途に応じて使い分けます。

文字列以外のデータ型にContainingは使えますか？

基本的には文字列フィールドに使用されます。数値や日付などのフィールドには適していません。

初心者がContainingを学ぶ際に注意すべきことは何ですか？

クエリメソッドの命名規則を正確に守り、大文字小文字や検索対象のフィールドが適切に設定されていることを確認してください。