JPAによるリレーション: @OneToManyと@ManyToOne

ユーザ認証ができたので、これまでに作った掲示板を改良してみます。名前とコメントが入力できるようになっていますが、名前をCommentのフィールドにするのではなく、CommentとUserを関連付けます。

ユーザはコメントを複数書くことができるので、UserとCommentは1対多の関係となります。ユーザごとにコメント表示できるようにし、またコメントがどのユーザのものかを表示できるようにするため、双方向の関係を持つようにします。

このような関係（リレーション）を定義するにはEntityにアノテーションをつけます。

Entity

まず、UserにCommentを格納するフィールドを追加します。Userが1でCommentが多と定義するには@OneToManyをつけます。

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import java.util.List;

@Entity
@Table(name = "USERS")
public class User {
    @Id
    @Setter
    @Getter
    private String username;

    @Setter
    @Getter
    private String password;

    @Getter
    @Setter
    private Boolean enabled;

    @Getter
    @Setter
    @OneToMany(mappedBy = "user")
    private List<Comment> commentList;
}

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;

import lombok.Setter;

import javax.persistence.Entity;

import javax.persistence.Id;

import javax.persistence.OneToMany;

import javax.persistence.Table;

import java.util.List;

@Entity

@Table(name = "USERS")

public class User {

@Id

@Setter

@Getter

private String username;

@Setter

@Getter

private String password;

@Getter

@Setter

private Boolean enabled;

@Getter

@Setter

@OneToMany(mappedBy = "user")

private List<Comment> commentList;

}

30行目: @OneToManyアノテーションで「1対多」であることを表す。アノテーションの引数であるmappedByについては後述。
31行目: 「多」となるEntityをListで格納できるようにする。

Commentは「多」なので@ManyToOneアノテーションをつけます。

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.ManyToOne;

@Entity
public class Comment {
    @Id
    @GeneratedValue
    @Getter
    @Setter
    private Long id;

    @Getter
    @Setter
    @ManyToOne
    private User user;

    @Getter
    @Setter
    private String text;
}

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;

import lombok.Setter;

import javax.persistence.Entity;

import javax.persistence.GeneratedValue;

import javax.persistence.Id;

import javax.persistence.ManyToOne;

@Entity

public class Comment {

@Id

@GeneratedValue

@Getter

@Setter

private Long id;

@Getter

@Setter

@ManyToOne

private User user;

@Getter

@Setter

private String text;

}

21行目: @MaynToOneアノテーションで「多対1」であることを表す。
22行目: 「1」となるEntityを格納できるようにする。

それぞれのEntityにアノテーションを付けたので双方向の関係（UserからCommentを、CommentからUserを取得できる）になります。

これに合わせてControllerとViewも修正します。

Controller

Controllerでは、コメントのPOST時にUserを取得し、Commentにセットしてから保存します。

package net.teachingprogramming.mybootapp.controller;

import net.teachingprogramming.mybootapp.entity.Comment;
import net.teachingprogramming.mybootapp.entity.User;
import net.teachingprogramming.mybootapp.repository.CommentRepository;
import net.teachingprogramming.mybootapp.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;

import javax.servlet.http.HttpServletRequest;
import java.util.List;

@Controller
@RequestMapping("/bbs")
public class BbsController {
    @Autowired
    private UserRepository userRepository;
    @Autowired
    private CommentRepository commentRepository;

    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String indexGet(ModelMap modelMap) {
        List<Comment> commentList = commentRepository.findAll();
        modelMap.addAttribute("commentList", commentList);
        return "bbs/index";
    }

    @RequestMapping(value = "/", method = RequestMethod.POST)
    public String indexPost(ModelMap modelMap,  @RequestParam("text") String text, HttpServletRequest httpServletRequest) {
        String username = httpServletRequest.getRemoteUser();
        User user = userRepository.findOne(username);
        Comment comment = new Comment();
        comment.setUser(user);
        comment.setText(text);
        commentRepository.save(comment);
        return indexGet(modelMap);
    }
}

package net.teachingprogramming.mybootapp.controller;

import net.teachingprogramming.mybootapp.entity.Comment;

import net.teachingprogramming.mybootapp.entity.User;

import net.teachingprogramming.mybootapp.repository.CommentRepository;

import net.teachingprogramming.mybootapp.repository.UserRepository;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Controller;

import org.springframework.ui.ModelMap;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RequestParam;

import javax.servlet.http.HttpServletRequest;

import java.util.List;

@Controller

@RequestMapping("/bbs")

public class BbsController {

@Autowired

private UserRepository userRepository;

@Autowired

private CommentRepository commentRepository;

@RequestMapping(value = "/", method = RequestMethod.GET)

public String indexGet(ModelMap modelMap) {

List<Comment> commentList = commentRepository.findAll();

modelMap.addAttribute("commentList", commentList);

return "bbs/index";

}

@RequestMapping(value = "/", method = RequestMethod.POST)

public String indexPost(ModelMap modelMap, @RequestParam("text") String text, HttpServletRequest httpServletRequest) {

String username = httpServletRequest.getRemoteUser();

User user = userRepository.findOne(username);

Comment comment = new Comment();

comment.setUser(user);

comment.setText(text);

commentRepository.save(comment);

return indexGet(modelMap);

}

33,34行目: ユーザ名はHttpServletRequestのオブジェクトから取得できる。
35行目: JpaRepositoryを継承したUserRepositoryはIDからデータを取得するfindOneメソッドが利用できる。
37行目: 取得したUserのオブジェクトをCommentにセットする。

View

Viewでは、名前の入力欄を削除し、表示される名前はUserのusernameに変更します。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>BBS</title>
</head>
<body>
<h1>BBS</h1>
<ol>
    <li th:each="comment:${commentList}"><span th:text="${comment.user.username}">名前</span>: <span th:text="${comment.text}">テキスト</span></li>
</ol>
<form th:action="@{/bbs/}" method="post">
    <input type="text" name="text" /><input type="submit" />
</form>
</body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<ol>

</ol>

</form>

</body>

</html>

10行目: commentからuserを取得しそのフィールドであるusernameを表示する。
13行目: 名前の入力欄は削除し、textの入力欄だけにする。

これで、UserとCommentを関連付けられました。

データベースにはどのように保存されているのか

@OneToManyと@ManyToOneをつかって双方向の1対多のリレーションを設定した場合、RDMSではどのように保存されているのでしょうか。　H2コンソールを使って中身を覗いてみましょう。

Userが保存されるUSERSテーブルは次のようになります。

Dbuser

UserにcommentListは見当たりません。

Commentが保存されるCOMMENTテーブルは次のようになります。

Dbcomment

UserのIDが格納されるカラムができています。

このようなテーブルになっているのは@OneToManyにmappedByがついているためです。

通常、@OneToManyをつけた場合は、Listを格納するために専用のテーブル（この場合、UserのIDとCommentのIDの対応が保存されるテーブル）が作成されます。@ManyToOneの場合は上記のようにテーブルにカラムが追加されます。これだと情報を二重にもってしまうことになります。また、UserにCommentのListを保存してsaveする必要があります。これでは、コードも煩雑になり、コードにミスがあればデータベースに不整合がおこりかねません。

これを防ぐために、@OneToManyと@ManyToOneの双方向のリレーションを設定する場合は、@OneToManyがつけられたEntityにアノテーションの引数でmappedByを指定し、参照するデータをもう一方の@ManyToOneがつけられたEntityのものにします。

今回の場合は、UserのcommentListは（UserのIDとCommentのIDの対応が保存されるテーブルからデータを取得するのではなく）CommentのUserフィールドの情報から取得していることになります。