JPA part 5

June 22, 2022

Relationship Mapping

엔티티 간에는 연관관계가 존재하는데, 이를 테이블에서는 외래키를 이용해서 관계를 맺고, 객체는 참조값을 객체 참조를 이용해서 관계를 맺는다.

이런 연관관계에는 방향, 다중성, 주인, 등의 속성이 있는데, 이는 아래에서 다루도록 하겠다.

단방향 연관관계

다대일 단방향 연관관계

예를 들어, 회원과 여러 회원이 속한 팀이 있다고 가정할떄, 회원과 팀은 서로 다대일 연관관계를 지닌다.

n_to_1

위에서 보듯, 객체 연관관계를 살펴 보면, Member 객체에는 Team 객체를 멤버 변수로 갖고 있어, member.getTeam() 방식으로 Team 객체에 접근 할 수 있지만, Team 에서는 해당 멤버에 접근할 수 없다. 이를 통해, 단뱡향으로 연결되는 것을 알 수 있다.

테이블에서는 외래키, 기본키를 이용한 연관관계가 매핑되며, Member, Team 각각에서 JOIN을 통한 양방향 조회가 가능하다. 테이블은 항상 양방향으로 연관관계가 형성된다.

객체를 양방향에서 서로 참조하고자 하면, 단방향 연관관계 2개를 생성해야한다.

JPA Relationship Mapping

Member Entity

@Entity
public class Member {

    @Id
    @Column(name = "MEMBER_ID")
    private Long id;

    private String username;

    //연관 관계 매핑
    @ManyToOne
    @JoinColumn(name="TEAM_ID")
    private Team team;

    //연관관계 설정
    public void setTeam(Team team) {
        this.team = team;
    }

    //Getter Setter
}

Team Entity

@Entity
public class Team{
  @Id
  @Column(name="TEAM_ID")
  private String id;
  private String name;
}

@JoinColumn

외래키를 지정하기 위한 annotation으로 아래와 같은 속성을 부여할 수 있다.

Options	Description
name	외래키의 이름 지정
referencedColumnName	참조하는 테이블의 기본키 컴럼명
foreinKey()	테이블 생성시 사용되는 컬럼
Column annotation에서 사용되는 속성들 사용 가능

@JoinColumn 을 생략하면 외래키를 찾을 때, 기본값으로 (필드값_참조되는 테이블의 기본키 컬럼명) 인데, 위의 예시의 경우 @JoinColumn 생략시 team_TEAM_ID가 외래키로 지정된다.

@ManyToOne

다대일 연관관계 매핑을 위해 사용하는 annotation으로 아래와 같은 속성이 있다.

