SpringBoot + JPA + Thymeleaf

Question

自習用で作っているものです。
リポジトリクラスで、結合したテーブルから取得した結果を最終的にTyhmeleafに渡して画面に表示したいです。

@Data 
@Entity
public class User {

	@Id
	@GeneratedValue 
	private Long id;
	
	private String userName;
	
	private String mailAddr;
	
	private Long groupId;
}

@Data
@Entity
public class UserGroup {

	@Id
	private Long groupId;

	private String groupName;
}

上記のテーブルをrepositoryで外部結合

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

	@Query(value = "SELECT d.id,d.user_name,_no,d.mail_addr,g.group_name,null AS group_id "
			+ "FROM  user u "
			+ "LEFT JOIN group g ON d.group_id = g.group_id",nativeQuery = true)
    public List<User> findUser();
}

public List<User> findUserGroup() {
		return  UserRepository.findUserGroup();
	}
	

@Controller
@RequestMapping("/") 
public class IndexController {
	@Autowired
	private IndexService service;
    @RequestMapping(method = RequestMethod.GET)
    public String index(Model model) {
    	model.addAttribute("UserGroup",service.findUserGroup());
        return "index";
    }

Comments

[退会済みユーザー]

ASP.NET MVC Framework にも .NET Framework にも関係ない Java の話のように思えますが、そうであれば付与したタグは不適切です。見直してください。

[icezoom]

申し訳ありません。修正します。

[q_sane_q]

Controllerにノイズが多いようですが……
**は太字にする予定だった？
service.findTelGroupList()は生きている処理ですか？

[icezoom]

**model.addAttribute("telDataList",service.findTelDataGroup());**
は太文字にして、処理が正しいかを強調するつもりだったのですが…
初心者でうまく質問ができていなくて申し訳ありません

[q_sane_q]

とりあえず、生きている（今回の問題に関係のある）処理だけにしていただけると嬉しいです。

[icezoom]

処理内容確認しました。
model.addAttribute("telDataGroupList",service.findTelDataGroupList());をデバッグで確認したところ、
「groupName」のデータ取得できていないと思われます。
結合の仕方が誤っているのでしょうか…

Answer 1

JPAではこのような場合、エンティティクラスに関連（リレーション）を持たせます。
以下にtel_groupテーブルが親、tel_dataテーブルが子という親子関係を持っているという前提で実装方法を説明いたします。

なお、エンティティクラスに関連（リレーション）を持たせたくないということであれば別の方法で解決する必要がありますのでこの回答はスルーしてください。

スキーマ

以下の内容のテーブルおよびテストデータで動作検証を行いました。以降の説明はこれらのスキーマを前提に行います。

CREATE TABLE tel_group (
  id           BIGINT AUTO_INCREMENT,
  group_name   VARCHAR(80) NOT NULL,
  PRIMARY KEY(id)
);

CREATE TABLE tel_data (
  id           BIGINT AUTO_INCREMENT,
  user_name    VARCHAR(80) NOT NULL,
  tel_no       VARCHAR(20) NOT NULL,
  mail_addr    VARCHAR(60) NOT NULL,
  group_id     BIGINT NOT NULL,
  PRIMARY KEY(id)
);

ALTER TABLE tel_data ADD CONSTRAINT FOREIGN KEY FKEY_tel_data_group_id_group_id (group_id) REFERENCES tel_group (id);

テストデータ

検証用データです。

insert into tel_group (id, group_name) values (1, 'GROUP A');
insert into tel_group (id, group_name) values (2, 'GROUP B');
insert into tel_group (id, group_name) values (3, 'GROUP C');
insert into tel_group (id, group_name) values (4, 'GROUP D');
insert into tel_group (id, group_name) values (5, 'GROUP E');

insert into tel_data (id, user_name, tel_no, mail_addr, group_id) values (1, 'USER 1', '999-999-999', '[e-mail]', 1);
insert into tel_data (id, user_name, tel_no, mail_addr, group_id) values (2, 'USER 2', '999-999-999', '[e-mail]', 1);
insert into tel_data (id, user_name, tel_no, mail_addr, group_id) values (3, 'USER 3', '999-999-999', '[e-mail]', 2);
insert into tel_data (id, user_name, tel_no, mail_addr, group_id) values (4, 'USER 4', '999-999-999', '[e-mail]', 4);
insert into tel_data (id, user_name, tel_no, mail_addr, group_id) values (5, 'USER 5', '999-999-999', '[e-mail]', 4);
insert into tel_data (id, user_name, tel_no, mail_addr, group_id) values (6, 'USER 6', '999-999-999', '[e-mail]', 5);

SELECT d.id, d.user_name, d.tel_no, d.mail_addr, d.group_id, g.group_name FROM tel_data d LEFT JOIN tel_group g ON d.group_id = g.id

+----+-----------+-------------+-----------------+----------+------------+
| id | user_name | tel_no      | mail_addr       | group_id | group_name |
+----+-----------+-------------+-----------------+----------+------------+
|  1 | USER 1    | 999-999-999 | [e-mail] |        1 | GROUP A    |
|  2 | USER 2    | 999-999-999 | [e-mail] |        1 | GROUP A    |
|  3 | USER 3    | 999-999-999 | [e-mail] |        2 | GROUP B    |
|  4 | USER 4    | 999-999-999 | [e-mail] |        4 | GROUP D    |
|  5 | USER 5    | 999-999-999 | [e-mail] |        4 | GROUP D    |
|  6 | USER 6    | 999-999-999 | [e-mail] |        5 | GROUP E    |
+----+-----------+-------------+-----------------+----------+------------+
6 rows in set (0.00 sec)

JPA

エンティティクラスの実装

TelGroupクラスとTelDataクラスに関連を持たせる場合、外部キー(group_id)を持つTelDataエンティティクラスにOneToOneアノテーションを付与して単方向のリレーションを宣言します。
また外部キーのgroup_idをそのままフィールドとして定義するのではなく、代わりにTelGroupエンティティをフィールドとして定義します。

ちなみに単方向のリレーションとは、TelDataクラス側からTelGroupクラスを参照できる（見つけることができる）が、TelGroupクラスからTelDataクラスは参照できない（見つけることができない）という意味です。

要件によっては双方向の関連を持たせたい場合もあると思いますが、その場合エンティティクラスの実装を変える必要が出てきます。

※以下のコードではColumnアノテーションを使っていますが必須ではありません。

import lombok.Data;

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

@Entity
@Table(name = "tel_group")
@Data
public class TelGroup {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;
  @Column(name = "group_name", length = 80, nullable = false)
  private String groupName;
}

import lombok.Data;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.OneToOne;
import javax.persistence.Table;

@Entity
@Table(name = "tel_data")
@Data
public class TelData {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;
  @Column(name = "user_name", length = 80, nullable = false)
  private String userName;
  @Column(name = "tel_no", length = 20, nullable = false)
  private String telNo;
  @Column(name = "mail_addr", length = 60, nullable = false)
  private String mailAddr;
  @OneToOne
  @JoinColumn(name = "group_id")
  private TelGroup telGroup;
}

リポジトリの実装

エンティティが関連を持っているのでデータを全件取得するだけであればJpaRepositoryに定義されているfindAllメソッドで済みます。なのでネイティブSQLを使った新しいメソッドの定義は不要です。

import com.example.demo.model.TelData;
import org.springframework.data.jpa.repository.JpaRepository;

public interface TelDataRepository extends JpaRepository<TelData, Long> {
}

テンプレート

コントローラで以下のように取得したデータをモデルにセットした場合

List<TelData> telDataList = telDataRepository.findAll();
model.addAttribute("telDataList", telDataList);

テンプレート内では以下のようにモデルにアクセスできます。
たとえば、TelGroupのgroupNameフィールドを取得したい場合
JavaコードではtelData.getTelGroup().getGroupName()のように記述できるので、テンプレートでも同じ要領で telData.telGroup.groupName と記述します。

<table>
    <thead>
    <tr>
        <th>ユーザID</th>
        <th>ユーザ名</th>
        <th>tel no</th>
        <th>mail address</th>
        <th>グループID</th>
        <th>グループ名</th>
　  </tr>
    </thead>
    <tbody>
    <tr th:each="telData : ${telDataList}" >
        <td th:text="${telData.id}"></td>
        <td th:text="${telData.userName}"></td>
        <td th:text="${telData.telNo}"></td>
        <td th:text="${telData.mailAddr}"></td>
        <td th:text="${telData.telGroup.id}"></td>
        <td th:text="${telData.telGroup.groupName}"></td>
    </tr>
    </tbody>
</table>

この方法の注意点

この実装では扱うデータ件数によっては、いわゆるN+1問題という性能に影響を与える問題が発生することがありますのでご注意ください。

この例のテストデータを使ってデータ全件を検索した場合、実行されるSQLは(1)が1回、(2)が4回の計5回になります。
これは最初にtel_dataテーブルから全件検索し、次にtel_data.group_idで別途tel_groupテーブルを検索するという動きになります。

(1)

