私たちのチームではJava + Spring Boot を使用してWebアプリケーションのバックエンドAPIを構築しています。バックエンドの開発にはデータベースとのやり取りが必須になります。この記事ではデータベースCRUD処理の開発に役立つORMについて解説し、実際に私たちのチームでSpring Data JPA を採用したエピソードと、最後に導入方法について紹介します。

ORMとは

ORM(Object-Relational Mapping)とは、アプリケーションのオブジェクトとリレーショナルデータベース(以下「DB」)のレコード、およびオブジェクト間の関連とテーブル間のリレーションシップを相互にマッピング(対応付け)する技法です。
ORMを実現するための機能やソフトウェアをORマッパーといいます。
これらはプログラミング手法にオブジェクト指向、データストアにリレーショナルデータベースを使用した際に、SQLクエリ結果を1行ずつ取り出しJavaオブジェクトに詰めるといった開発者の負担を軽減できます。

ORマッパーのメリット

採用するORマッパーにより機能の差異はありますが、基本的に以下の機能を提供します。

• インピーダンスミスマッチの解消

  オブジェクト指向のオブジェクトは「現実世界に即したデータモデル」であるのに対し、リレーショナルデータベースは「データの検索や更新などの処理に最適化されたデータモデル」です。この設計思想の違いをインピーダンスミスマッチといい、これによりデータのマッピングが煩雑になります。
  ORマッパーではこうしたオブジェクトとDBレコード間のデータマッピングを自動で行います。自動マッピングにより開発者はSQLクエリ結果からJavaオブジェクトへデータを詰める作業から開放され、テーブル構造を意識せずともデータの取得や永続化が可能になります。

• ボイラープレートコードの排除

  ボイラープレートコードとは、言語仕様により複数の場所で繰り返される定型コードです。本来実装したい業務ロジックとは直接関係しないコードとなります。
  JavaのDBアクセスにおいては以下の処理に関するコードが挙げられます。

  • プリペアドステートメントの作成/値セット
  • リザルトセットからのデータ取得……など

  ORマッパーの導入によりこれらのボイラープレートコードをソースコードから排除でき、開発効率の向上・可読性の向上などが期待できます。

• プリペアドステートメントによるサニタイジング

  クエリを発行する方法は各ORマッパーにより様々ですが、SQLを自動生成することが可能なものがあります。
  そうしたORマッパーでは開発者が明示的にSQLを書く必要が無くなるため、SQLインジェクションのリスクを回避することができます。

ORマッパーのデメリット

ORマッパーの導入によって以下のデメリットをもたらす可能性があります。

• SQLチューニングができない

  SQL自動生成機能を持つORマッパーでは、SQLパフォーマンスを改善しようと思っても、開発者が改善対象のSQLを直接編集することができず、パフォーマンス改善の障壁になる場合があります。
  ただし、中には明示的にSQLを記述して問合せを行うことができるものもあります。

• N+1問題 ⧉

  ORマッパーがSQLを自動生成する際に、適切にJOINを行ってくれずN+1問題を引き起こす場合があります。これによりDBからデータを取得する処理のパフォーマンスが低下する恐れがあります。
  これにはソースコード内で明示的にJOIN句を含むSQLを記述するか、ORマッパーのローディング(フェッチ)設定を「EAGER」にすることでN+1問題を解決できる場合があります。

JPA・Spring Data JPAとは

JPA(Java Persistence API)とは、Jakarta EE(Java EE)標準のORマッパーです。JPAは仕様(Interface)のみ提供し、その実装はJPAプロバイダより提供されます。

Spring Data JPAとは、Springフレームワーク群のSpring Dataファミリー内のデータベースプロジェクトの1つです。
その名のとおりJPAをベースとしており、JPAを使いやすくラップしたものがSpring Data JPAです。
Spring Data JPAではデフォルトのJPAプロバイダとしてHibernate ⧉を使用します。

Spring Data JPAを使用して

実際に私たちのチームでORマッパーとしてSpring Data JPAを採用した理由と、開発に取入れてみてのメリット/デメリットを紹介します。

ORマッパーの選定

一言に「ORマッパー」といっても、JDBC ⧉を薄くラップしたものから、データのマッピング以外にも多様な機能を提供するものまで、その種類は様々です。
基本的に機能が少なくSQLネイティブなORマッパーほど、その学習コストが低くなります。
反対に高機能でJavaネイティブに使用できるORマッパーほど複雑性が増し、固有知識の習得が必要になります。
どのようなORマッパーが最適なのかをプロジェクトによって判断していく必要があります。

ORマッパーの選定については次のスライドが参考になります。
Java ORマッパー選定のポイント（2019/1/31 株式会社カサレアル 多田真敏氏） ⧉

私たちのチームでは次の理由からSpring Data JPAを採用しました。

