Java

【JdbcTemplate】Queryの書き方（SELECT文）

投稿日：2020年1月12日 更新日：

JdbcTemplateでQueryを書く方法です！
（SELECT文で、1件・複数件を取得するケース）
 

前提

以下のテーブル（users）を持ち、格納するのはUserクラスという想定で説明していきます。

usersテーブル

PgSQL
1
2
3
4
5
6
7
8
9
10
11
 
CREATE TABLE IF NOT EXISTS users (
id VARCHAR(50) PRIMARY KEY
,password VARCHAR(100)
,name VARCHAR(50)
,birthday DATE
,age INT
,marrige BOOLEAN
,role VARCHAR(50)
);
 

Userクラス

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
import java.util.Date;
 
import lombok.Data;
 
// setter/getterを付けるアノテーション
@Data
public class User {
private String id;
private String password;
private String name;
private Date birthday;
private int age;
private boolean marrige;
private String role;
 
        // Default Constructor
public User() {
}
 
public User(String id, String password, String name, Date birthday, int age, boolean marrige, String role){
this.id = id;
this.password = password;
this.name = name;
this.birthday = birthday;
this.age = age;
this.marrige = marrige;
this.role = role;
}
}
 

 

データの取得

1件のみと複数件を取得するケースで説明します。
 

Mapで取得する方法

1件のみ取得

Map<String, Object>の形でQuery結果を取得する。

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;
 
public class UserDao {
 
    @Autowired
    JdbcTemplate jdbcTemplate;
    
    public User selectOne(String id) throws DataAccessException {
        // SQL文を作成
        String sql = ""
            + "SELECT"
                + " *"
            + " FROM"
                + " users"
            + " WHERE"
                + " id = ?";
 
        // queryForMapメソッドでSQLを実行し、結果MapのListで受け取る。
        // SQL文の ? の部分に当てはめる値を一緒に与える。
        Map<String, Object> oneUser = jdbcTemplate.queryForMap(sql, id);
 
        // Userオブジェクトに格納する。
        User user = new User(
                (String) oneUser.get("id")
                ,(String) oneUser.get("password")
                ,(String) oneUser.get("name")
                ,(Date) oneUser.get("birthday")
                ,((Integer) oneUser.get("age")).intValue()
                ,(Boolean) oneUser.get("marrige")
                ,(String) oneUser.get("role")
         );
 
        return user;
    }
}
 

複数件を取得

List<Map<String,Object>>でQuery結果を取得する。

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;
 
public class UserDao {
 
    @Autowired
    JdbcTemplate jdbcTemplate;
    
    public List<User> selectMany() throws DataAccessException {
     // SQL文を作成
        String sql = ""
        String sql = ""
            + "SELECT"
                + " *"
            + " FROM"
                + " users";
 
// queryForListメソッドでSQLを実行し、結果MapのListで受け取る。
        List<Map<String, Object>> users = jdbcTemplate.queryForList(sql);
        
        // Userオブジェクト格納用のListを作成する。
        List<User> userList = new ArrayList<User>();
        
        // 受け取ったMapのListをfor文で回し、各ユーザの値をUserオブジェクトに格納する。
        for(Map<String, Object> eachUser: users) {
            User user = new User(
                    (String) eachUser.get("id")
                    ,(String) eachUser.get("password")
                    ,(String) eachUser.get("name")
                    ,(Date) eachUser.get("birthday")
                    ,((Integer) eachUser.get("age")).intValue()
                    ,(Boolean) eachUser.get("marrige")
                    ,(String) eachUser.get("role")
             );
            // UserオブジェクトをListに追加する。
userList.add(user);
        }
 
        return userList;
    }
}
 

 

RowMapperで取得する方法（準備が必要）

RowMapperインターフェースを実装した、独自マッパーの準備が必要です。
 

準備

RowMapperインターフェースを実装したクラスを作成する。
（1件のみ、複数件の取得に共通）

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
import java.sql.ResultSet;
import java.sql.SQLException;
 
