[JPA] 필드와 컬럼 매핑 - @Embedded (임베디드 타입 매핑)

 

 

 

 

 

 

 

 

임베디드 타입(복합 값 타입)

우리는 새로운 값 타입을 직접 정의해서 사용할 수 있습니다. 예를 들면 다음과 같습니다.

public Class Address {

    private String city;
    private String street;
    private String zipcode;
}

 

 

city와 street, zipcode를 가지는 Address란 클래스를 만들었습니다.

 

그러나 이는 엔티티로 사용할 목적이 아닌 값 타입으로 사용하기 위해 만든 것입니다.

 

이를 JPA에서는 임베디드 타입이라고 부르며, 임베디드 타입도 int, String과 같은 값 타입입니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

@Embedded & @Embeddable

 

임베디드 타입을 필드로 사용하려면 필드 위에 @Embedded를 붙입니다.

 

그리고 값 타입으로 사용되는 클래스에는 @Embeddable을 붙입니다.

 

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

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

 

이때 값 타입 클래스에는 기본 생성자가 필수로 존재해야 합니다.

 

 

 

 

 

 

예시

@Entity
public class Member {
    @Id @GeneratedValue
    private Long id;
    
    private String name;
    
    @Embedded
    private Address address;

}

@Embeddable
public class Address {
    private String city;
    private String street;
    private String zipcode;

}

 

 

DB에 매핑되는 모습은 다음과 같습니다.

MEMBER 테이블 컬럼

 

 

임베디드 타입은 값 타입의 일부일 뿐입니다.

따라서 임베디드 타입에 속한 값이 그대로 매핑됩니다.

 

 

임베디드 타입을 사용하지 않고 street, zipcode, city를 Member에서 그냥 사용할때와 테이블의 구조는 똑같은 것입니다.

 

 

 

 

 

 

 

 

 

 

임베디드 타입과 연관관계

 

임베디드 타입은 또다른 임베디드 타입을 포함하거나 엔티티를 참조할 수 있습니다.

 

즉 다른 엔티티, 혹은 값 타입과 연관관계를 맺을 수 있다는 뜻입니다.

 

 

 

예시

@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
@Setter
@Getter
public class Member{

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


    private String name;

    @Embedded
    private Address address;

    @Embedded
    private Phone phone;
}

Member는 Address와 Phone을 값 타입으로 사용합니다.

 

 

 

 

@Embeddable
public class Address {

    private String city;
    private String street;

    @Embedded
    private Zipcode zipcode;
}

 

 

Address는 또다른 임베디드 타입은 Zipcode를 참조합니다.

@Embeddable
public class Zipcode {

    private String zip;
    private String plusFour;
}

 

 

 

 

 

 

 

 

@Embeddable
public class Phone {

    private String areaCode;
    private String number;

    @ManyToOne
    @JoinColumn(name = "PHONE_PROVIDER")
    private PhoneServiceProvider provider;
}

Phone은 PhoneServiceProvider와 @ManyToOne의 연관관계를 가지고 있습니다.

 

 

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class PhoneServiceProvider {

    @Id @GeneratedValue
    private Long id;

    private String name;
}

 

 

 

 

생성되는 테이블은 다음과 같습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

@AttributeOverride 를 사용한 속성 재정의

 

