Java ORマッパー選定のポイント #jsug

210.2K Views

May 26, 22

java spring

スライド概要

2019/01 JSUG勉強会の資料です。
この資料でDisっているのはJPAではなく、
・何も考えずに「標準だから」というだけでJPAを選ぶ人
・OSSに全くコントリビュートせずにフリーライドする人
です。

tada

@MasatoshiTada

スライド一覧

Java、Spring、IntelliJ IDEA

またはPlayer版

埋め込む »CMSなどでJSが使えない場合

ダウンロード

ダウンロード(pdf - 1.1MB)

各ページのテキスト

#jsug ⾃⼰紹介仕事柄、「ORマッパーは何がいいですか」と聞かれることは多いです ▸ 多⽥真敏（@suke_masa） ▸ 研修トレーナー@カサレアル ▸ Spring / Java EE / Microservices / Cloud Foundry ▸ Pivotal認定講師 ▸ ⽇本Springユーザ会スタッフ ▸ ⽇本GlassFishユーザー会運営メンバー 3 (C) CASAREAL, Inc. All rights reserved.

[beta]

#jsug

JavaでDBアクセスと⾔えばJDBC
public class JdbcEmployeeRepository {
private final DataSource dataSource;
// 検索するSELECT⽂
private static final String SQL_SELECT_ALL =
"SELECT e.id, e.name, e.salary, e.joined_date,"
+ " e.department_id, d.name AS department_name"
+ " FROM employee e JOIN department d"
+ " ON e.department_id = d.id"
+ " ORDER BY e.id";
// 検索メソッド
public List<Employee> findAll() {
try (Connection con = dataSource.getConnection();
PreparedStatement ps = con.prepareStatement(SQL_SELECT_ALL);
ResultSet rs = ps.executeQuery()) {
// 次ページへ

6
(C) CASAREAL, Inc. All rights reserved.

[beta]

#jsug

JavaでDBアクセスと⾔えばJDBC

}

}

List<Employee> employeeList = new ArrayList<>();
while (rs.next()) {
// ResultSetからEmployeeクラスに詰め替え
int id = rs.getInt("id");
String name = rs.getString("name");
BigDecimal salary = rs.getBigDecimal("salary");
LocalDate joinedDate = rs.getDate("joined_date").toLocalDate();
int departmentId = rs.getInt("department_id");
String departmentName = rs.getString("department_name");
Employee employee = new Employee(id, name, salary, joinedDate,
departmentId, departmentName);
// Listに追加する
employeeList.add(employee);
}
return employeeList;
} catch (SQLException e) {
throw new RuntimeException(e);
}

7
(C) CASAREAL, Inc. All rights reserved.

#jsug JDBCの問題点 ① SQLを⽂字列でプログラム内にベタ書きする ▸ 後から修正するのは⼤変、"+"で連結するのも⾯倒、実⾏しないとスペルミスに気づけないことも… 😩 ② 毎回ほぼ同じことを書かなければならない※ ▸ Connectionを取得して、PreparedStatementを作って、 rs.next()で繰り返して… ③ ResultSetをエンティティに詰め替えるのが⾯倒 ▸ (rs.getXxx()で列の値を取得→setterで代⼊) × 列数 ※「ボイラープレートコード」と呼ばれる (C) CASAREAL, Inc. All rights reserved. 8

10.

11.

12.

13.

14.

#jsug Spring JDBC ▸ Spring Framework内で開発されている JDBCラッパー ▸ Connection・PreparedStatementは開発者に触らせない ▸ ResultSetからの詰め替えのみ開発者が記述する ▸ SpringのDIコンテナが無くても動く ▸ Java EEなど他の環境でも使える → 例 14 (C) CASAREAL, Inc. All rights reserved.

https://github.com/MasatoshiTada/javaee-spring-jdbc

15.

[beta]

#jsug

サンプルコード

SQL

RowMapper

List<Employee> employeeList = jdbcTemplate.query(
"SELECT ... FROM ...",
(rs, rowNum) -> {
int id = rs.getInt("id");
String name = rs.getString("name");
BigDecimal salary = rs.getBigDecimal("salary");
LocalDate joinedDate =
rs.getDate("joined_date").toLocalDate();
int departmentId = rs.getInt("department_id");
String departmentName =
rs.getString("department_name");
return new Employee(id, name, salary, joinedDate,
departmentId, departmentName);
}
);
15
(C) CASAREAL, Inc. All rights reserved.

16.

#jsug NamedParameterJdbcTemplateクラスの主なメソッド ▸ List<T> query(String, RowMapper<T>) ▸ 複数件検索 ▸ List<T> query(String, Map<String,?>, RowMapper<T>) ▸ 複数件検索（パラメーター指定付き） ▸ T queryForObject(String, Map<String,?>, RowMapper<T>) ▸ 単一検索 ▸ int update(String, Map<String,?>) ▸ INSERT・UPDATE・DELETEの実行 16 (C) CASAREAL, Inc. All rights reserved.

17.

[beta]

#jsug

