Spring Data JPA 정리 2 _ 애노테이션

JPA는 앞에서 말했듯이 객체와 DB를 연결해주는 ORM이다.

 

따라서 객체와 DB에 저장될 테이블간의 연결을 제대로 해주는것이 가장 중요하다. 이때 매핑을 위해 사용되는 것들이 애노테이션이다.

 

객체와 테이블 매핑

• @Entity
• @Table

기본 키 매핑

• @Id

필드와 컬럼 매핑

• @Column
• @GeneratedValue
• @Enumerated

연관관계 매핑

• @OneToOne
• @OneToMany
• @ManyToOne
• @ManyToMany (있긴하지만 사용을 지양해야한다.)

몇가지 더 있지만 대표적인 애노테이션들부터 정리해보겠다. 아래 Member Entity를 생각하며 읽어보자.

 

@Entity
@Getter
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Table(name = "MEMBER")
public class Member {
    @Id
    @Column(unique = true, nullable = false)
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long seq;

    @Column(unique = true, nullable = false)
    private String userId;

    @Column(unique = true, nullable = false)
    private String email;

    @Column(nullable = false)
    private String password;
    
    @Column(length = 500)
    private String intro;
    
    @Enumerated(EnumType.STRING)
    private LoginType loginType;
}

@Entity

DB에 매핑이 되서 테이블이 될 객체를 지칭해준다. @Entity 애노테이션이 붙음으로서 JPA는 이 객체의 필드와 애노테이션을 기반으로 DDL을 작성하고 DB는 해당 DDL을 통해 테이블을 생성해준다.

 

엔티티가 되기위해서는 3가지 원칙이 존재한다.

• 기본 생성자가 꼭 있어야 한다.
• final, interface, enum, inner 클래스가 아닌 기본 클래스여야 한다.
• 저장할 프로퍼티에 final을 사용할 수 없다.

이 조건에 맞는다면 엔티티로서 사용될 수 있다.

@Table

@Table(name = "member") 과 같은 방식으로 엔티티가 매핑될 테이블의 이름을 지정해 줄 수 있다.

 

그 외에도 DDL 유니크 제약 조건, 스키마, 카탈로그 등을 매핑해줄 수 있다.

@Id

엔티티의 PK가 될 컬럼을 지칭해준다. PK는 해당 테이블내에서 유일하고 필수적인 값이 되고 식별값으로서 존재하게 된다. 또한 외부 테이블에서 해당 테이블과 연관관계를 가질 때 PK가 FK로서 작동한다.

 

이때 PK값을 생성해주는 애노테이션이 있는데 데이터베이스 별로 별칭은 조금씩 다르지만 자동생성 방식, 채번 방식 등이 존재한다.

@GeneratedValue

방금 말한 PK의 값을 생성해주는 전략을 고르는 애노테이션이다.

 

전략의 종류로는 TABLE, SEQUENCE, IDENTITY, AUTO가 존재한다.

• IDENTITY : 기본 키 생성을 현재 연결된 DB에게 위임한다. 계속 값이 채번된다.
• SEQUENCE : DB 시퀀스를 이용해서 기본키를 할당한다. 계속 값이 채번된다.
• TABLE : 키 생성 테이블을 이용한다. 직접 만드는 방식이다.
• AUTO : DB마다 이름이 다르므로 각 DB에 맞게 알아서 IDENTITY, SEQUENCE, TABLE 전략을 선택하게 한다.

Q. IDENTITY vs SEQUENCE 차이점은?

• IDENTITY 전략은 먼저 엔티티를 DB에 저장하고, 식별자를 조회해서 엔티티의 식별자로 할당하는 전략이다.
• SEQUENCE 전략은 저장 전에 DB Sequence를 먼저 조회하고, 조회한 식별자를 엔티티에 할당 한 후에
  엔티티를 persist해서 영속화하고, 이후 트랜잭션이 커밋되어 flush되면 그때 DB에 저장된다.

@Column

테이블에 매핑될 컬럼에 달아준다. @Colmn(name = "USER_EMAIL") 와 같은 방식으로 테이블의 컬럼명을 지정해줄 수 있다. 만약 이름을 따로 안달아주면 해당 필드의 이름으로 자동적으로 생성된다.

 

또한 DDL 생성 시 유니크 제약조건, 널 제약 조건, 길이 제약 조건 등을 달아 줄 수 있다.

• @Cloumn(unique = true, nullable = false, length = 1000) 과 같은 방식
• 길이를 따로 지정해주지 않으면 255자가 최대이다

@Enumerated

enum 타입 클래스를 필드로 가질때 해당 enum의 값은 정의된 이름 그대로 사용될 수도 있고, 단순 정수값의 순서로 사용될 수도 있다.

 

enum LoginType{
	EMAIL, KAKAO, NAVER
}

위와 같은 enum클래스를 필드로 갖고 있을 때 DB에 EMAIL이라는 글자 그대로 넣어지길 원한다면

 

@Enumerated(EnumType.STRING)과 같이 사용하면 된다.

 

만약, @Enumerated(EnumType.ORDINAL)을 사용하면 그냥 정수값인 0, 1, 2 값으로 들어가게 된다.

 

이렇게 되면 DB상에서 정확히 이 값이 의미하는 바를 알기가 어렵기 때문에 EnumType.STRING 방식으로 사용하는 것을

권장한다.