4.3. インフラストラクチャ層の実装

インフラストラクチャ層では、RepositoryImplの実装を行う。

RepositoryImplは、Repositoryインタフェースで定義したメソッドの実装を行う。

4.3.1. RepositoryImplの実装

以下に、MyBatis3とJPAを使って、リレーショナルデータベース用のRepositoryを作成する方法を紹介する。

4.3.1.1. MyBatis3を使ってRepositoryを実装

リレーショナルデータベースとの永続APIとしてMyBatis3を使う場合、 MyBatis3から提供されている「Mapperインタフェースの仕組みについて」を利用してRepositoryインタフェースを作成すると、 基本的にはRepositoryImplを実装する必要はない。

これは、MyBatis3が、Mapperインタフェースのメソッドと呼び出すステートメント(SQL)のマッピングを自動で行う仕組みになっているためである。

MyBatis3を使用する場合、アプリケーション開発者は、

  • Repositoryインタフェース(メソッドの定義)
  • マッピングファイル(SQLとO/Rマッピングの定義)

の作成を行う。

以下に、Repositoryインタフェースとマッピングファイルの作成例を示す。
MyBatis3の使用方法の詳細は、データベースアクセス（MyBatis3編）を参照されたい。
  • Repositoryインタフェース(Mapperインタフェース)の作成例
package com.example.domain.repository.todo;

import com.example.domain.model.Todo;

// (1)
public interface TodoRepository {
    // (2)
    Todo findOne(String todoId);
}
項番 説明
(1)

POJOのインタフェースとして作成する。

MyBatis3のインタフェースやアノテーションなどを指定する必要はない。
(2)

Repositoryのメソッドを定義する。

基本的には、MyBatis3のアノテーションを付与する必要はないが、 一部のケースでアノテーションを指定する事もある。
  • マッピングファイルの作成例
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- (3) -->
<mapper namespace="com.example.domain.repository.todo.TodoRepository">

    <!-- (4) -->
    <select id="findOne" parameterType="string" resultMap="todoResultMap">
      SELECT
          todo_id,
          title,
          finished
      FROM
          t_todo
      WHERE
          todo_id = #{todoId}
    </select>

    <!-- (5) -->
    <resultMap id="todoResultMap" type="Todo">
        <result column="todo_id" property="todoId" />
        <result column="title" property="title" />
        <result column="finished" property="finished" />
    </resultMap>

</mapper>
項番 説明
(3)

Repositoryインタフェース毎にマッピングファイルを作成する。

マッピングファイルのネームスペース(mapper要素のnamespace属性)には、 RepositoryインタフェースのFQCN(Fully Qualified Class Name)を指定する。
(4)

Repositoryインタフェースに定義したメソッド毎に実行するステートメント(SQL)の定義を行う。

ステートメントID(各ステートメント要素(select/insert/update/delete要素のid属性)には、 Repositoryインタフェースのメソッド名を指定する。
(5)

クエリを発行する場合は、必要に応じてO/Rマッピングの定義を行う。

シンプルなO/Rマッピングであれば自動マッピングを利用する事ができるが、複雑なO/Rマッピングを行う場合は、 個別にマッピングの定義が必要となる。

上記例のマッピング定義は、シンプルなO/Rマッピングなので自動マッピングを利用する事もできる。

4.3.1.2. JPAを使ってRepositoryを実装

リレーショナルデータベースとの永続APIとして、JPAを使う場合、Spring Data JPAのorg.springframework.data.jpa.repository.JpaRepositoryを使用すると、非常に簡単にRepositoryを作成することが出来る。
Spring Data JPAの使用方法の詳細は、データベースアクセス（JPA編）を参照されたい。
Spring Data JPAを使った場合、基本的なCRUD操作は、JpaRepositoryを継承したインタフェースを作成するだけでよい。つまり、基本的には、RepositoryImplは不要である。
ただし、動的なクエリ(JPQL)を発行する必要がある場合は、RepositoryImplが必要となる。
Spring Data JPA使用時のRepositoryImplの実装については、データベースアクセス（JPA編）を参照されたい。
  • TodoRepository.java
public interface TodoRepository extends JpaRepository<Todo, String> { // (1)
    // ...
}
項番 説明
(1)
 JpaRepositoryを継承したインタフェースを定義するだけで、Todoエンティティに対する基本的なCRUD操作を実装なしで実現できる。
JpaRepositoryから提供されていない操作を追加する場合について説明する。
Spring Data JPAを使った場合、静的なクエリであればインタフェースにメソッドを追加し、そのメソッドが呼び出された時に実行するクエリ（JPQL）をアノテーションで指定すればよい。
  • TodoRepository.java
public interface TodoRepository extends JpaRepository<Todo, String> {
    @Query("SELECT COUNT(t) FROM Todo t WHERE finished = :finished") // (1)
    long countByFinished(@Param("finished") boolean finished);
    // ...
}
項番 説明
(1)
 @Queryアノテーションで、クエリ（JPQL）を指定する。

4.3.1.3. RestTemplateを使って外部システムと連携するRepositoryを実装

Todo

TBD

次版以降で詳細化する予定である。