Entity 개념 및 맵핑 방법에 대해 알아보자!

🔥 목표

Entity의 기본 개념과 맵핑 방법을 이해한다.

1. Entity 개념

• 2차원 Table 자체를 Entity라고 부름
• Table 내 각 Row가 Entity 객체이며, 각 Column이 Field
• Entity는 Table과 1대1 대응된다고 표현
• Table 내 모든 Column은 Field로 반드시 정의해야 함
• Entity 클래스는 다른 클래스를 상속받거나 인터페이스의 구현체로서 사용불가

2. Entity 클래스 사용 규칙

• Entity 클래스는 클래스 작성 시 Entity Annotation을 붙여 해당 클래스가 Entity 클래스임을 명시해야 함
• Entity 클래스에서 Domain 로직만 구현하고 Presentation 로직은 구현하지 않음
• Proxy 생성을 위해 기본 생성자는 필수이며, public(지양) 또는 protected 생성자이어야 함(private 사용불가)
• final, enum, interface, inner 클래스는 Entity로 사용불가
• DB Table에 저장할 Field는 final 선언 불가
• Setter 사용 지양
  • Entity 클래스 생성 시 Getter는 만들어야 하지만 Entity 일관성 보존을 위해 Setter 사용은 지양
  • 무분별한 Setter 사용은 Entity 클래스의 Instance가 언제, 어디에서 변경되었는지 파악하기 어려움(참고문헌)
  • Setter 대신 Builder 패턴을 활용하면 멤버 변수가 많아져도 필요한 데이터만 Field에 넣는 것이 용이

2.1. Annotation(i.e., @)

@Entity

• 클래스 선언 시 Annotation을 입력하면 해당 클래스가 Entity 클래스임을 명시하는 역할
• Entity 클래스는 JPA에서 정의한 필드를 기반으로 Table 생성

@Builder

• @AllArgsConstructor를 사용한 것처럼 Entity 객체 생성 시 Builder pattern 생성

@AllArgsConstructor

• 모든 Field를 Parameter로 받는 생성자 생성
• 디버깅 어려움 및 다양한 버그 생성을 야기하므로 해당 annotation 사용은 지양(참고문헌)
• 생성자를 직접 만들고 생성자에 @Builder를 붙여 사용하는 것을 권장

@RequiredArgsConstructor

• final 또는 @NonNull에 해당하는 Field만 Parameter로 받는 생성자 생성(null인 경우 NullPointerException 발생)
• 생성자 주입 시 불필요한 코드 작성을 줄여 클린 코드 작성 시 유용함
• 디버깅 어려움 및 다양한 버그 생성을 야기하므로 해당 annotation 사용은 지양(참고문헌)

@NoArgsConstructor

• Parameter 없는 기본 생성자 생성
• 초기값이 final 필드인 경우 컴파일 에러 발생

속성

• access
  
  • 역할
    • 속성값이 protected인 경우(권장), 외부에서 무분별하게 해당 Entity의 객체 생성 방지
    • 속성값이 public인 경우(지양), 객체 생성 시 안전성 저하 유발
  • 작성 예시: @NoArgsConstructor(access = AccessLevel.PROTECTED)

@Getter

• 필드값 조회를 위한 Getter 자동 생성

@ToString

• 클래스에서 선언한 모든 필드를 출력하는 toString 메소드 생성
• exclude 속성을 사용하면 특징 Field는 출력하지 않을 수 있음

@Table

• Entity와 Mapping 할 Table 지정

속성

• name(String, Optional)
  • 역할: Mapping 할 테이블 이름 지정
  • 기본값: Entity 이름
  • 작성 예시: @Table(name = "테이블 이름")
• catalog(String, Optional)
  • 역할: DB catalog mapping
• catalog(String, Optional)
  • 역할: DB schema mapping

• schema(String, Optional)
  • 역할: DB schema mapping

• indexes(Index[], Optional)
  
  • 역할: DB index mapping

• uniqueConstraints(UniqueConstraint[], Optional)
  
  • 역할: DDL 생성 시 Unique 제약사항 지정

@Id

• Entity의 Primary Key 값 지정

@GeneratedValue(strategy = GenerationType.IDENTITY)

• MySQL에서의 Auto Increment와 같은 역할 수행

@Column

속성

• name(String, Optional)
  • 역할: Column 이름 지정
  • 기본값: 해당 객체 이름

• nullable(Boolean, Optional)
  • 역할: 해당 Field 값이 반드시 입력받아야 할지 여부 결정
  • 기본값: true

• length(int, Optional)
  • 역할: 문자열 길이 제한
  • 특징: String type에서만 사용가능

@ManyToOne

• 하나의 Entity와 다른 N개의 Entity 간 관계 형성 지원

2.2. Entity 클래스 작성 예시

그림 1. 2차원 테이블(i.e., Entity) 예시

• 위 그림 1 내 Not Null 속성을 갖는 id, name, age, salary라는 Column을 갖는 employee라는 Table이 있다고 하면, 아래와 같이 employee Entity를 정의할 수 있음

@Entity
@Table(name = "employee") 
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Employee {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; // 필수 입력 & 10글자 초과 입력불가
    @Column(nullable = false, length = 10)
    private String name;
    @Column
    private int age; // 객체 이름과 다르게 column 이름 개별지정
    @Column(name = "salary") 
    private int pay; 
}

---

포스팅 내용에 오류가 있다면 아래에 댓글 남겨주세요!
감사합니다 :)