 select
        teldata0_.id as id1_0_,
        teldata0_.mail_addr as mail_add2_0_,
        teldata0_.group_id as group_id5_0_,
        teldata0_.tel_no as tel_no3_0_,
        teldata0_.user_name as user_nam4_0_ 
    from
        tel_data teldata0_

(2)

 select
        telgroup0_.id as id1_1_0_,
        telgroup0_.group_name as group_na2_1_0_ 
    from
        tel_group telgroup0_ 
    where
        telgroup0_.id=?

この問題の対処方法

N+1問題を避けるにはTelDataRepositoryを以下のように改修します。
Queryアノテーションに記述している文字列はSQLのように見えますが正確にはJPQLといいます。
※findAllメソッドをオーバーライドしていますが、別の名前を付けたカスタムメソッドにしても構いません。

import com.example.demo.model.TelData;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;

import java.util.List;

public interface TelDataRepository extends JpaRepository<TelData, Long> {
  @Query("SELECT d FROM TelData d JOIN FETCH d.telGroup")
  @Override
  List<TelData> findAll();
}

このfindAllメソッドを実行すると、下記のSQLが1回だけ実行されます。

select
        teldata0_.id as id1_0_0_,
        telgroup1_.id as id1_1_1_,
        teldata0_.mail_addr as mail_add2_0_0_,
        teldata0_.group_id as group_id5_0_0_,
        teldata0_.tel_no as tel_no3_0_0_,
        teldata0_.user_name as user_nam4_0_0_,
        telgroup1_.group_name as group_na2_1_1_ 
    from
        tel_data teldata0_ 
    inner join
        tel_group telgroup1_ 
            on teldata0_.group_id=telgroup1_.id

SQLのログを出力する

JPAがどのようなSQLを組み立てて実行するかは、設定ファイルでSQLのログを出力するように設定すると分かります。
以下は必要な設定項目(yml形式)の抜粋です。設定をapplication.properteisファイルで管理している場合は適宜読み替えてください。

spring:
  jpa:
    show-sql: true
    properties:
      hibernate:
        format_sql: true

logging:
  level:
    org.hibernate.SQL: debug
    org.hibernate.type.descriptor.sql.BasicBinder: trace

Comments

[icezoom]

本当にわかりやすく説明して頂きありがとうございます！
リレーションの理解があまりできていませんでした。
ご指摘のように実装した結果うまくgroupNameを取得できました！

JPQLで結合した新しい結合データは、別のメソッドを用意して呼び出す必要があると思っていました。

Answer 2

これHTMLで使用しているのは
model.addAttribute("telDataGroupList",service.findTelDataGroup());
だけですよね？

そしたら検索で返ってきてるのはTelDataクラスで、そこにはgroupNameというフィールドは存在しないので受け取りできていないと思います
単純に取得するだけならTelDataクラスにgroupNameを作れば動くのではないでしょうか？

ただTelDataテーブルにはgroupNameという列はないので、それを示すアノテーション@Transientをつけないといけなかったと思います

クエリを柔軟にできるので自分がよくやるやり方（コメントの３）は↓の感じで（ddl-auto: create　はいつも付けてない）

// テーブルに対応したEntity
@Data
@Entity
public class TelData {

