본문 바로가기

BackEnd/JPA

[JPA] 값 타입 (기본값, 임베디드, 컬렉션 등)

기본값 타입

 JPA의 데이터 타입 분류

  • 엔티티 타입
    - @Entity로 정의하는 객체를 의미한다.
    - 데이터가 변해도 식별자(PK)로 지속해서 주적이 가능하다.
     예) 회원 엔티티의 키와 나이가 변경되도 식별자를 통해 회원의 정보를 찾을 수 있다.
  • 값 타입
    - int, Integer, String처럼 단순히 값으로 사용하는 자바 기본 타입이나 객체를 의미한다.
    - 식별자가 없고 값만 있으므로 변경시 추적이 불가하다.
     ex) 숫자 100을 200으로 변경하면 완전히 다른 값으로 대체되며 100을 추적할 수 없다.

 값 타입 분류

  • 기본값 타입 : 자바 기본 타입(int, double), 래퍼 클래스(Integer, Long), String
  • 임베디드 타입(embedded type, 복합 값 타입)
  • 컬렉션 값 타입(collection value type)

 기본값 타입

String name;
int age;
  • 기본값 타입은 생명주기를 엔티티에 의존한다.
    : 회원을 삭제하면 이름, 나이 필드도 함께 삭제된다.
  • 값 타입은 유일해야 한다. 공유X
    : 회원 이름 변경 시 다른 회원의 이름도 함께 변경되면 안된다. 그러므로 공유되어서는 절대 안된다.
  • 자바의 기본 타입은 공유할 수가 없다.
    ex) int, double 같은 기본 타입(primitive type)은 참조 값이 없고 항상 값만을 복사한다.
  • Integer같은 래퍼 클래스나 String 같은 특수한 클래스는 공유 가능한 객체이지만 변경할 수 없다.

 

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

 임베디드 타입

  • 새로운 값 타입을 직접 정의할 수 있다.  JPA는 임베디드 타입(embedded type)이라고 한다.
  • 주로 기본 값 타입을 모아 만들어 복합 값 타입이라고도 불리며 int, String과 같은 값 타입이다.

 임베디드 타입 사용법

  • @Embeddable : 값 타입을 정의하는 곳에 표시한다.
  • @Embedded : 값 타입을 사용할 곳에 표시한다.
  • 기본 생성자를 필수로 만들어야 한다.
  • 회원 엔티티는 이름, 근무 시작일, 근무 종료일, 주소 도시, 주소 번지, 주소 우편번호를 가진다. (기본 값 타입)
    @Entity
    public class Member extends BaseEntity {
    
        @Id @GeneratedValue
        @Column(name = "MEMBER_ID")
        private Long id;
        @Column(name = "USERNAME")
        private String userName;
    
        private LocalDateTime startDate;
        private LocalDateTime endDate;
    
        private String city;
        private String street;
        private String zipcode;
         ...
     }​​
  • 회원 엔티티는 이름, 근무기간, 집 주소를 갖는다. (임베디드 타입을 사용해 변경 처리)
    @Embeddable
    public class Period {
        private LocalDateTime startDate;
        private LocalDateTime endDate;
        public Period() {}
    }
    
    @Embeddable
    public class Address {
        private String city;
        private String street;
        private String zipcode;
        public Address() {}
    }
    
    @Entity
    public class Member extends BaseEntity {
        @Id @GeneratedValue
        @Column(name = "MEMBER_ID")
        private Long id;
        @Column(name = "USERNAME")
        private String userName;
    
        @Embedded
        private Period period;          // 기간
        @Embedded
        private Address homeAddress;    // 집 주소
        ...
    }



 임베디드 타입의 장점

  • 임베디드 타입을 선언해 사용 시 재사용성이 뛰어나고 높은 응집도를 가질 수 있다.
  • Period.isWork()처럼 해당 값 타입만 사용하는 의미 있는 메소드를 만들 수 있다.
  • 임베디드 타입을 포함한 모든 값 타입은, 값 타입을 소유한 엔티티에 생명주기를 의존한다.

 임베디드 타입과 테이블 매핑

