@Embeddable @Embedded 어노테이션에 대해 알아보자

📌 들어가며 

@Embeddable 과 @Embedded 어노테이션은 Entity가 단순할 때에는 잘 사용하지 않지만 Entity 가 복잡해질 수록 가독성과 공통적인 의미를 갖고 있는 컬럼을 하나의 객체로 사용하기 위해 자주 사용하게 되는 어노테이션입니다. 이번 포스팅에서는 해당 어노테이션의 사용법에 대해 정리해보도록 하겠습니다.

---

📌 @Embeddable , @Embedded 어노테이션 사용하기

Embeddable 어노테이션을 사용하는 가장 흔한 예시인 User Entity를 정의하면서

해당 어노테이션의 사용법을 알아보겠습니다.

 

우선 두 어노테이션은 

@Embeddable : 값 타입을 정의하는 곳에 표시

@Embedded : 값 타입을 사용하는 곳에 표시

 

다음의 위치에서 사용하게 됩니다. 그럼 예시로 User Entity를 만들어보겠습니다.

 

@Entity
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long uid;
​
    private String name;
​
    private String phoneNum;
​
    private String zipCode; //우편번호
    private String wideAreaAddress; //광역주소
    private String addressDetail; //상세주소
}

 

User Entity 에서 우편번호와 광역주소, 상세주소 필드는

결국 사용자의 주소를 표현하는 필드입니다.

 

필드의 개수가 위와 같을 때에는 크게 문제되지 않겠지만

필드의 개수가 많아질수록 관리하기 어려워질 것입니다. 이때 Embeddable, Embedded 어노테이션을 사용할 수 있습니다.

 

@Entity
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long uid;
​
    private String name;
​
    private String phoneNum;
​
    @Embedded
    private Address address;
}

 

@Embeddable
public class Address {
    private String zipCode;
    private String wideAreaAddress;
    private String addressDetail;
}

 

우편번호, 광역주소, 상세주소를 묶어서 하나의 Address 객체를 만들었고

해당 Address 객체를 사용한 후 @Embedded 어노테이션을 달아주면

Address 컬럼을 포함하여 DB가 생성됩니다.

 

---

📌 @AttributeOverride

@Embedded를 이용해 객체로 Entity의 Column을 표현하면, Column 이름이 중복되는 문제가 발생하기도 합니다.

예를 들어 동일한 Address객체로 여러 개의 필드를 만들면 Entity 입장에서는 중복되는 컬럼을 여러개 생성해야 하기 때문에 오류가 발생합니다.

 

이러한 문제를 해결하기 위해 AttributeOverride 라는 어노테이션을 사용해서

컬럼을 세부적으로 지정해 줘야 합니다.

 

@Entity
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long uid;
​
    private String name;
​
    private String phoneNum;
​
    @Embedded
    private Address homeAddress; // 집 주소
​
    @Embedded
    private Address companyAddress; //직장 주소
}

@Embedded를 사용하는 경우에 객체의 이름이 아닌 해당 객체안에 작성된,

필드의 이름을 Column으로 사용하므로 동일한 Address 객체를 이용하면 중복이 발생합니다.

 

@Embedded
@AttributeOverride(name = "zipCode", column = @Column(name = "home_zipCode"))
@AttributeOverride(name = "wideAreaAddress", column = @Column(name = "home_wideAreaAddress"))
@AttributeOverride(name = "addressDetail", column = @Column(name = "home_addressDetail"))
private Address homeAddress;
​
@Embedded
@AttributeOverride(name = "zipCode", column = @Column(name = "company_zipCode"))
@AttributeOverride(name = "wideAreaAddress", column = @Column(name = "company_wideAreaAddress"))
@AttributeOverride(name = "addressDetail", column = @Column(name = "company_addressDetail"))
private Address companyAddress;

 

위와 같이 AttributeOverride 어노테이션을 사용하여 중복을 피하고

객체안의 컬럼을 재정의하여 Address 객체를 갖는 컬럼을 두개 이상 사용할 수 있습니다.

 

 

 

 

참고 :

https://galid1.tistory.com/592

https://dandev.tistory.com/m/entry/JPA-Embedded-Embeddable%EB%9E%80-%EB%AC%B4%EC%97%87%EC%9D%B4%EB%A9%B0-%EC%96%B8%EC%A0%9C-%EC%82%AC%EC%9A%A9%ED%95%A0%EA%B9%8C-%F0%9F%A4%94