특정 엔티티를 영속 상태로 만들 때 연관된 엔티티도 함께 영속 상태로 만들고 싶으면 영속성 전이 기능을 사용하면 된다. JPA는 CASCADE 옵션으로 영속성 전이를 제공한다.
쉽게 말해서 영속성 전이를 사용하면 부모 엔티티를 저장할 때 자식 엔티티도 함께 저장 할 수 있다.
Parent - 부모 엔티티
@Entity
public class Parent {
@Id
@GeneratedValue
private Long id;
private String name;
@OneToMany(mappedBy = "parent") //주인 지정
private List<Child> childList = new ArrayList<>();
public void addChild(Child child) {
childList.add(child);
child.setParent(this);
}
//... Getter, Setter
}
연관관계 편의 메서드인 addChild 메서드를 만들어서 child를 넣으면 양방향 관계를 다 세팅해준다.
Child - 자식 엔티티
@Entity
public class Child {
@Id
@GeneratedValue
private Long id;
private String name;
@ManyToOne
@JoinColumn(name = "parent_id") //연관관계의 주인
private Parent parent;
//... Getter, Setter
}
Parent, Child 엔티티는 N:1 양방향 관계로 Child가 연관관계의 주인이다.
테스트 코드
public class JpaMain {
// EntityManager...
try {
Child child1 = new Child();
Child child2 = new Child();
Parent parent = new Parent();
parent.addChild(child1);
parent.addChild(child2);
em.persist(parent);
em.persist(child1);
em.persist(child2);
tx.commit(); // 트랜잭션을 커밋하는 시점에서 영속성 컨텍스트에 있는 DB의 쿼리가 날라감
} catch (Exception e) {
tx.rollback();
e.printStackTrace();
} finally {
em.close(); //중요, 엔티티 매니저가 결국 내부적으로 데이터베이스 커넥션을 물고 동작함. 사용 후 꼭 닫아줘야함.
}
emf.close();
}
}
현재 상황에서는 em.persist를 3번 호출해야 한다. 그런데 내가 지금 Parent를 중심으로 코드를 작성하고 있는데 child까지 하나하나 persist 하는 것이 귀찮다.
Parent 중심으로 코드를 작성할 때는 Parent가 Child를 관리 해주고 Parent를 persist 할 때 child는 자동으로 persist 되면 좋겠다.
이때 사용하는 것이 바로 CASCADE이다.
이제 적용해보겠다.
Parent 수정
@OneToMany(mappedBy = "parent", cascade = CascadeType.PERSIST)
private List<Child> childList = new ArrayList<>();
Parent의 @OneToMany
에 cascade = CascadeType.PERSIST
를 추가했다. 그리고 다시 코드를 실행해보자.
그런데 이때는 다른 점이 존재한다. child는 persist 하지 않고 parent만 persist 해보겠다.
테스트 코드
public class JpaMain {
// EntityManager...
try {
Child child1 = new Child();
Child child2 = new Child();
Parent parent = new Parent();
parent.addChild(child1);
parent.addChild(child2);
em.persist(parent);
tx.commit(); // 트랜잭션을 커밋하는 시점에서 영속성 컨텍스트에 있는 DB의 쿼리가 날라감
} catch (Exception e) {
tx.rollback();
e.printStackTrace();
} finally {
em.close(); //중요, 엔티티 매니저가 결국 내부적으로 데이터베이스 커넥션을 물고 동작함. 사용 후 꼭 닫아줘야함.
}
emf.close();
}
}
결과
나는 분명 em.persist(parent)만 해주고 child는 persist 해주지 않았는데 child 둘 다 persist 된 것을 볼 수가 있다.
이것이 바로 CASCADE이다.
연관관계 이런 것과는 전혀 관계가 없다. 그냥 Parent를 persist 할 때 밑에 있는 자식 엔티티를 다 persist 해주는 것이다.
주의!
위처럼 옵션이 있지만 보통 ALL, PERSIST 정도만 사용한다.
참고로 CascadeType.PERSIST
, CascadeType.REMOVE
는 em.persist(), em.remove()를 실행 할 때 바로 전이가 발생하지 않고 플러시를 호출 할 때 전이가 발생한다.
Parent parent1 = em.find(Parent.class, id);
parent1.getChildren().remove(0);
//자식 엔티티를 컬렉션에서 제거
JPA는 부모 엔티티와 연관관계가 끊어진 자식 엔티티를 자동으로 삭제하는 기능을 제공하는데 이것을 고아 객체 제거라고 한다.
이 기능을 사용해서 부모 엔티티의 컬렉션에서 자식 엔티티의 참조만 제거하면 자식 엔티티가 자동으로 삭제하도록 코드를 작성해 보겠다.
Parent - 부모 엔티티
@Entity
public class Parent {
@Id
@GeneratedValue
private Long id;
private String name;
@OneToMany(mappedBy = "parent", cascade = CascadeType.ALL, orphanRemoval = true) //주인 지정
private List<Child> childList = new ArrayList<>();
public void addChild(Child child) {
childList.add(child);
child.setParent(this);
}
//... Getter, Setter
}
Parent 클래스의 @OneToMany에 orphanRemoval = true를 추가했다.
이제 자식 엔티티를 하나 삭제해보자.
테스트 코드
public class JpaMain {
// EntityManager...
try {
Child child1 = new Child();
Child child2 = new Child();
Parent parent = new Parent();
parent.addChild(child1);
parent.addChild(child2);
em.persist(parent);
em.flush();
em.clear();
Parent findParent = em.find(Parent.Class, parent.getId());
findParent.getChildList().remove(0)
tx.commit(); // 트랜잭션을 커밋하는 시점에서 영속성 컨텍스트에 있는 DB의 쿼리가 날라감
} catch (Exception e) {
tx.rollback();
e.printStackTrace();
} finally {
em.close(); //중요, 엔티티 매니저가 결국 내부적으로 데이터베이스 커넥션을 물고 동작함. 사용 후 꼭 닫아줘야함.
}
emf.close();
}
}
findParent.getChildList().remove(0)로 자식 엔티티를 컬렉션에서 제거를 했다. DB에서 확인해보자.
DB를 확인해보니 자식 엔티티 하나가 삭제 된 것을 알 수 있다. orphanRemoval = true를 넣어두면 컬렉션에서 빠진 것은 자동으로 DB에서 삭제가 된다.
주의
참조가 제거된 엔티티는 다른 곳에서 참조하지 않는 고아 객체로 보고 삭제하는 기능
참조하는 곳이 하나일 때 사용해야함!
특정 엔티티가 개인 소유할 때만 사용
@OneToOne, @OneToMany만 가능
참고: 개념적으로 부모를 제거하면 자식은 고아가 된다. 따라서 고아 객체 제거 기능을 활성화 하면, 부모를 제거할 때 자식도 함께 제거된다. 이것은 CascadeType.REMOVE처럼 동작한다.
출처
자바 ORM 표준 JPA 프로그래밍 강의
게시글 속 자료는 모두 위 강의 속 자료를 사용했습니다.
https://hongchangsub.com/jpa-cascade-2/
https://velog.io/@sa1341/JPA-%EC%98%81%EC%86%8D%EC%84%B1-%EC%A0%84%EC%9D%B4