김영한의  자바 ORM 표준 JPA 프로그래밍

  • 임베디드 타입은 엔티티의 값일 뿐이다.
  • 임베디드 타입을 사용하기 전과 후에 매핑하는 테이블의 정보는 동일하다.
  • 객체와 테이블을 아주 세밀하게(find-grained) 매핑하는 것이 가능하다.
  • 잘 설계한 ORM 애플리케이션은 매핑한 테이블의 수보다 클래스의 수가 더 많다.

 

 임베디드 타입과 연관관계

김영한의  자바 ORM 표준 JPA 프로그래밍

  @AttributeOverride : 속성 재정의

  • 한 엔티티에서 같은 값 타입을 사용하면 컬럼이 중복되 문제가 발생한다.
  • @AttributeOverrides, @AttributeOverride를 사용해 컬럼 명 속성을 제 정의할 수 있다.
    @Entity
    public class Member extends BaseEntity {
    	...
        @Embedded
        private Address homeAddress;
        
        @Embedded
        @AttributeOverrides({
            @AttributeOverride(name="street", column=@Column(name="WORK_STREET")),
            @AttributeOverride(name="zipcode", column=@Column(name="WORK_ZIPCODE")),
            @AttributeOverride(name="city", column=@Column(name="WORK_CITY"))
        })
        private Address cityAddress;
        ...
    }​
  • 임베디드 타입의 값이 null이면 매핑한 컬럼 값은 모두 null이다.

 

값 타입과 불변 객체

 값 타입은 복잡한 객체 세상을 조금이라도 단순화하려고 만든 개념이다.  따라서 값 타입은 단순하고 안전하게 다룰 수 있어야 한다.

 값 타입 공유 참조

  • 임베디드 타입 같은 값 타입을 여러 엔티티에서 공유하면 위험하다.
  • 부작용(side effect) 발생
    public class ValueMain {
        public static void main(String[] args) {
            Address address1 = new Address("oldCity","2","3");
            Member member1 = new Member();
            member1.setHomeAddress(address1);
            Member member2 = new Member();
            member2.setHomeAddress(address1);
            address1.setCity("NewCity");
            System.out.println("member1.getHomeAddress().getCity() = " + member1.getHomeAddress().getCity());
            System.out.println("member2.getHomeAddress().getCity() = " + member2.getHomeAddress().getCity());
        }
    }
    -----------------------------------------------------------------------------------
    member1.getHomeAddress().getCity() = NewCity
    member2.getHomeAddress().getCity() = NewCity
    김영한의  자바 ORM 표준 JPA 프로그래밍

 값 타입 복사

  • 값 타입의 실제 인스턴스인 값을 공유하는 것은 참조되므로 부작용이 발생하는 것을 확인했다.
  • 부작용을 없애기 위해 값(인스턴스)를 복사해서 사용해야 한다.
    public class ValueMain {
        public static void main(String[] args) {
            Address address1 = new Address("oldCity","street","zipcode");
            Member member1 = new Member();
            member1.setHomeAddress(address1);
            Member member2 = new Member();
            member2.setHomeAddress(new Address("newCity",address1.getStreet(),address1.getZipcode()));
            System.out.println("member1.getHomeAddress().getCity() = " + member1.getHomeAddress().getCity());
            System.out.println("member2.getHomeAddress().getCity() = " + member2.getHomeAddress().getCity());
        }
    }
    ---------------------------------------------------------
    member1.getHomeAddress().getCity() = oldCity
    member2.getHomeAddress().getCity() = newCity

 

 객체 타입의 한계

  • 항상 값을 복사해서 사용하면 공유 참조로 인해 발생하는 부작용을 피할 수 있다.
  • 문제는 임베디드 타입처럼 직접 정의한 값 타입은 자바의 기본 타입이 아니라 객체 타입이다.
  • 자바 기본 타입에 값을 대입하면 값을 복사한다.
  • 객체 타입은 참조 값을 직접 대입하는 것을 막을 방법이 없다.
  • 객체 공유 참조는 피할 수 없다.
    // 기본 타입(primitive type)
    int a = 10;
    int b = a;  // 기본 타입은 값을 복사
    b = 4;
    
    // 객체 타입(object type)
    Address a = new Address("Old");
    Address b = a;    // 객체 타입은 참조를 전달
    b.setCity("New")  // 참조가 전달되기 때문에 a와 b의 city값은 동일

 불변 객체

   불변이라는 작은 제약으로 부작용이라는 큰 재앙을 막을 수 있다.

  • 객체 타입을 수정할 수 없게 만들면 부작용을 원천적으로 차단할 수 있다.
  • 값 타입은 불변 객체(immutable object)로 설계해야 한다.
  • 불변 객체 : 생성 시점 이후 절대 값을 변경할 수 없는 객체를 의미한다.
  • 생성자로만 값을 설정하고 수정자(Setter)를 만들지 않거나 private로 선언하면 된다.
    ex) Integer, String은 자바가 제공하는 대표적인 불변 객체이다.

 

