【Spring Data JPA】基本操作とクエリ実装

導入

Spring Data JPA を使用するために、以下を追加します。 ドライバーは使用する DB に合わせて追加してください。

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
}

application.yml（.properties）に、データベースの接続設定をします。 以下は MySQL の設定例です。

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testdb
    username: hoge
    password: fugafuga
    driver-class-name: com.mysql.cj.jdbc.Driver

基本操作

Entity の作成

Spring Data JPA では、テーブルに対応する Entity クラスを作成する必要があります。 Entity クラスには、以下のように@Entityを付与します。

@Entity
@Table(name = 'user')
public class User {
  @Id
  @Column(name = "id")
  private String id;

  @Column(name = "name")
  private String name;

  @Column(name = "age")
  private int age;

  //セッター・ゲッターは省略
}

@Tableは、テーブル名とクラス名が同じであれば省略できます。 @Columnも同様に、テーブルのフィールド名とクラスのフィールド名が同じであれば省略できます。

キー項目には@Idを付与します。

Repository の作成

DB 操作用の Repository インターフェースを以下のように作成します。

@Repository
public interface UserRepository extends JpaRepository<User, String>{
}

@Repositoryを付与し、JpaRepository<>を継承します。 JpaRepository<>のジェネリクスには、対象となる Entity クラスと、キー項目の型を指定します。

結果の取得

作成した Repository を Inject して、CRUD に対応するメソッドを使用します。

※ 下例では、わかりやすさのために Controller で使用していますが、実際は Service で使用してください。

@RestController
@RequestMapping("/api/user")
public class UserController {

  @Autowired
  private UserRepository repository;

  @GetMapping
  public List<User> getAll() {
    //全件取得
    return repository.findAll();
  }

  @GetMapping("{id}")
  public User getById(@PathVariable("id") String id) {
    //IDで検索
    return repository.findById(id).orElseThrow();
  }

  @PostMapping
  public void save(@RequestMapping User user) {
    //更新
    repository.save(user);
  }

  @DeleteMapping("{id}")
  public User delete(@PathVariable("id") String id) {
    //削除
    repository.deleteById(id);
  }
}

以上が Spring Data JPA の基本的な使用方法になります。

クエリ実装

基本クエリ

Repository では、上記で使用したような CRUD に関するメソッドがいくつかデフォルトで生成されます。 以下はそのメソッドの一部になります。

カスタムクエリ

例えばnameを条件として検索し、レコードを取得したいとします。 これを実現するためには、Repository に以下のメソッドを追加します。

@Repository
public interface UserRepository extends JpaRepository<User, String>{
  List<User> findByName(String name);
}

あとは必要な箇所でこのメソッドを実行するだけです。

List<User> users = repository.findByName("太郎");

Spring Data JPA では、Repository にルールに従ってメソッドを定義することで、 自身でクエリを生成をせずに、目的の結果を得ることができます。 上記の場合は、以下のクエリが実行されたことになります。

select * from user
where name = ?

ルールというのは、メソッドの命名です。 決まったキーワードを組み合わせることで目的を満たすクエリが自動で生成されます。

まず初めに目的を設定します。 上記はレコードの取得のためにfindByというキーワードを使用しました。 その他以下のキーワードがあります。

次に条件を設定します。 上記では、findByNameとすることで「nameと一致する」という条件を設定しています。 等価条件以外は、以下のキーワードを用いて設定できます。 複数フィールドを条件とする場合は、メソッドで指定したフィールド順序とパラメーターの順序を同じにします。

最後に取得する結果に対して手を加えます。 以下のキーワードを使用することで、並び替えや取得レコード数を指定することができます。

JPQL

JPQL とは

JPQL は Java Persistence Query Language の略で、JPA で使用できるクエリです。 後述しますが、JPQL を使って独自のクエリを作成することができます。

基本的な文法はネイティブなクエリと同じですが、テーブルではなく Entity をベースに作成する点が異なります。 例えば、nameを条件にレコードを取得するクエリは以下のようになります。

select u from User u where u.name = ?1

FROM 句には、Entity 名と識別変数（AS 句）が必要になります。 SELECT 句や WHERE 句などでは、識別変数を使用してフィールドを指定します。

パラメーターは、「?1, ?2, ?3, ...」と順に設定します。d または:nameのように、名前付きパラメーターも使用できます。

また JPQL では以下の句、演算子、関数が使用できます。

句

• SELECT, UPDATE, DELETE
• WHERE, CASE
• ORDER BY
• GROUP BY, HAVING
• JOIN（INNER, OUTER）
• 副問い合わせ（WHERE, HAVING 内でのみ）

演算子

関数

@NamedQuery

JPQL を用いたクエリの作成方法の 1 つとして、@NamedQueryがあります。 これは、Entity に付与するアノテーションで、プロパティにnameとqueryを指定します。

@Entity
@NamedQuery(name = "myFindByAge", query = "select u from User u where u.age = ?1")
public class User {
  //...
}

使用する場合は、Repository にnameで指定した名前のメソッドを定義します。

List<User> myFindByAge(int age);

メソッドパラメーターの順序と?1の順序を合わせる必要があります。

@Query

もう 1 つの実装方法として、@Queryがあります。 @NamedQueryは Entity に付与しましたが、@Queryは Repository のメソッドに付与します。

@Query("select u from User u where u.age = ?1")
List<User> myFindByAge(int age);

メソッドパラメーターに@Paramを付与することで、名前付きパラメーターを使用することができます。

@Query("select u from User u where u.age = :age")
List<User> myFindByAge(@Param("age") int age);

また以下のようにnativeQueryプロパティを設定することで、JPQL ではなくネイティブなクエリを指定することができます。

@Query(value = "select * from user where age = ?1", nativeQuery = true)
List<User> myFindByAge(int age);

@Modifying

@Modifyingは、@Queryで更新形（UPDATE、DELETE）のクエリを指定した場合に必要となります。 またこの場合、Repository に@Transactionalを付与する必要もあります。

@Transactional
@Repository
public interface UserRepository extends JpaRepository<User, String> {
  @Modifying
  @Query("update User u set age = :age where id = :id")
  void setAge(@Param("age") int age, @Param("id") String id);
}