1 - 02. Spring Entity 작성하기

Entity란?

• 실체, 객체 라는 의미
• 업무에 필요하고 유용한 정보를 저장하고 관리하기 위한 집합적인 것(명사)
  ex. [엔터티]학생 - [속성]학번, 이름, 학점, 전공 등
• 즉, 정보를 저장할 수 있는 것을 일컫음

---

전체 Code

@Entity     
@Getter   
@AllArgsConstructor 
public class User {
    @Id 
    @GeneratedValue(strategy = GenerationType.IDENTITY)  
    private int id;

    @Column(name = "user_id" ,nullable = false, unique = true, length = 30) 
    private String user_id;

    @Column(nullable = false, length = 10)
    private String user_name;

    @Column(nullable = false, length = 30)
    private String user_password;
}

💡 Feedback
Setter는 값을 변경할때 사용하는 것이며, 값변경은 사용하지 않는 것이 좋으므로,
가급적 @Setter의 작성은 삼가는 것이 좋다.

 

---

Annotation(@) 분석

• @Entity
  • 데이터베이스의 테이블과 링크(연결)될 클래스 라는 의미
  • 기본값으로 @Entity가 작성된 클래스명을 카멜케이스로 바꾼 것으로 데이터 베이스의 테이블 이름을 매칭
    (ex. MemberAccount → member_account)

 

• @Id

  @Id
  private int id;
  

  • 해당 데이터 베이스 테이블의 PK(Primary Key)필드 표시
  • 속성에 직접 이 어노테이션을 붙여주면 실행시점에 객체의 필드를 통해 직접 접근하게 된다.
  • 만약, Getter에 이용하려면 Getter에 @Id를 작성해 주면 된다.
    ※Setter에 단독으로 @Id작성시, 예외가 발생한다.
  • 속성을 나타내는 변수 위에 @Id를 작성할 시, setter, getter없이도 작업이 가능하게 된다.
  • @Column 어노테이션을 지정하지 않으면 열 이름은 기본 키 속성 또는 필드의 이름으로 가정한다.
  • @GeneratedValue없이 @Id만 사용한다면 직접 할당이 된다.
  • 즉, persist()메서드를 호출하기 전에 애플리케이션에서 직접 식별자 값을 할당해야 하며,
    식별자 값이 없을 경우 에러를 발생시킨다.
    
    

    사용 가능 유형	예시
    기본타입	int, long, double, char...
    기본 Wrapper 유형	Interger, Long, Double
    String	-
    java.util.Date	Date date = new Date()
    java.sql.Date	java.sql.Date date = new java.sql.Date()
    java.math.BigDecimal	new BigDecimal(value);
    java.math.BigInteger	BigInteger bigNum = BigInteger.valueOf(value)

 

• @GeneratedValue
  • PK(Primary Key)의 작성 규칙 표시(자동 생성 전략 명시)
  • 선택적 속성
    • Generator
    • Strategy
  • 주키 생성 전략
    1. AUTO
       1. (persistence provider가) 특정 DB에 맞체 자동 선택
    2. IDENTITY
       1. DB의 identity컬럼을 이용
    3. SEQUENCE
       1. DB의 시퀀스 컬럼을 이용
       2. 데이터베이스의 특별한 오브젝트 시퀀스를 사용하여 기본키를 생성한다.
    4. TABLE
       1. 유일성이 보장된 데이터베이스 테이블을 이용
  • Spring Boot 2.0부터는 auto_increment를 위해서 GenerationType.IDENTITY 옵션 추가가 필수적임

 

• @Column
  • DB 테이블의 칼럼임을 표시
    • Column이란?
      • 테이블의 칼럼(column)이란 테이블을 구성하는 각각의 열에 위치한 정보
      • 즉, 속성(Attribute)을 의미한다.
      • ex. 사번, 이름, 부서, 입사연도
      
      

      사번	이름	부서	입사연도
      #0001	김가가	개발	2020
      #0002	이나나	마케팅	2019
      #0003	홍다다	회계	2022

  • 작성이 필수는 아니며, 기본값(변수명, 글자 길이, null여부 등) 외에 변경이 필요한 옵션이 존재할 경우 사용

 

• @ManyToOne / @OneToMany
  • 관계형 데이터 베이스(SQL)에서 관계 매핑을 위한 어노테이션
  • 각각 n : 1과 1 : n을 나타냄

---

Lombok

Java 라이브러리의 하나로 Getter, Setter, toString 등의 반복되는 메서드 작성 코드를 줄여주는 코드

• @Data
  • 아래의 모든 어노테이션을 포함하는 어노테이션이다.
• @Setter
  • 현재 클래스 내 모든 멤버변수의 setter를 생성시킨다.
• @Getter
  • 현재 클래스 내 모든 멤버변수의 getter를 생성시킨다.
• @NoArgsConstructure
  • 현재 클래스의 기본 생성자(매개변수 없는 생성자)를 만들어 준다.
• @AllArgsConstucto
  • 현재 클래스 내 모든 멤버 변수를 받는 생성자를 만들어준다
• @RequiredArgsConstructor
  • 클래스의 멤버변수 중 final혹은 Lombok 어노테이션인 @NonNull이 붙은 멤버변수만을 받는 생성자를 만들어준다.
• @Builder
  • 해당 클래스의 빌더 패턴(builder pattern) 클래스 생성
  • 생성자 상단에 선언시 생성자에 포함된 필드만 빌더에 포함된다.

  post = Post.builder()
          .title(title)
          .content(content)
          .author(author)
          .build();
  

• @ToString
  • 클래스의 멤버 변수들에 toString을 적용하여 변수들을 출력할 수 있게 해준다.
  • exclude를 통해 제외할 필드를 지정할 수 있다 (@ToString(exclude = “변수명”)
• @NonNull
  • 변수에 선언시, 해당값은 반드시 값이 있어야한다.
  • Setter에 null값이 들어오면 NullPointerException을 발생시킨다.

 

 

 

---

 

 

 

회고

---

 

 

 

 

---

 

 

 

참고자료

[게시판]

https://velog.io/@yu-jin-song/SpringBoot-%EA%B2%8C%EC%8B%9C%ED%8C%90-%EA%B5%AC%ED%98%84-1-Entity-%EB%B0%8F-Repository-%EA%B5%AC%ED%98%84

[Spring Boot] 게시판 구현 1 - Entity 및 Repository 만들기

---

[테이블 설계 & 개발]

https://it-mesung.tistory.com/206

[Spring Boot JPA] 테이블 설계 및 Entity 개발 시 주의사항

---

[@Id, @GeneratedValue]

https://rutgo-letsgo.tistory.com/306

@Id / @GeneratedValue에 대해 알아보자

---

[JPA 어노테이션]

https://velog.io/@leyuri/Spring-boot-JPA-%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98-Entity-Table-Column-Id-Lombok

Spring-boot JPA 어노테이션 @Entity, @Table, @Column, @Id @Lombok

https://jogeum.net/6

JPA 기본 사용 문법 파악하기

---

[lombok]

https://goyunji.tistory.com/98

[lombok] 생성자 관련 어노테이션 @NoArgsConstructor @RequiredArgsConstructor @AllArgsConstructor

 

 

 

 

---

 

 

 

Notion 정리 자료

https://flaxen-chanter-0fa.notion.site/02-Entity-1a82afc1738f4aa486f56c27067bcaa5

02. Entity 작성하기