Backend/Spring Boot
원본 글 보기

[JPA] 엔티티(Entity)와 엔티티 매니저(EntityManager)

[JPA] 엔티티(Entity)와 엔티티 매니저(EntityManager)

엔티티(Entity) 객체, 엔티티를 다루는 엔티티매니저(EntityManager) 객체

JPA의 가장 큰 특징은 영속성(Persistence)이다.

JPA를 사용해 검색한 DB매핑정보(엔티티)는 메모리(영속 컨텍스트)에 저장되고,

이러한 엔티티를 영속객체라 부른다.

엔티티(Entity)

JPA는 매번 데이터베이스에 접근하는 것이 아니라 엔티티매니저를 사용하여 메모리상에 작업을 한후 트랜잭션이 커밋되는 시점에 데이터베이스에 반영되는 구조를 가지고 있다.

엔티티는 DB 테이블에 보관할 대상이다. 특정한 시점에 DB에 영향을 미치는 쿼리를 실행한다.

엔티티를 설정하는 방법은 2가지가 있는데 @Entity 어노테이션을 사용하는 방법과, xml 설정을 사용하는 것이다. 대부분 어노테이션을 이용하므로.. 어노테이션을 이용하여 엔티티를 설정하는 법을 알아보자.

엔티티를 설정하기 위한 애노테이션,

@Entity

JPA에서는 쿼리를 자동으로 생성해준다. JPA는 클래스 이름을 테이블 이름으로 사용하는데, 아래의 Room 엔티티는 기본적으로 Room 테이블과 매핑된다.



@Entity
public class Room {
//...
}

@Table

그렇다면 클래스이름과 테이블의 이름이 다른 경우는?

@Table을 사용하면 클래스이름과 테이블 이름이 다르더라도 name 속성을 설정하여 테이블의 이름을 지정할 수 있다.



@Table(name="room_info")
public class Room{
// ...
}

* 그리고 order 같은 경우는 order 예약어 때문에 ㅋㅋ table 어노테이션으로 꼭 orders 라고 정해준다.

@Id

DB가 레코드를 구분하기 위해 주요키를 사용하는 것처럼, JPA는 엔티티의 @Id를 이용하여 식별자를 지정한다. @Id를 지정한 필드 값은 엔티티를 식별하기 위한 식별자로 사용된다. 아래 코드에서 id = ? 쿼리에서 ? 자리에 @Id 설정한 필드가 예시이다.




public Optional findRoom(int roomId) {
    EntityManagerFactory emf = Persistence.createEntityManagerFactory("jpastart");
    EntityManager em = emf.createEntityManager();
try {
        Room room = em.find(Room.class, roomId);
// SELECT ... FROM Room r WHERE id = ? 
return Optional.ofNullable(room);
} finally {
        em.close();
}
}

@Basic

@Id 애노테이션을 제외한 나머지 영속 대상은 @Basic 을 사용한다. 아래 Room 엔티티는 @Basic 애노테이션이 보이지 않는데, 이는 생략된 것이다.



@Entity
@Table(name="room_info")
public class Room {
    @Id
    private String number;
private String name;
private String description;
}

@Enumerated

열거타입에 대한 매핑은 @Enumerated 를 사용한다. (EnumType.STRING을 쓰자. 꼭.)

호텔 등급 열거형 >



public enum Grade {
STAR1, STAR2, STAR3, STAR4, STAR5
}

호텔 엔티티 >



@Entity
public class Hotel {
    @Id
    private String id;
private String name;
    @Enumerated(EnumType.STRING)
private Grade grade;
}

Hotel 엔티티를 보면 @Enumerated의 속성으로 EnumType.STRING 으로 지정하고 있다.

이 속성은 @Enumerated 애노테이션으로 설정한 열거형을 DB로 저장할 때 어떤 값으로 저장할지 결정한다.

EnumType.STRING으로 저장하는 경우, hotel 테이블 grade 필드에 "STAR1, STAR2, STAR3, STAR4, STAR5"란 문자열이 저장될 것이고

EnumType.ORDINAL을 사용하는 경우, grade필드에는 0~4(인덱스)가 저장된다.

(여기서 인덱스0은 STAR1, 인덱스4는 STAR5)

열거형의 순서는 바뀔 가능성이 있기때문에 ORDINAL을 사용하는 것보다는 STRING을 사용하는 것이 유지보수에 더 좋다. 아니 사실 ORDINAL를 쓰면 망한다.. 귀찮더라도 꼭 STRING으로 하자.

@Column