값 타입의 비교

  • 값 타입 : 인스턴스가 달라도 그 안에 값이 같으면 같은 것으로 볼 수 있다.
    int a = 10;  // ex1
    int b = 10;
    
    Address a = new Address("서울시");  // ex2
    Address b = new Address("서울시");​
  • 동일성(identity) 비교 : 인스턴스의 참조 값을 비교, == 사용
  • 동등성(equivalence) 비교 : 인스턴스의 값을 비교, equals() 사용
  • 값 타입은 a.equals(b)를 사용해서 동등성 비교를 해야한다.
  • 값 타입의 equals() 메소드를 적정하게 재정의(overide)해야 한다.  주로 모든 필드를 사용한다.
    @Embeddable
    public class Address {
    
        // 주소
        private String city;
        private String street;
        private String zipcode;
        
        // equals 재정의
        @Override
        public boolean equals(Object o) {
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;
            Address address = (Address) o;
            return Objects.equals(city, address.city) && Objects.equals(street, address.street) && Objects.equals(zipcode, address.zipcode);
        }
    }

값 타입 컬렉션

  • 값 타입을 하나 이상 저장할 때 사용한다.
  • @ElementCollection, @CollectionTable 어노테이션을 사용한다.
  • 데이터베이스는 컬렉션을 같은 테이블에 저장할 수 없다.
  • 컬렉션을 저장하기 위해 별도의 테이블이 필요하다.

 값 타입 컬렉션 사용

  • 값 타입 저장 예제
    @Entity
    public class Member extends BaseEntity {
    	...
        @ElementCollection
        @CollectionTable(name = "FAVORITE_FOOD", joinColumns = @JoinColumn(name = "MEMBER_ID"))
        @Column(name="FOOD_NAME")
        private Set<String> favoriteFoods = new HashSet<>();
        
        @ElementCollection
        @CollectionTable(name = "ADDRESS", joinColumns = @JoinColumn(name = "MEMBER_ID"))
        private List<Address> addressHistory = new ArrayList<>();
        ...
    }
    
    public class JpaMain {
        public static void main(String[] args) {
        	...
            // 값타입 컬렉션은 정말 단순할때만 사용한다.
            // 값이 바뀌어도 업데이트를 할 필요가 없을 때 사용한다.
            Member member = new Member();
            member.setUserName("member1");
            member.setHomeAddress(new Address("homeCity", "street","zipcode"));
            member.getFavoriteFoods().add("치킨");
            member.getFavoriteFoods().add("피자");
            member.getFavoriteFoods().add("족발");
            member.getAddressHistory().add(new Address("old1", "street","zipcode"));
            member.getAddressHistory().add(new Address("old2", "street","zipcode"));
            em.persist(member);
            ...
        }
    }
  • 값 타입 조회 예제 : 값 타입 컬렉션도 지연 로딩 전략을 사용한다.
    // Member를 조회 시 지연로딩으로 Member테이블만 조회된다.
    Member findMember = em.find(Member.class, member.getId());
    
    // 값을 얻는 시점에만 조회(지연로딩)
    findMember.getAddressHistory().get(0);       
    for (String favoriteFood : findMember.getFavoriteFoods()) {
        System.out.println("favoriteFood = " + favoriteFood);
    }​
  • 값 타입 수정 예제 : 값 타입 컬렉션은 영속성 전이(Cascade) + 고아 객체 제거 기능을 필수로 가진다고 볼 수 있다.
    // Member를 조회 시 지연로딩으로 Member테이블만 조회된다.
    Member findMember = em.find(Member.class, member.getId());
    ////////////////////////////////////////////////////////////////////////
    // 값 변경 처리
    // 사이드 이팩트가 발생할 수 있는 사례 HomeCity -> newCity
    // findMember.getHomeAddress().setCity("newCity");
    // 객체복사를 통한 사이드 이팩트 방지
    Address a = findMember.getHomeAddress();
    findMember.setHomeAddress(new Address("newCity", a.getStreet(), a.getZipcode()));
    
    // 치킨 -> 한식
    findMember.getFavoriteFoods().remove("치킨");
    findMember.getFavoriteFoods().add("한식");        
    
    // List는 equals로 remove가 가능하므로 필히 equals를 override해야 한다.
    // 값 타입 컬렉션에 변경 사항이 발생
    // 주인 엔티티와 연관된 모든 데이터를 삭제 -> 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장
    findMember.getAddressHistory().remove(new Address("oldCity", "street", "zipcode"));
    findMember.getAddressHistory().add(new Address("newCity", "street","zipcode"));​

 값 타입 컬렉션의 제약사항

 

  • 값 타입은 엔티티와 다르게 식별자 개념이 존재하지 않는다.  그러므로 값을 변경 시 추적하기 어렵다.
  • 값 타입 컬렉션에 변경 사항이 발생하면, 주인 엔티티와 연관된 모든 데이터를 삭제하고, 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장한다.
  • 값 타입 컬렉션을 매핑하는 테이블은 모든 컬럼을 묶어서 기본 키를 구성해야 함 : null 입력X, 중복 저장X

 값 타입 컬렉션 대안

  • 값 타입 컬렉션은 단순히 저장만을 할 때 사용하는 편이 좋다. (단순한)
  • 실무에서는 상황에 따라 값 타입 컬렉션 대신 일대다 관계를 고려하는 게 좋다.
  • 일대 다 관계를 위한 엔티티를 만들고, 여기에서 값 타입을 사용하도록 구성한다.
  • 속성 전이(Cascade) + 고아 객체 제거를 사용해 값 타입 컬렉션과 유사하게 사용할 수 있다.
    @Entity
    @Table(name="ADDRESS")
    public class AddressEntity {
    
        @Id @GeneratedValue
        private Long id;
    
        private Address address;
        public AddressEntity() {}
        public AddressEntity(String city, String street, String zipcode) {
            address = new Address(city, street, zipcode);
        }
    }
    
    @Entity
    public class Member extends BaseEntity {
    //    @ElementCollection
    //    @CollectionTable(name = "ADDRESS", joinColumns = @JoinColumn(name = "MEMBER_ID"))
    //    private List<Address> addressHistory = new ArrayList<>();
    
        @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
        @JoinColumn(name = "MEMBER_ID")
        private List<AddressEntity> addressHistory = new ArrayList<>();
    }
    
    public class JpaMain {
        public static void main(String[] args) {
        	...
                Member member = new Member();
                member.setUserName("member1");
                member.getAddressHistory().add(new AddressEntity("old1", "street","zipcode"));
                member.getAddressHistory().add(new AddressEntity("old2", "street","zipcode"));
                em.persist(member);        
            ...
        }
    }​

정리

 엔티티타입의 특징

  • 식별자가 존재한다.
  • 생명 주기를 관리할 수 있다.
  • 공유할 수 있다.

 값 타입의 특징

  • 식별자가 없다.
  • 생명 주기를 엔티티에 의존한다.
  • 공유하지 않는 것이 안전하다. (복사해서 사용)
  • 불변 객체로 만드는 것이 안전하다.

 

값 타입은 정말 값 타입이라 판단될 때만 사용되어야 한다.

엔티티와 값 타입을 혼동해서 엔티티를 값 타입으로 만들어서는 안된다.

식별자가 필요하고, 지속해서 값을 추적, 변경해야 한다면 그것은 값 타입이 아닌 엔티티이다.