• DBアクセス処理に起因するバグを減らすため

  開発者が記述するコード量が増えるほどバグが増えやすいという考えのもと、高機能で、開発者のコード記述量が少なくて済むものを採用しました。

• 開発効率を上げるため

  これもバグ削減と同様に、実装に伴うコード記述量を減らすためです。また記述量が減ることによって可読性が向上し、コード修正やコードレビューの敏捷性が高まることを期待して採用しました。

• 教育/学習コストを最小限に抑えるため

  開発経験が少なくDBに対して深い知識を持たないメンバーのアサインが多くあったため、DBを意識せずとも開発が可能な強力なORマッパーを探していました。また開発チーム内にDBやJPAに詳しくデータマッピングの設定ができるメンバーが1人以上いれば、その他のメンバーは永続化コンテキストやEntityManager等の複雑なJPAの仕様を理解しきらずとも多くの機能を効率的に利用できることから、Spring Data JPAを採用しました。

Spring Data JPA導入による効果

私たちのチームでは、Spring Data JPA導入の結果、以下の効果を得ることができました。

• メンバーのアサインを早めることができた

  DB関連知識の学習/教育コストを削減することによりアサイン前の学習期間を短縮し、プロジェクトへのアサインを早めることができました。また業務ロジックの開発に意識とリソースを集中させることができました。

• 長く複雑なSQLをソースコード内から排除することができた

  それまでソースコード内に直書きしていたSQLを、Spring Data JPAのQuery Methods ⧉機能を使用して排除することができました。

• クエリ結果をJavaオブジェクトに詰める処理をソースコード内から排除することができた

  結果を詰め替えるだけのボイラープレートコードをソースコード内から排除し、開発効率とソースコードの可読性が向上しました。

Spring Data JPA導入に伴う課題

開発ノウハウ引継ぎの体制が整っていなかった

教育/学習コストを低く抑える事ができるという期待から導入したSpring Data JPAですが、これはプロジェクト内に1人以上DBやJPAの仕様に詳しい人がいる前提での採用でした。
長期のプロジェクトで「プロジェクトの期間」が「１メンバーが開発に携わる期間」よりも長いことを考えると、開発/技術ノウハウの引継ぎにある程度の労力が必要になります。それらの知識を引継ぐ体制の構築が課題のひとつです。

Spring Data JPAの導入方法

Spring(Java)プロジェクトにSpring Data JPAを導入する方法を紹介します。

ファイル構成

sample
└── src
    └── main
        └── java
           └── jp
               └── co
                   └── alpha
                       └── sample
                           ├── Sample.java
                           ├── SampleApplication.java
                           ├── model
                           │   ├── Department.java
                           │   └── Employee.java
                           └── repository
                               └── EmployeeRepository.java

1. ビルドツールの依存関係にSpring Data JPAプロジェクトを追加する

   pom.xml (Mavenの場合)

   1
       <dependency>
   2
           <groupId>org.springframework.boot</groupId>
   3
           <artifactId>spring-boot-starter-data-jpa</artifactId>
   4
       </dependency>

   build.gradle (Gradleの場合)

   1
   dependencies {
   2
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa',
   3
   }

2. Entityに、対応するDBテーブルの情報を付与する

   次のようなテーブル定義の場合

   1
   CREATE TABLE departments (
   2
       department_id INT PRIMARY KEY,
   3
       department_name TEXT NOT NULL
   4
   );
   5
   
   6
   CREATE TABLE employees (
   7
       employee_id INT PRIMARY KEY,
   8
       name TEXT NOT NULL,
   9
       mail_address TEXT NOT NULL,
   10
       department_id INTEGER NOT NULL REFERENCES departments(department_id)
   11
   );

   サンプルレコード

   1
   INSERT INTO departments VALUES
   2
       (1, '経理部'),
   3
       (2, '総務部'),
   4
       (3, '企画部');
   5
   
   6
   INSERT INTO employees VALUES
   7
       (1, 'アルファ太郎', 'taro@alpha.co.jp', 1),
   8
       (2, 'アルファ次郎', 'jiro@alpha.co.jp', 1),
   9
       (3, 'アルファ花子', 'hanako@alpha.co.jp', 3);

   以下のようにクラスにDBテーブルの情報を付加します。
   Department.java

   1
   package jp.co.alpha.sample.model;
   2
   
   3
   import javax.persistence.Column;
   4
   import javax.persistence.Entity;
   5
   import javax.persistence.Id;
   6
   import javax.persistence.Table;
   7
   
   8
   // テーブルとマッピングを行うオブジェクト(Entity)であることを明示
   9
   @Entity
   10
   // 対応するテーブル名を明示
   11
   @Table(name = "departments")
   12
   public class Department {
   13
   
   14
       // 主キーに付加
   15
       @Id
   16
       // 対応するカラム名を明示
   17
       @Column(name = "department_id")
   18
       private int id;
   19
   
   20
       @Column(name = "department_name")
   21
       private String name;
   22
   
   23
       // コンストラクターおよびアクセサーメソッド 省略
   24
   }

   Employee.java

   1
   package jp.co.alpha.sample.model;
   2
   
   3
   import javax.persistence.Column;
   4
   import javax.persistence.Entity;
   5
   import javax.persistence.Id;
   6
   import javax.persistence.Table;
   7
   
   8
   @Entity
   9
   @Table(name = "employees")
   10
   public class Employee {
   11
   
   12
       @Id
   13
       @Column(name = "employee_id")
   14
       private int id;
   15
   
   16
       // フィールドとカラムが同名の場合は@Column不要
   17
       private String name;
   18
   
   19
       // camelCase → snake_case の変換を行って一致するカラム名がある場合も@Column不要
   20
       // カラム名: mail_address
   21
       private String mailAdress;
   22
   
   23
       private int departmentId;
   24
   
   25
       // 結果確認用
   26
       @Override
   27
       public String toString() {
   28
           return "id: " + this.id + "\n"
   29
                + "name: " + this.name + "\n"
   30
                + "mailAddress: " + this.mailAddress + "\n"
   31
                + "departmentId: " + this.departmentId + "\n";
   32
       }
   33
   
   34
       // コンストラクターおよびアクセサーメソッド 省略
   35
   }