    @Id
    @GeneratedValue
    private Long id;
    private String userName;
    private String telNo;
    private String mailAddr;
    private Long groupId;
}

// JOINなどをした検索結果を受け付けるEntity（名前は何でも）
@Data
@Entity
public class TelData2 {

    @Id
    private Long id;
    private String userName;
    private String telNo;
    private String mailAddr;
    private Long groupId;
    private String groupName;
}

@Repository
public interface TelDataRepository extends JpaRepository<TelData, Long>, TelDataRepositoryCustom  {
}

// カスタムクエリ用Repositoryインタフェース　名前はリポジトリインタフェース名 + Custom
public interface TelDataRepositoryCustom{
    public List<TelData2> findTelDataGroup();
}

// カスタムクエリ用Repositoryクラス　名前はリポジトリインタフェース名 + Impl

import java.util.List;
import javax.persistence.EntityManager;
import javax.persistence.Query;
import org.springframework.beans.factory.annotation.Autowired;

public interface TelDataRepositoryImpl implements TelDataRepositoryCustom {

    @Autowired EntityManager entityManager;

    public List<TelData2> findTelDataGroup(){
        
        String sql = "SELECT d.id,d.user_name,d.tel_no,d.mail_addr,g.group_name,null AS group_id "
            + "FROM  tel_data d "
            + "LEFT JOIN tel_group g ON d.group_id = g.group_id";

        Query query = entityManager.createNativeQuery(sql, TelData2.class);
        List<TelData2> list = (List<TelData2>)query.getResultList();
        return list;
        // キャストの警告が出るので気になったら@SuppressWarningsアノテーションで消す
    }
}

で、

// telDataRepository　はTelDataRepository（TelDataRepositoryCustomやTelDataRepositoryImplではない）
telDataRepository.findTelDataGroup();

を使って呼び出した結果を画面に返して使用する。
インタフェースやクラスが増えることとやや複雑になるデメリットはありますが、
クエリ・結果を比較的自由に弄れるので個人的にはよくやっています。

Comments

[icezoom]

回答ありがとうございます。
結合データの取得でしようしているのは、
model.addAttribute("telDataGroupList",service.findTelDataGroup());　
だけです。

やはりTelDataクラスにgroupNameを作れば、動くということなんですね。
entityのTelDataクラスgroupNameを作成すれば、TelDataテーブルに列が追加されます。
その場合、@Transientは必要なのでしょうか。

[icezoom]

TelDataにgroupNameを作成し、実行しましたが、常にgroupNameがnullで取得されます。。。

[q_sane_q]

長くなるのでこっちに書くと読みにくいと思いましたが、一連の話なのでこっちに書いた方がよかったですね、以下に書き直します

すいませんちょっと言葉足らずでした。

TelDataテーブルに列が追加される、ということは設定ファイル（application.ymlかapplication.properties）でddl-auto: create　を設定している……ということでいいですよね？

@Transientをつけたフィールドは永続化で無視されるので、テーブルに列が作成されることはないと思います。
ただ検索結果の取得もできなくなるので、

１．
@TransientをつけてgroupNameフィールドを作成、TelDataを検索してListを取得した後でgroupNameを別検索して突っ込む

２．
@ManyToOne、@OneToManyでEntityに結合関係を示す

３．
テーブルに直接紐づかないEntityクラスを作り、カスタムクエリで取得する

あたりでしょうか……
私は３．の方法をよくやりますが、クラスやインタフェースが増えることになるので

[icezoom]

丁寧にありがとうございます。
やり方としては、上記の１～３のどれか１つを行うことで実装が可能ということですよね？
一度どの方法がよいのか試してみます！