import org.springframework.jdbc.core.RowMapper;
 
import com.example.demo.login.domain.model.User;
 
// RowMapperインターフェースを実装したクラスを準備する。
public class UserRowMapper implements RowMapper<User> {
 
    @Override
    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
        // Query結果（ResultSet rs）を、Userオブジェクトに格納する実装
        User user = new User(
                rs.getString("id")
                ,rs.getString("password")
                ,rs.getString("name")
                ,rs.getDate("birthday")
                ,rs.getInt("age")
                ,rs.getBoolean("marrige")
                ,rs.getString("role")
        );
 
        return user;
    }
 
}
 

 

1件のみ取得

RowMapperインターフェースを実装したマッピング結果を受け取る。

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;
 
public class UserDaoRowMapper {
 
    @Autowired
    JdbcTemplate jdbcTemplate;
 
    public User selectOne(String id) throws DataAccessException {
        // SQL文を作成
        String sql = ""
            + "SELECT"
                + " *"
            + " FROM"
               + " users"
            + " WHERE"
                + " id = ?";
 
        // queryForObjectメソッドを実行
        // SQLの結果をUserRowMapperでマッピングして結果を受け取る。
        UserRowMapper rowMapper = new UserRowMapper();
        User user = jdbcTemplate.queryForObject(sql, rowMapper, id);
 
        return user;
    }
}
 

 

複数件を取得

RowMapperインターフェースを実装した結果をListで受け取る。

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;
 
public class UserDaoRowMapper {
 
    @Autowired
    JdbcTemplate jdbcTemplate;
 
    public List<User> selectMany() throws DataAccessException {
        // SQL文を作成
        String sql = ""
            + "SELECT"
                + " *"
            + " FROM"
                + " users";
 
        // queryメソッドでSQLを実行
        // UserRowMapperのマッピング結果である、UserオブジェクトのListを受け取る。
        UserRowMapper rowMapper = new UserRowMapper();
        List<User> userList = jdbcTemplate.query(sql, rowMapper);
 
        return userList;
    }
 
}
 

 

BeanPropertyRowMapperで取得する方法（準備不要！）

RowMapperインターフェースを実装したクラスの作成が不要！
テーブルのカラム名と、マッピングするクラスのフィールド名が同じであれば、
自動で値をセットしてくれる。

適用可能な例

・スネークケース
テーブルのカラム名：user_id
クラスのフィールド名：userId

・同じ
テーブルのカラム名：id
クラスのフィールド名：id

※格納するクラス（今回の場合で言うと、Userクラス）に、
　Default Constructor と setterがあることが前提です。
Lombokを使用しているのであれば、@Setterアノテーションか、
@Dataアノテーションがあればいいです。

 

1件のみ取得

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
import java.util.List;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.stereotype.Repository;
 
public class UserDaoBeanPropertyRowMapper {
 
    @Autowired
    JdbcTemplate jdbcTemplate;
 
    public User selectOne(String id) throws DataAccessException {
        // SQL文を作成
        String sql = ""
            + "SELECT"
                + " *"
            + " FROM"
                + " users"
            + " WHERE"
                + " id = ?";
 
        // queryForObjectメソッドを実行
        // SQLの実行結果は、自動的にUserクラスにマッピングされて取得できる。
        RowMapper<User> rowMapper = new BeanPropertyRowMapper<User>(User.class);
        User user = jdbcTemplate.queryForObject(sql, rowMapper, id);
 
        return user;
    }
}
 

 

複数件を取得

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
import java.util.List;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.stereotype.Repository;
 
 
public class UserDaoBeanPropertyRowMapper {
 
    @Autowired
    JdbcTemplate jdbcTemplate;
 
    public List<User> selectMany() throws DataAccessException {
        // SQL文を作成
        String sql = ""
            + "SELECT"
                + " *"
            + " FROM"
                + " users";
 
        // queryメソッドを実行
        // SQLの実行結果は、自動的にUserクラスにマッピングされて、Listで取得できる。
        RowMapper<User> rowMapper = new BeanPropertyRowMapper<User>(User.class);
        List<User> userList = jdbcTemplate.query(sql, rowMapper);
 
        return userList;
    }
}
 