3. Repositoryインターフェースを作成する

   JpaRepositoryインターフェースを継承したインターフェースを宣言することで、JpaRepository ⧉が提供するメソッドを実装することができます。

   EmployeeRepository.java

   1
   package jp.co.alpha.sample.repository;
   2
   
   3
   import org.springframework.data.jpa.repository.JpaRepository;
   4
   import org.springframework.stereotype.Repository;
   5
   import jp.co.alpha.sample.model.Employee;
   6
   
   7
   @Repository
   8
   // JpaRepository<操作対象のEntity, 操作対象Entityの主キーの型>
   9
   public interface EmployeeRepository extends JpaRepository<Employee, Integer>{
   10
   }

4. Repositoryインターフェースの利用

   1
   package jp.co.alpha.sample;
   2
   
   3
   import java.util.List;
   4
   import org.springframework.beans.factory.annotation.Autowired;
   5
   import org.springframework.context.annotation.Bean;
   6
   import org.springframework.context.annotation.Configuration;
   7
   import jp.co.alpha.sample.model.Employee;
   8
   import jp.co.alpha.sample.repository.EmployeeRepository;
   9
   
   10
   @Configuration
   11
   public class Sample {
   12
   
   13
       // EmployeeRepositoryをインスタンス化
   14
       // EmployeeRepositoryの実装(Implementation)はSpring Data JPAにより生成される
   15
       @Autowired
   16
       private EmployeeRepository employeeRepository;
   17
   
   18
       @Bean(initMethod = "init")
   19
       public void sysoutEmployees() {
   20
           // findAll()でemployeesテーブル全件取得
   21
           List<Employee> employeeList = employeeRepository.findAll();
   22
           employeeList.forEach(employee -> System.out.println(employee));
   23
       }
   24
   
   25
   }

実行結果

1
$ mvn spring-boot:run
2
...
3
id: 1
4
name: アルファ太郎
5
mailAddress: taro@alpha.co.jp
6
departmentId: 1
7

8
id: 2
9
name: アルファ次郎
10
mailAddress: jiro@alpha.co.jp
11
departmentId: 1
12

13
id: 3
14
name: アルファ花子
15
mailAddress: hanako@alpha.co.jp
16
departmentId: 3
17
...

以上のようにEntity, Repositoryを定義することで、EmployeeRepositoryクラスを介してDBから目的のレコードをEmployeeエンティティに取得することができます。またsave ⧉メソッドを使用してレコードの挿入や更新処理、delete ⧉メソッドを使用してレコードの削除処理をそれぞれ行うことができます。

おわりに

ORMおよびORマッパーの役割、それから実際に私たちのチームでSpring Data JPAを使用した事例について紹介しました。
オブジェクト指向 × リレーショナルデータベースによる開発は現在多くのプロジェクトで行われています。また今後も当分の間はこれらのパラダイムに則った技術を使用しての開発が行われるものと思います。その際に必ずオブジェクト指向とリレーショナルデータベースの設計思想の違いにより、データマッピングに関する不都合が生じます。それらをプロジェクトの方針や実情に合わせてどのように対応していくのか。それを考える上での参考になれば幸いです。

参考資料

[1] Java ORマッパー選定のポイント（2019/1/31 株式会社カサレアル 多田真敏氏） ⧉