RowMapper<T>インタフェース
▸ T mapRow(ResultSet rs, int rowNum)のみを持つ
関数型インタフェース
▸ ResultSetからエンティティに変換する処理を記述する
List<Employee> employeeList = jdbcTemplate.query(
"SELECT ... FROM ...",
(rs, rowNum) -> {
int id = rs.getInt("id");
String name = rs.getString("name");
...
return new Employee(...);
}
);
(C) CASAREAL, Inc. All rights reserved.

17

18.

#jsug query()におけるRowMapperのイメージ ▸ 各⾏ごとにmapRow()が実⾏される id 101 102 103 name Alice Bob Chris salary $3000 $3500 $2500 mapRow() mapRow() mapRow() Employee Employee Employee 18 (C) CASAREAL, Inc. All rights reserved.

19.

#jsug BeanPropertyRowMapperクラス ▸ 列名とプロパティ名が同じものは⾃動詰め替えしてくれる ▸ スネークケース(department_id) ↔ キャメルケース(departmentId) の変換対応 ▸ Date and Time APIも対応 List<Employee> employeeList = jdbcTemplate.query(SQL_SELECT_ALL, BeanPropertyRowMapper.newInstance(Employee.class)); 19 (C) CASAREAL, Inc. All rights reserved.

20.

#jsug JDBCができることは何でもできる ▸ 集計 ▸ long count = getForObject( "SELECT COUNT(*) ...", Long.class) ▸ バッチ更新 ▸ batchUpdate() ▸ 1:Nリレーションを持つクラスへの変換 ▸ ResultSetExtractor 20 (C) CASAREAL, Inc. All rights reserved.

21.

https://github.com/cero-t/sqltemplate

22.

23.

24.

25.

26.

[beta]

#jsug

SQLを書くMapper XML
<mapper namespace="com.example.mapper.EmployeeMapper">
<select id="findById" resultType="Employee">
SELECT e.id AS id,
e.name AS name,
e.salary AS salary,
e.joined_date AS joined_date,
d.id AS department_id,
d.name AS department_name
FROM employee e
JOIN department d ON e.department_id = d.id
WHERE e.id = #{id}
</select>
</mapper>
26
(C) CASAREAL, Inc. All rights reserved.

27.

#jsug 検索の実⾏ Mapper XMLと1対1のインタフェース public interface EmployeeMapper { public Employee findById(Integer id); } EmployeeMapper employeeMapper = ...; Employee employee = employeeMapper.findById(1); 27 (C) CASAREAL, Inc. All rights reserved.

28.

[beta]

#jsug

条件分岐
<update id="update">
UPDATE employee e
SET e.name = #{name}
<if test="salary != null">
, e.salary = #{salary}
</if>
WHERE e.id = #{id}
</update>
public interface EmployeeMapper {
public void update(String name, BigDecimal salary,
Integer id);
}
28
(C) CASAREAL, Inc. All rights reserved.

29.

[beta]

#jsug

不等号対策①

CDATAセクションにする

<select id="findBySalaryUnder" resultType="Employee">

▸ CDATAセクションにする
<![CDATA[

SELECT e.id AS id,
e.name AS name,
e.joined_date AS joined_date,
e.salary AS salary,
d.id AS department_id,
d.name AS department_name
FROM employee e
JOIN department d ON e.department_id = d.id
WHERE e.salary < #{salary}
ORDER BY e.id

]]>
</select>
29
(C) CASAREAL, Inc. All rights reserved.

30.

[beta]

#jsug

不等号対策②
<select id="findBySalaryUnder" resultType="Employee">
SELECT e.id AS id,
▸ CDATAセクションにする
e.name AS name,
e.joined_date AS joined_date,
e.salary AS salary,
d.id AS department_id,
エスケープする
d.name AS department_name
FROM employee e
JOIN department d ON e.department_id = d.id
WHERE e.salary
ORDER BY e.id
</select>

&lt;

#{salary}

30
(C) CASAREAL, Inc. All rights reserved.

31.

32.

33.

https://doma.readthedocs.io/en/2.20.0/

34.

#jsug 2-way SQL ▸ SQL単体でも、プログラムからでも実⾏可能 SELECT e.id AS id, e.name AS name, e.salary AS salary, e.joined_date AS joined_date, e.department_id AS department_id, パラメーターや条件分岐は d.name AS department_name コメントで書く FROM employee e JOIN department d コメント直後の値は ON e.department_id = d.id Domaに無視される WHERE e.id = /*id*/101 34 (C) CASAREAL, Inc. All rights reserved.

35.

36.

37.

#jsug Type 3. クエリビルダー型 ▸ SQLをクラスやメソッドで記述する ▸ 記述を間違えるとコンパイルエラーになる ▸ これらのクラスは⾃動⽣成することが多い ▸例 ▸ jOOQ ← 今回はコレを主に紹介 ▸ DBFlute ←コレも少し紹介 ▸ その他にもいろいろ（Reladomo、Querydsl、Ebean、Speedment、 Jinq、requery、Cayenne、Torque） 37 (C) CASAREAL, Inc. All rights reserved.

38.