どれがいいのか？

1位：BeanPropertyRowMapper

最もマッピングが楽な方法。
setterが許されている開発現場であれば、これを使えばいい。

もし、setterを使えない（ValueObject化する必要がある）場合、
RowMapperで実装すればよい。

2位：RowMapper

マッピングするクラスの作成が少し手間である。
ただし作っておけば、Mapのように1件取得と複数件取得で2か所に
Userクラスへの格納処理を書くということは無い。

マッピングするクラスを独自に定義したいときには使えばよい。

3位：Map

Queryの取得結果をUserクラスに格納するのをわざわざ書かなければならないため、
手間とメンテナンスの面でお勧めできない。

最後に

独学が難しい、エラーの解消に時間がかかる、今学ぶべき技術は何だろうといった悩みがあるようだったら現役エンジニアによるオンラインのサポートサービスを検討してみて下さい。
回答率100％の掲示板に質問し放題のオンラインサービス

　
最後までお読み頂き、ありがとうございました！
ご意見・ご要望がありましたら、遠慮なくコメント下さい！
もし内容が良かったらランキング評価を頂けると励みになります（＾＾）
⇒ランキング評価する

-Java
-, ,

執筆者：

comment

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

CAPTCHA


関連記事

【SpringBoot入門】#11~ 削除ダイアログの作成

概要 検索結果から削除機能を呼び出した際に、削除を確認するためのダイアログです。 実装はjQueryで行いますので、mavenへの追加作業等の準備を別途行います。 イメージ jQueryの準備 jQu …

【Javaサンプル】自動販売機を作成(Level1)

Javaの勉強用サンプルです。 テーマは自動販売機。 プログラミング初心者向けに書いています。   自動販売機を題材として選んだ理由 自社研修で行っている 自社研修で自動販売機を作成したので …

【Java入門】インターフェースの使い方まとめ

概要 インターフェースとは、内部実装を知る必要なく、利用する機能の接点のみを提供する仕組みです。 接点をソフトウェア的にいうと、メソッドのシグネチャと戻り値の型に当たります。 つまり、どんなメソッドに …

【Java】HashSetの使い方（順序なしSet）

HashSetの使い方をまとめました。 HashSetに関する使い方のサイトは他にもありますが、 それらのサイトには書かれていないメソッドについても書いてあります。 HashSetの基本情報 ・重複す …

【SpringBoot入門】#13~ 独自のエラー画面の作成

概要 何らかのエラーが発生した場合に、エラー画面を表示して対応したいことがあります。 デフォルトのwhite label Error pageのままというわけにはいかないので、 独自のエラー画面を作成 …

PREV
Eclipseでタブを半角スペースに変換する便利プラグイン！
NEXT
curlでRest通信するコマンド
■運営者プロフィール
IT業界10年のエンジニア。
PHP -> VBA -> Javaと渡り歩いてきて、今はJavaをメインにフリーランスエンジニアとして活躍中！

[保有資格]
・Java SE 11 Gold

一度はエンジニアを辞めざるを得なかった私が再びエンジニアとして復活した数奇な物語

SpringFramworkの良書

■おすすめ教材
Javaの基本を学んだ人が、次のステップとして読む本（中級者向け）

※SpringはJavaのFrameworkの1つです。
変更のしやすさ、保守性の高さが特徴です。

2023/06/01

【Java】正規表現の使い方（判定、抽出、置換）

2023/05/28

【Java】配列の扱い方（初期化、追加、ソート、List変換など）

junit, テスト, junit5

2023/05/25

【Junit5】@ParameterizedTestでnullを扱う方法

2023/05/24

【Javaの始め方】環境構築から最初のコード作成まで

ぴったり

2023/05/22

【Java初心者向け】自分のレベルに合った入門書の探し方