프로퍼티의 이름과 테이블의 칼럼 이름이 같다면 생략이 가능하지만, 다를 경우에는 @Column 애노테이션을 지정해줘야한다.



@Entity
@Table(name="room_info")
public class Room {
    @Id
    private String number;
private String name;
        
    @Column(name="description")
private String desc;
}

JPA는 INSERT, UPDATE, DELETE의 동작이 보통과 다르기 때문에 예상하지 못하거나 실수를 방지하기 위해 읽기 전용 매핑설정이 가능하다. 읽기 전용 프로퍼티를 설정하는 방법은 insertable 속성과 updateble 속성을 false로 설정하면 된다. 읽기 전용 프로퍼티는 JPA가 자동으로 생성하는 쿼리에서 제외된다.



@Entity
@Table(name="room_info")
public class Room {
//...
    @Column(name="id", insertable=false, updatable=false)
private Long dbId;
}

아래처럼 insertable 속성과 updatable 속성을 false로 지정하면

JPA에서 쿼리를 생성할 때 해당 컬럼을 제외하는 것을 확인할 수 있다.

- insert 제외 (id가 쿼리에서제외)



entityManager.persist(new Room("R202", "홍길동", "2번룸"));
//
insert into room_info (description, name, number) values (?, ?, ?);

- update 제외 (id가 쿼리에서 제외)



entityManager.getTransaction().begin();
Room room = entityManager.find(Room.class, "R202");
room.changeName("리뉴얼 2번룸"); 
entityManager.getTransaction().commit();
//
update room_info set description = ?, name = ? where number = ?;

@Embedded , @Embeddable



@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 address1;
private String address2;
}

위 zipCode, address1, address2는 각각 주소를 나타내는 필드이다. 이때 @Embedded, @Embeddable를 사용하여 Address 라는 하나의 객체로 위의 3개의 데이터를 묶는다면 조금 더 주소라는 의미를 확실하게 표현할 수 있다.



@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 address1;
private String address2;
}

하나로 표현하고자 하는 개념에 해당하는 클래스를 생성한 뒤 필드를 생성하고, 클래스 상단에 @Embeddable을 사용한다. (@Embeddable은 사실 생략이 가능하다. 하지만 둘 다 적어주는 편이 한 눈에 파악하기 좋다.)

@AttributeOverride

@Embedded를 이용해 객체로 Entity의 Column을 표현한다면, Column 이름이 중복되는 문제가 발생하기도 한다. 예를 들어 앞서 생성한 주소(Address) 객체 필드를 여러개를 생성한다면, repeated column in mapping for entity 라는 에러가 발생하는데.. @Embedded를 사용하는 경우 객체의 이름이 아닌 해당 객체안에 작성된 필드의 이름을 Column으로 사용하기 때문이다.

jpa에서 필드의 이름이 아닌 개발자가 지정한 이름으로 column을 생성하기 위해서는 @Column(name = "필드이름")을 사용하면 되지만 Address라는 같은 객체를 사용하고 있으니, 객체 안의 컬럼을 재정의 하는 방법인 @AttributeOverride 을 사용해야 한다.



@Embeddable
public class Address {
    @Column(name = "home_zipcode")
private String zipCode;

    @Column(name = "home_address1")
private String address1;

    @Column(name = "home_address2")
private String address2;
}



@Embedded
@AttributeOverride(name = "zipCode", column = @Column(name = "home_zipCode"))
@AttributeOverride(name = "address1", column = @Column(name = "home_address1"))
@AttributeOverride(name = "address2", column = @Column(name = "home_address2"))
private Address homeAddress;
​
@Embedded
@AttributeOverride(name = "zipCode", column = @Column(name = "company_zipCode"))
@AttributeOverride(name = "address1", column = @Column(name = "company_address1"))
@AttributeOverride(name = "address2", column = @Column(name = "company_address2"))
private Address companyAddress;


엔티티매니저(EntityManager)

엔티티매니저는 영속 컨텍스트에 접근하여 엔티티에 대한 DB 작업을 제공한다.

- find() 메서드

영속 컨텍스트에서 엔티티를 검색하고 없을 경우, DB에서 데이터를 찾아 영속 컨텍스트에 저장한다.

여기서 식별자는 Entity 클래스에서 @Id 어노테이션으로 지정한 값을 사용해야 한다.



public find(Class entityClass, Object primaryKey)

  • 엔티티 수정

엔티티 매니저는 별도의 update 메서드를 제공하지 않는다. JPA는 트랜잭션 범위에서 엔티티 객체의 상태가 변경되면 이를 트랜잭션 커밋 시점에 반영한다. 주의!

참고 : https://galid1.tistory.com/592