저의 다른 글(https://ttl-blog.tistory.com/141)에서 @AttributeOverrid를 통해 컬럼 속성을 재정의 할 수 있다고 하였습니다.

 

 

임베디드 타입에서는 어떻게 사용하는지 알아보도록 하겠습니다.

 

 

 

 

예를 들어 회원이 집 주소와 회사 주소 2개의 주소를 필요로 한다고 하면 어떻게 해야할까요?

@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
@Setter
@Getter
public class Member{

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


    private String name;

    @Embedded
    private Address homeAddress;

    @Embedded
    private Address companyAddress;

    @Embedded
    private Phone phone;
}

 

 

위와 같은 클래스를 가지고 실행해보면 다음 오류가 발생합니다.

오류가 뜨는 모습

 

예외 메세지는 다음과 같습니다.

org.hibernate.MappingException: 
Repeated column in mapping for entity: 
jpa.jpa.Member column: city (should be mapped with insert="false" update="false")

엔티티에 반복되는 컬럼이 있어서 매핑오류가 발생했다고 합니다.

 

 

 

 

 

이럴 때 이 중복되는 컬럼을 해결해주기 위해 @AttributeOverride를 사용할 수 있습니다.

 

@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
@Setter
@Getter
public class Member{

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


    private String name;

    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "city", column = @Column(name = "HOME_CITY")),
            @AttributeOverride(name = "street", column = @Column(name = "HOME_STREET")),
            @AttributeOverride(name = "zipcode.zip", column = @Column(name = "HOME_ZIP")),
            @AttributeOverride(name = "zipcode.plusFour", column = @Column(name = "HOME_PLUS_FOUR")),
    })
    private Address homeAddress;


    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "city", column = @Column(name = "COMPANY_CITY")),
            @AttributeOverride(name = "street", column = @Column(name = "COMPANY_STREET")),
            @AttributeOverride(name = "zipcode.zip", column = @Column(name = "COMPANY_ZIP")),
            @AttributeOverride(name = "zipcode.plusFour", column = @Column(name = "COMPANY_PLUS_FOUR")),
    })
    private Address companyAddress;

    @Embedded
    private Phone phone;
}

 

 

 

 

 

 

 

 

 

 

 

 

 

값 타입 주의 - 임베디드 타입의 공유 참조

임베디드 타입 같은 값 타입은 여러 엔티티에서 공유하면 위험합니다.

 

어떤 객체의 값을 수정하였는데, 다른 객체의 값까지 수정되는 경우가 발생할 수 있기 때문입니다.

 

 

예시를 하나 들어보겠습니다.

Address address = new Address("서울", "길", new Zipcode("100","100"));
Member member1 = new Member();
member1.setAddress(address);
em.persist(member1);


Member member2 = new Member();
member2.setAddress(address);//address 공유
em.persist(member2);


member1.getAddress().setCity("대전");

 

 

위 코드의 결과는 다음과 같습니다.

1과 2 모두 CITY가 대전으로 바뀌었다.

 

 

위와 같은 문제의 발생을 막기 위해 값 타입은 공유되지 못하게 막아야 합니다.

 

 

 

이를 위한 방법들을 알아보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

불변 객체로 만들기

객체를 불변하게 만들면 값을 수정할 수 없기 때문에, 공유 참조로 발생하는 부작용을 방지할 수 있습니다.

 

따라서 값 타입은 되도록 불변 객체(생성 시점 이후 절대 값을 변경할 수 없는 객체)로 설계해야 합니다.

 

 

불변 객체로 만드는 방법은 여러 방법이 있으나, 가장 간단한 방법은 생자로만 값을 설정하고, 수정자는 만들지 않으면 됩니다.

 

 

 

 

 

위의 Address를 불변 객체로 만들어보겠습니다.

@Embeddable
public class Address {

    private String city;
    private String street;

    @Embedded
    private Zipcode zipcode;
    
    
    protected Address(){}//JPA는 기본 생성자가 필수이다.

    public Address(String city, String street, Zipcode zipcode) {
        this.city = city;
        this.street = street;
        this.zipcode = zipcode;
    }
    
    //수정자는 만들지 않는다.
}

 

 

이제 Address는 불변 객체입니다.

값을 수정할 수 없으므로 공유해도 부작용이 발생하지 않습니다.

 

만약 값을 수정해야 하면, 생성자를 이용해 새로운 객체를 만들어 사용해주어야 합니다.

 

참고로 String, Integer는 자바가 제공하는 대표적인 불변 객체입니다.

 

 

 

 

 

 

 

 

 

 

 

값 타입의 비교 - equals 재정의

equals는 기본이 == 비교이기 때문에, 값 타입을 새로 만들어 주었다면 equals, hashCode를 재정의해 주어야 합니다.

(웬만하면 자동으로 생성해주는 기능을 그대로 사용하는 것이 좋습니다.)

 

 

 

 

 

 

 

 

 

 

참고

@Inheritance는 다형성을 위한 상속을

@MappedSuperclass는 코드 재사용을 위한 상속을

@Embedded, @Embeddable은 합성을 구현할 때 사용합니다.

 

 

 

 

 

 

 

 

 

📔 Reference

자바 ORM 표준 JPA 프로그래밍 - 기본편 - 인프런 | 강의

 

[자바 ORM 표준 JPA 프로그래밍 - 김영한]