SIerに入って８年ぐらい経ったのでいろいろ棚卸しをしてみる。【vol.004 JPA】

## 出会い
２０１２年の秋頃にとある炎上PJにて[Hiberanate](https://www.techscore.com/tech/Java/Others/Hibernate/01/)に出会った。
[MyBatis](https://qiita.com/TsJazz27Sumin/items/199c15ea928f3d891000)で開発したあとだったので、SQLが自動発行される仕組みに感心した覚えがある。

その後も２０１４年頃にHibernateを使ったPJに行ったことがあって、そのPJも炎上していた。
どちらも炎上の原因は、Hibernateではなかったと思うし、たまたま「Spring × Hibernate」の組み合わせがSIの開発界隈で当時の流行りだっただけのように思う。

JPAに基づくO/Rマッパーだと、その後、[Spring Data JPA](https://docs.spring.io/spring-data/jpa/docs/current/reference/html/)を使ったPJを２０１５年にやっている。この時は、「SpringBoot × Spring Data JPA」の組み合わせで開発した。

## JPAとは
>JPA (Java Persistence API)は、O/Rマッピング・アーキテクチャのJava用フレームワークである。Javaオブジェクトをデータベースに格納したり、データベースのデータをJavaオブジェクトに変換する処理を自動化したりするため、JDBCを直接使用するのに比べ、簡素なプログラムコードでデータベース処理を実現できる。
>[JPA (Java Persistence API)](http://itref.fc2web.com/java/jpa/)

JavaのクラスにSQLを書く[JDBC](https://qiita.com/TsJazz27Sumin/items/44d5e09fe4cf4ee98bfb)の時代があって、SQLを外部ファイルに定義する[MyBatis](https://qiita.com/TsJazz27Sumin/items/199c15ea928f3d891000)の時代があって、もはやSQLは書かなくなった。DBのテーブルとのマッピングは、XMLにゴリゴリ書く必要もなく、[アノテーション](http://etc9.hatenablog.com/entry/20090830/1251606823)で済んでしまう。

[JPAは仕様にすぎず、機能するには実装が必要](https://www.codeflow.site/ja/article/jpa-hibernate-difference)で、SpringにおけるHibernate、SpringBootにおけるSpring Data JPAがそれに当たる。


## 振り返ってみて
[（オブジェクト・リレーショナル）インピーダンスミスマッチ](https://www.intersystems.com/wp-content/uploads/sites/6/ImpedianceMismatch.pdf)を解消するための仕組みとしては、根本的な思想としては素晴らしいものだと思う。Javaで操作するオブジェクトの世界とSQLで操作するDBのデータの世界は、確かに乖離がある。

ただ、[Hibernateはどのようにして私のキャリアを破滅寸前にしたか](https://www.kaitoy.xyz/2017/02/23/how-hibernate-ruined-my-career/)の例に漏れず、Hibernateに関わったPJは、パフォーマンス問題に悩まされていた。そして、ネィティブクエリで書き直して、インデックスを張ったりしてチューニングする。

Spring Data JPAでやった案件はそういった現実を知っているメンバーでやったので、発行されるSQLが複雑になりそうな検索とかは、最初からネィティブクエリで書いていった。

メリットとしては、JPAの特徴でもある

>Javaオブジェクトとデータベースのテーブル間のマッピング情報を、アノテーションを用いて定義する。これにより、エンティティをPOJO (Plain Old Java Object)で実装できたり、複雑な定義ファイルを作成する必要が無くなるなど、開発容易性を確保することができる。

だと実際、PJで触った上でも思う。

@～のアノテーションでサクサク定義しておけば、DBのテーブルとマッピングされるのは、開発の生産性が高い。簡単なマスターメンテナンス機能だったら、実装らしい実装をしなくてもCRUDの処理が成り立つ。

SpringDataJPAだったら、[インタフェースのメソッド名に応じて発行するSQLをコントロール](https://qiita.com/sndr/items/af7d12be264c2cc4b252)できるので、実装クラスを用意する必要さえなかったりする。圧倒的に記述量は少なくて済む。

デメリットは、使いこなすのに要求されるスキルがJDBCやMyBatisに比べて高いことのように思う。[Entityのライフサイクル管理](https://terasolunaorg.github.io/guideline/public_review/ArchitectureInDetail/DataAccessJpa.html#entity)だったり、そのキャッシュ機構への理解や実際にSQLがDBに発行されるタイミングの把握、ネイティブクエリの使い所を適切に判断する能力が要求される。

開発終盤で本番データ相当で処理させてみたら、使うに耐えないパフォーマンスしか出ない。flushのタイミングがおかしくて意図しないデータ更新が起きてしまう。実際にPJ内で遭遇した出来事だけど、それは仕組みの問題というよりは、使いこなせない人間の問題なんだろうと今、振り返って思う。

.NETに似たような仕組みで[Entity Framework](https://docs.microsoft.com/ja-jp/dotnet/framework/data/adonet/ef/overview)があって、意図しないデータ更新に悩まされた末、[Dapper](https://qiita.com/yut-nagase/items/863248e89b9b178b0ca3)メインの実装で進められているシステムに出会ったが、どこも似たような道を通るんだなと感じる。

## サンプルで実装してみる。
以下の記事を参考にさせていただきました。

 - [Spring Tool Suite インストールと日本語化 for Windows](https://qiita.com/andna0410/items/e9cc07c9e2e34a542245)
 - [Spring Boot環境でのSpring Data JPA 事始めメモ](https://qiita.com/shin_hayata/items/24d36fa349a9c7e5a176)
 - [SpringBoot + Spring JPAでデータベースに接続する](https://qiita.com/t-iguchi/items/685c0a1bb9b0e8ec68d2)
 - [【Spring Data Jpa のやり方】](https://qiita.com/GodMountain/items/638724382b34c52b5ce1)

Entityを定義して、

```java
package sample.model;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name="worker")
public class Worker {

    @Id
    @Column(name = "id")
	private String id;
    
    @Column(name = "name")
	private String name;
	
    @Column(name = "age")
    private int age;
    
    @Column(name = "department")
	private String department;

	public Worker () {

	}

	public Worker(String id, String name, int age, String department) {

		this.id = id;
		this.name = name;
		this.age = age;
		this.department = department;
	}

	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public String getDepartment() {
		return department;
	}

	public void setDepartment(String department) {
		this.department = department;
	}
}

```

Repositoryを定義する。

```java
package sample.repository;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import sample.model.Worker;

@Repository
public interface SampleJpa extends JpaRepository<Worker, String> {

}
```

呼び出すServiceを用意、

```java
package sample.service;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.EnableTransactionManagement;

import sample.model.Worker;
import sample.repository.SampleJpa;

@Service
@EnableTransactionManagement
public class SampleService {

	@Autowired
	SampleJpa sampleJpa;
	
	public void Execute() {
		
		//初期登録
		sampleJpa.saveAndFlush(new Worker("0001", "k.jarrett", 73, "music"));
		
		//検索
		List<Worker> workerList = sampleJpa.findAll();
		
		//更新
		for (Worker worker : workerList){

			System.out.println(
            		String.format(
            				"id:%s name:%s age:%d department:%s",
            				worker.getId(), worker.getName(), worker.getAge(), worker.getDepartment()
            				)
            		);
			
			worker.setAge(worker.getAge() + 1);
			sampleJpa.save(worker);
		}
		sampleJpa.flush();
		
		//検索
		workerList = sampleJpa.findAll();
		
		//削除
		for (Worker worker : workerList){

			System.out.println(
            		String.format(
            				"id:%s name:%s age:%d department:%s",
            				worker.getId(), worker.getName(), worker.getAge(), worker.getDepartment()
            				)
            		);
			sampleJpa.delete(worker);
		}
		sampleJpa.flush();
		
		//検索
		workerList = sampleJpa.findAll();
		
		if(workerList.size() == 0) {
			System.out.println("count = 0");
		}
		
		
	}
}

```

起動時のRunnerは、こんな感じです。

```java
package sample;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

import sample.service.SampleService;

@SpringBootApplication
@EnableJpaRepositories("sample.repository")
@EntityScan("sample.model")
@ComponentScan(basePackages = {"sample.service"})
public class JpaSampleApplication {

	public static void main(String[] args) {
		SpringApplication.run(JpaSampleApplication.class, args);
	}
	
	@Bean
	public CommandLineRunner demo(SampleService service) {
		return (args) -> {
			service.Execute();
		};
	}
}

```

サンプルプロジェクトごとGitHubにプッシュしています。
https://github.com/TsJazz27Sumin/jpaSample/tree/master/src/main/java/sample

## サンプルで実装してみて感想。

主にDI周りで関係ある起動時のComponentScanやEntityScanのことをさっぱり忘れていて、[Can't Autowire @Repository annotated interface in Spring Boot](https://stackoverflow.com/questions/29221645/cant-autowire-repository-annotated-interface-in-spring-boot)に助けられました。

あとは、Mavenの設定とか初期設定も「そういえば必要だった！」という感じで、設定周りで１－２時間ぐらいかかりました。でも、設定終わるとアノテーションでサクサク設定して、インターフェース用意するだけでSQLも書いてないし、シンプルな処理だとあっと言う間ですね。

経験上、実際のPJだと、ネイティブクエリ書く実装クラスを必要に応じて用意すると思いますが、それも検索条件が多かったり、JOINが多くてチューニングが必要な検索処理ぐらいです。

検索クエリもシンプルなものなら[メソッド名に応じて用意され](https://qiita.com/sndr/items/af7d12be264c2cc4b252)るし、ここらへんSpring Data JPAの使いこなし方次第で、かなり生産性高くシステム開発できそうです。

あとは、親子関係のEntityがあるとついて回る[fetch問題](https://qiita.com/sis-yoshiday/items/c29cc8eb3d529f7044ff#join-fetch%E5%9C%B0%E7%8D%84)は、業務システム作る上では避けて通れない課題かなと思っています。ここらへんは、個々のプロジェクトでどの時点でどのエンティティが必要なのかによって、fetch typeを変えたり、ネイティブクエリで実装したり、整理が必要だなと思っています。