Options	Description
optional	연관된 엔티티가 항상 존재하는 지 여부(false면 항상 있어야 되고, true면 없어도 연관관계 형성 가능
fetch	글로벌 패치 전략 지정
cascade	영속성 전이 기능

@ManyToOne에 대응되는 것이 @OneToMany인데, @OneToMany를 지정한 컬럼은 아래와 같이 사용할 수 있다.

@OneToMany
private List<Member> members;           // 제너릭 사용

@OneToMany(targetEntity=Member.class) //어떤 Entity들이 저장되는 지 지정하는 annotation 인데, 주로 위의 제너릭 방식을 사용하는 것이 좋다.
private List members;   

연관관계 CRUD 수행해보기

Create

public void testSave() {
    //팀1 저장
    Team team1 = new Team("team1", "팀1");
    em.persist(team1);

    //회원1 저장
    Member member1 = new Member(100L, "회원1");
    member1.setTeam(team1);     //연관관계 설정 member1 -> team1
    em.persist(member1);

    //회원2 저장
    Member member2 = new Member(101L, "회원2");
    member2.setTeam(team1);     //연관관계 설정 member2 -> team1
    em.persist(member2);
}

우선적으로, 팀 객체를 생성하고, 회원 객체는 팀 객체를 참조하도록 지정한 다음, 해당 객체들을 DB에 저장한다. DB에 저장될 때, 아래의 sql문들이 생성되어 실행된다.

INSERT INTO TEAM(TEAM_ID,NAME) VALUES('team1','팀1');
INSERT INTO MEMBER(MEMBER_ID,NAME,TEAM_ID) VALUES('member1','회원1','team1');
INSERT INTO MEMBER(MEMBER_ID,NAME,TEAM_ID) VALUES('member2','회원2','team1');

Read

객체 그래프를 이용한 조회

Member member = em.find(Member.class, 100L);
Team team = member.getTeam();   //객체 그래프 탐색
System.out.println("팀 이름 = " + team.getName());

JPQL을 이용한 조회 방식

String jpql1 = "select m from Member m join m.team t where " +
        "t.name = :teamName";

List<Member> resultList = em.createQuery(jpql1, Member.class)
        .setParameter("teamName", "팀1")
        .getResultList();

for (Member member : resultList) {
    System.out.println("[query] member.username = " +
            member.getUsername());
}

위의 jpql을 실행하게 되면 아래의 sql문이 생성된다.

SELECT * 
FROM MEMBER JOIN TEAM
ON MEMBER.TEAM_ID=TEAM.TEAM_ID
WHERE TEAM.NAME='팀1'

jpql을 이용해서 조인을 이용한 조회를 수행하는 것이 가능하다.

Update

// 새로운 팀2
Team team2 = new Team("team2", "팀2");
em.persist(team2);

//회원1에 새로운 팀2 설정
Member member = em.find(Member.class, 100L);
member.setTeam(team2);

위와 같이 연관관계를 수정하게 되면 아래의 sql문이 실행된다.

UPDATE MEMBER
SET TEAM_ID='team2'
WHERE ID='member1'

Delete

Member 객체에서 연관관계를 제거

Member member=em.find(Member.class,"member1");
member.setTeam(null);

위와 같이 연관관계에 있는 객체참조를 없애면 아래의 sql이 실행된다.

UPDATE MEMBER
SET TEAM_ID=null
WHERE ID='member1'

Team 객체 제거

Member 객체와 연관된 Team 객체를 제거하기 위해서는 기존에 연결된 연관관계들을 모두 제거한 뒤 수행해야한다.

member1.setTeam(null);  // 회원1 연관관계 제거
member2.setTeam(null);  // 회원2 연관관계 제거
em.remove(team);        // 팀 삭제

나중에, cascade를 이용해서 연관된 엔티티가 자동으로 삭제될 수 있도록 할 수 있다.

양방향 연관관계

회원에서 팀으로의 객체 참조는 가능하지만, 현재 코드상에서는 팀에서 멤버객체를 접근하는 것은 가능하지 않다. 이를 위해서는 팀에서 멤버로의 단방향 연관관계를 추가해야한다.

다대일의 대응인 일대다에서의 연관관계에서는 여러 개의 엔티티와 연관관계를 맺을 수 있으므로 collection을 이용해서 엔티티를 보관할 수 있도록 해야한다.

JPA Relational Mapping

Team Class

@Entity
public class Team {

    @Id
    @Column(name = "TEAM_ID")
    private String id;

    private String name;

    //추가
    @OneToMany(mappedBy = "team")
    private List<Member> members = new ArrayList<Member>();

    // Getter, Setter ...
}

다음과 같이 Team class에 members 필드를 추가해서 Member Entity들을 참조 할 수 있도록 한다. @OneToMany의 mappedBy는 반대쪽에 대응되는 필드값을 명시해준다.

위와 같이 members 컬렉션 객체를 저장하게 되면 아래와 같이 객체 참조가 가능하다.

Team team = em.find(Team.class, "team1");
List<Member> members = team.getMembers();   // 팀 -> 회원, 객체그래프 탐색

for (Member member : members) {
    System.out.println("member.username = " + 
            member.getUsername());
}

연관관계 주인?

양방향 연관관계라는 것은 실질적으로 단방향 연관관계 2개를 의미하게 된다. 테이블은 외래키를 이용한 양방향 연관관계가 이루어진다.

따라서, 객체에서는 단방향 연관관계 2개를 유지하게 되는데, 둘 중 어떤것을 이용해서 외래키 관계를 생성해야하는지 명확하게 구분하기 위해 연관관계 주인이라는 개념이 사용된다.

즉, 테이블에서 Member 의 Forien Key가 Team의 Primary Key를 참조하는 거지, Team의 Forein Key가 Member의 Primary key를 참조하는 것이 아니므로, 이것에 대한 방향을 설정해주기 위해 연관관계 주인이라는 것이 존재하는 것이다.

@OneToMany의 mappedBy는 이 연관관계 주인을 지정하기 위한 속성이다.

연관관계 주인이 되는 것은 외래키를 가지고 있는 엔티티가 된다. 위의 예시에서는 Member 객체가 주인이 되고, Team 객체에서는 주인이 아니라는 것을 명시하기 위해 mappedBy를 이용해서 주인을 명시한다.

아래의 그림을 통해 과정을 이해할 수 있다.

relationship_owner

또한, 연관관계 주인으로 등록한 Entity에서 외래키를 등록,수정을 담당한다.

Create

//팀1 저장
Team team1 = new Team("team1", "팀1");
em.persist(team1);

//회원1 저장
Member member1 = new Member("member1", "회원1");
member1.setTeam(team1);     //연관관계 설정 member1 -> team1
team1.getMembers().add(member1) //객체 참조 설정 team1 -> member1
em.persist(member1);

//회원2 저장
Member member2 = new Member("member2", "회원2");
member2.setTeam(team1);     //연관관계 설정 member2 -> team1
team1.getMembers().add(member2) // 객체 참조 설정 team1 -> member2
em.persist(member2);

단방향에서의 연관관계 저장방식과 유사한 코드를 이용하는 것을 알 수 있다.

아래의 코드는 외래키 맵핑을 수행하기 위한 코드이다.

member1.setTeam(team1)
member2.setTeam(team1)

아래의 코드는 팀에서 멤버 객체를 참조 할 수 있는 객체참조를 위해 추가되는 코드이다. 아래의 코드는 Team이 연관관계 주인이 아니어서 JPA에서는 무시되는 코드이지만, 객체 관계에서는 양방향 객체 참조를 위해서 추가해야되는 코드이다.

team1.getMembers().add(member1)
team1.getMembers().add(member2)

이 두 메소드를 묶어서 아래와 같은 형태로 해서 양방향 연관관계를 이어주는 메소드를 사용한다.

public void setTeam(Team team){
    this.team=team;
    //양방향 연관관계를 위해 team에서 member을 이어준다.
    team.getMembers().add(this);
}

개선된 코드

//팀1 저장
Team team1 = new Team("team1", "팀1");
em.persist(team1);

//회원1 저장
Member member1 = new Member("member1", "회원1");
member1.setTeam(team1);     //연관관계 설정 member1 -> team1
em.persist(member1);

//회원2 저장
Member member2 = new Member("member2", "회원2");
member2.setTeam(team1);     //연관관계 설정 member2 -> team1
em.persist(member2);

주의할점

Team team1 = new Team("team1", "팀1");
Team team2 = new Team("team2", "팀2");
Member member=new Member("member1","회원1");
member.setTeam(team1)
member.setTeam(team2)

아래와 같이 참조관계를 변경하는 코드를 작성하게 되면 아래의 같은 문제점이 발생한다.

relationship_error

이전 참조관계가 삭제되지 않고 유지되고, 다시 새로운 참조 관계가 추가되는 것이다. 아래와 같이 이전 참조 관계를 제거하는 코드를 삽입해야한다.

사실, 외래키의 주인인 member 객체에서는 위와 같이 참조 관계가 바뀌면 자동으로 참조값이 제거되지만, 반대방향에 있는 team 객체는 외래키 주인이 아니므로 수정이 되지 않아 기존의 참조관계가 유지되는 것이다. 이 문제를 해결하기 위해 이전의 참조 관계를 제거하는 코드가 필요한 것이다.

public void setTeam(Team team){
  //이전 관계를 제거하는 코드
  if(this.team!= null){
    this.team.getMembers().remove(this);
    this.team=null;
  }
  this.team=team;
  team.getMembers().add(team);
}

References

book: 자바 ORM 표준 JPA 프로그래밍 -김영한 저

book_link

Twitter Facebook LinkedIn

Jehyun Jung

JPA part 5

Relationship Mapping

단방향 연관관계

JPA Relationship Mapping

연관관계 CRUD 수행해보기

Create

Read

Update

Delete

양방향 연관관계

JPA Relational Mapping

연관관계 주인?

Create

주의할점

References

공유하기

댓글남기기

참고

Typescript Module Issue

Changing Java Version in Linux

[BOJ] Q1725 히스토그램

[Programmers] Q176962 과제 진행하기