양방향 매핑은 DB에서 JOIN 구문을 통해 양방향으로 필요한 값을 가져오는 것처럼 객체 또한 양방향으로 통신할 수 있는 구조를 만드는 것입니다.
DB의 테이블은 방향 이라는 개념이 없이 필요에 의해 JOIN 구문을 사용해서 원하는 값을 가져오면 됩니다. 하지만 문제는 객체를 다룰 때 발생합니다.
아래 이미지를 보면 단방향 구조에서 Member에서 Team을 참조할 수 있지만, Team에서 Member를 참조할 수 없습니다.
단방향
양방향
위 내용을 참고해서 엔티티 클래스를 작성합니다.
Team에서 Member는 1:N 관계이기 때문에 @OneToMany 입니다.
mappedBy 속성은 해당 필드가 어떤 필드와 연결되어 있는지 명시하는 속성입니다. 이 필드는 Member 객체의 team 필드와 매핑되어 있습니다.
@Entity
public class Team {
@Id @GeneratedValue
@Column(name = "TEAM_ID")
private Long id;
private String name;
@OneToMany(mappedBy = "team")
private List<Member> members = new ArrayList<>(); // ArrayList로 초기화 하면 add() 할 때 null관련 에러가 발생하지 않음.
}
@Entity
public class Member {
@Id @GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@ManyToOne
@JoinColumn(name = "TEAM_ID")
private Team team;
@Column(name = "USERNAME")
private String name;
}
이제 Team에서도 Member 객체를 호출할 수 있게 되었습니다.
아래 코드는 Member > Team > Member 양방향으로 자유롭게 객체 참조를 하는 모습입니다.
Member findMember = entityManager.find(Member.class, member.getId());
List<Member> members = findMember.getTeam().getMembers();
연관관계의 주인과 mappedBy
mappedBy를 이해하려면 객체와 테이블이 연관관계를 맺는 차이를 이해해야 합니다.
객체 연관관계 = 2개
객체는 단방향 연관관계 2개 있습니다.
- Member -> Team 연관관계 1개(단방향)
- Team -> Member 연관관계 1개(단방향)
객체의 양방향 관계는 양방향 관계가 아니라 서로 다른 단방향 관계 2개가 존재하는 것입니다.
객체를 양방향으로 참조하려면 단방향 연관관계 2개를 만들어야 하는 것입니다.
테이블 연관관계 = 1개
Member <-> Team 연관관계 1개(양방향)
테이블은 외래 키 하나로 두 테이블의 연관관계를 관리합니다. 외래 키 하나로 양쪽으로 JOIN 할 수 있습니다.
양방향 연관관계 매핑의 딜레마 - 둘 중 어느 것으로 테이블에 매핑해야 하나?
DB의 테이블의 외래키를 매핑할 때 Member, Team 둘 중 어느 것을 기준으로 매핑해야 하나 헷갈립니다.
정답은, 둘 중 하나로 외래 키를 관리해야 합니다. 이것을 연관관계의 주인(Owner) 이라고 합니다.
연관관계의 주인(Owner)
연관관계의 주인 개념은 양방향 매핑에서 등장하는 개념입니다.
다음은 양방향 매핑 규칙입니다.
- 객체의 두 관계중 하나를 연관관계의 주인으로 지정한다.
- 연관관계의 주인만이 외래 키를 관리한다.(등록, 수정)
- 주인이 아닌쪽은 읽기만 가능하다.
- 주인은 mappedBy 속성을 사용하지 않는다.
- 주인이 아니면 mappedBy 속성으로 주인을 지정한다.
누구를 주인으로 해야 하나? - 외래 키가 있는 곳을 주인으로!
- 외래 키가 있는 곳을 주인으로 지정한다.
지금까지 예제로 사용했던 Member, Team 객체 관계에서 연관관계의 주인은 외래키가 있는 Member 객체입니다.
연관관계의 주인만이 등록, 수정 등의 기능을 수행할 수 있고, 주인이 아닌 객체는 읽기만 가능합니다.
DB입장에서 관계를 정의할 때 외래키가 있는 곳이 N, 외래키가 없는 곳이 1 입니다. 이렇게 생각하고 연관관계의 주인을 지정해서 사용하면 간편합니다.
양방향 매핑 시 가장 많이 하는 실수
연관관계의 주인에 값을 입력하지 않음
연관관계의 주인은 Member 객체 입니다. 외래 키를 매핑하기 때문입니다. 그런데 아래 코드는 주인이 아닌 객체에 값을 넣었습니다. 그래서 Member 테이블의 TEAM_ID 값이 null인 것입니다. 게다가 기본적으로 주인이 아닌 객체는 읽기 전용이기 때문에 값을 넣어도 원하는 결과를 볼 수 없습니다.
// 회원 저장
Member member = new Member();
member.setName("Member1");
entityManager.persist(member);
// 팀 저장
Team team = new Team();
team.setName("TeamA");
// 역방향(주인이 아닌 방향)만 연관관계 설정
team.getMembers().add(member);
entityManager.persist(team);
연관관계의 주인에 값을 입력하면 정상적으로 값이 등록됩니다.
// 팀 저장
Team team = new Team();
team.setName("TeamA");
entityManager.persist(team);
// 회원 저장
Member member = new Member();
member.setName("Member1");
member.setTeam(team);
entityManager.persist(member);
양방향 매핑시 연관관계의 주인에 값을 입력해야 한다.
(순수한 객체 관계를 고려하면 항상 양쪽 다 값을 입력해야 한다)
순수 자바 코드로 테스트 하는 JUNIT 테스트 및 기타 구현 과정에서 오류가 없도록 하려면 연관관계의 주인과 주인이 아닌 곳 둘 다에 값을 입력해야 합니다.
// 팀 저장
Team team = new Team();
team.setName("TeamA");
entityManager.persist(team);
// 회원 저장
Member member = new Member();
member.setName("Member1");
// 연관관계 주인이 아닌 객체에도 값 설정
team.getMembers().add(member);
// 연관관계 주인에 값 설정
member.setTeam(team);
entityManager.persist(member);
그런데 주인과 주인이 아닌 것 둘 다 신경 쓰는 것이 객체가 많아질수록 쉽지 않습니다.
그래서 연관관계 편의 메소드를 생성해서 사용하는 것이 좋습니다.
연관관계 편의 메소드를 생성하자
Member-Team 관계에서 연관관계 편의 메소드를 생성했습니다.
이제 member.setTeam() 메소드만 호출하면 연관관계 주인과 주인이 아닌 객체 둘 다에 값이 입력됩니다.
주의할 점은, 편의 메소드는 둘 중 한 곳에서만 작성하도록 합니다.
// Member 엔티티 클래스에 연관관계 편의 메소드 생성
public void setTeam(Team team) {
this.team = team;
team.getMembers().add(this);
}
양방향 매핑시에 무한 루프를 조심하자
일반적으로 toString(), lombok, JSON 생성 라이브러리 사용 시 발생합니다.
그래서 toString()을 사용하지 않는 것, JSON 생성 라이브러리의 경우 Controller에서 엔티티를 그대로 반환하지 않고 DTO로 변환해서 단순 값만 반환하는 방식으로 구현합니다.
양방향 매핑 정리
- 단방향 매핑만으로도 이미 연관관계 매핑은 완료!
- 단방향 매핑으로 설계를 완료하려고 노력합시다.
- 객체 입장에서 양방향 설계는 고민거리만 늘어날 뿐이다.
- 양방향 매핑은 반대 방향으로 조회(객체 그래프 탐색) 기능이 추가된 것 뿐이다.
- JPQL에서 역방향으로 탐색할 일이 많은데, 그 때 양방향 매핑을 사용한다.
- 따라서 단방향 매핑을 잘 하고 양방향은 필요할 때 추가해도 괜찮다. 테이블에 영향을 주지 않기 때문에 괜찮다.
- 다시 한 번 말하지만, 단방향 매핑으로 잘 설계하도록 노력하고, 애플리케이션 개발 단계에서 필요 시 양방향 매핑 도입을 고민하도록 합시다.
연관관계의 주인을 정하는 기준은
- 비즈니스 로직을 기준으로 연관관계의 주인을 선택하면 안됩니다.
- 연관관계의 주인은 외래 키의 위치를 기준으로 정합니다.
참고
'Programming > JPA' 카테고리의 다른 글
[JPA] H2 Database 새로운 데이터베이스 생성 오류 관련 (0) | 2022.05.01 |
---|---|
[JPA] 기본 키 매핑 (0) | 2022.04.30 |
[JPA] 필드와 컬럼 매핑 (0) | 2022.04.30 |
[JPA] 엔티티 매핑 (0) | 2022.04.30 |
[JPA] 영속성 컨텍스트 (0) | 2022.04.30 |