39.

http://www.jooq.org/download/

40.

41.

42.

http://dbflute.seasar.org

43.

44.

45.

#jsug 基本的なCRUD処理 // 主キー検索。SELECT⽂は⾃動発⾏される Employee employee = entityManager.find(Employee.class, 1); // 追加。INSERT⽂は⾃動発⾏される entityManager.persist(new Employee(...)); // 更新。コミット時にUPDATE⽂が⾃動発⾏される Employee employee = entityManager.find(Employee.class, 1); employee.setName("Other Name"); // 削除。DELETE⽂が⾃動発⾏される Employee employee = entityManager.find(Employee.class, 1); entityManager.remove(employee); 45 (C) CASAREAL, Inc. All rights reserved.

46.

[beta]

#jsug

JPQLによる検索
▸ SQLに似ているが微妙に⽂法は違う
▸ 集合演算が出来ない、副問合せに制限あり、
3つ以上のテーブルの結合に難あり、…
// 主キー検索
String jpql = "SELECT e FROM Employee e"
+ " WHERE e.name LIKE :name";
List<Employee> employeeList =
entityManager.createQuery(jpql, Employee.class)
.setParameter("name", "%a%")
.getResultList();
46
(C) CASAREAL, Inc. All rights reserved.

47.

#jsug [超重要] エンティティの状態永続化コンテキスト persist() NEW 状態 detach() clear() DETACHED 状態 MANAGED 状態 remove() merge() detach() clear() REMOVED 状態 find() JPQL flush() refresh() flush() 47 (C) CASAREAL, Inc. All rights reserved.

48.

49.

50.

#jsug ネイティブSQLの扱いにも難あり ▸ 複数の⽅法があるが、制限がある or 記述が⾯倒 @Entity @SqlResultSetMapping( name = "product_id_name", classes = { @ConstructorResult(targetClass = ProductDto.class, columns = { @ColumnResult(name = "id"), @ColumnResult(name = "name") } アノテーションの中に ) } アノテーションの中に ) アノテーション public class Product { … } 50 (C) CASAREAL, Inc. All rights reserved.

51.

https://www.slideshare.net/masatoshitada7/spring-data-jpa-jsug

52.

53.

#jsug JPAを使ってもいい条件 ※「向いている」とは⾔ってない ① DBを新規に設計できる ② 集合演算やFROM句での副問合せなど、複雑なSQLは要件的に少ない ③ 「パーフェクトJava EE」を読破した⼈がプロジェクトに1⼈以上いる 1つでも当てはまらない項⽬があれば、他のORマッパーを使った⽅がいいかも😅 (C) CASAREAL, Inc. All rights reserved. 53

54.

55.

56.

57.

#jsug CrudRepositoryインタフェース ▸ 基本的なCRUDメソッドを持つ ▸ これを継承したインタフェースを作成するだけ ▸ 実装クラスやそのインスタンスはSpringが実⾏時に作成 public interface EmployeeRepository extends CrudRepository<Employee, Integer> { // 空でOK。メソッドの追加も可能 } 57 (C) CASAREAL, Inc. All rights reserved.

58.

#jsug エンティティクラス ▸ それぞれ付加するアノテーションが異なるが、それ以外はほぼ同じ // JPA @Entity public class Employee { ... } // Spring Data Redis @RedisHash("employee") public class Employee { ... } データストアが違っても同じようにアクセスできるのは本当にありがたい！ 58 (C) CASAREAL, Inc. All rights reserved.

59.

60.

61.

62.

#jsug 正直、どれも⼀⻑⼀短あり。 ⭕ 簡単 ⭕ タイプセーフ ❌ やや冗⻑、SQLベタ書き ❌ やや冗⻑ ⭕ SQLが書ける ⭕ ⾼機能 ❌ XMLにSQLを書く ❌ 複雑、SQLの扱いに難 ⭕ 2-way SQLが書ける ❌ アノテーションプロセッサー享受するメリット・許容できるデメリットと、プロジェクトの状況を鑑みて選定するしかない 62 (C) CASAREAL, Inc. All rights reserved.

63.

64.

65.

#jsug 最後に伝えたいこと（※個⼈の(ry） ▸ とにかく安牌ならSpring JDBC or MyBatis ▸ Doma、DBFlute、クエリビルダー型は、それらの知識がある⼈がいれば、良い選択と思います ▸ JPAを「積極的に採⽤したい」シチュエーションは、特に思い浮かびません ▸ 個⼈プロジェクトが⼼配なら、⾃社からコミッターを出しましょう 65 (C) CASAREAL, Inc. All rights reserved.

66.

Java ORマッパー選定のポイント #jsug

tada

関連スライド

最新の6.0で学ぶ！初めてのひとのためのSpring Security

詳解Springトランザクション -初級から上級まで- #jsug

プロになるためのSpring上級知識 #jsug

今こそ知りたいSpring DI x AOP #jsug

基礎からのOAuth 2.0とSpring Security 5.1による実装 #jsug

初めてのひとのためのSpring/Spring Boot #jjug

各ページのテキスト