[우리집 가족 커뮤니티 웹 서비스 프로젝트] Entity 생성 그리고 enum Class

Programming Project 작업실/내용 정리

[우리집 가족 커뮤니티 웹 서비스 프로젝트] Entity 생성 그리고 enum Class

주니쓰🧑‍💻 2021. 9. 29. 01:34

728x90

안녕하세요? 주니하랑이에요!

오늘부터 주니하랑이 가족들을 위한 웹 서비스를 혼자 만들어 보려 하는 것이에요.

주니하랑은 집에 Synology NAS를 통해 저와 가족들을 위해 편리한 기능들을 많이 서비스 중인데, 가족들이 아무도 사용을 하지 못하는 것이에요😥

그래서 웹 서비스를 만들어서 메뉴얼을 볼 수 있는 서비스를 만들어 볼 것이에요!

주니하랑이 작성한 Source Code는 여기 Git Hub에서 확인하실 수 있습니다!

📌 Member와 게시판 그리고 댓글

먼저 주니하랑은 Maria DB를 Sysnology NAS에 Docker로 만들어 논 것이에요.

그래서 mariadb의 driver를 설정하고, 계정을 설정해 준 것이에요.

👉 Hibernate 속성 소개

hibernate.show_sql : 실행하는 SQL문을 Console에 출력
hibernate.format_sql : SQL을 보기 좋게 정리해서 출력
spring.jpa.hibernate.use-new-id-generator-mappings : JPA에 맞춘 새로운 ID 생성 방법 사용. Hibernate Legacy를 운영하는 것이 아니라면 항상 true로 설정
spring.jpa.hibernate.ddl-auto : Applicatioon이 시작될 때 테이블과 기타 DDL을 자동으로 생성.
1. create : 기존 DDL을 제거하고, 새로 생성
2. create-drop : create와 같으나, Application이 종료될 때, 생성한 DDL 제거
3. update : 현재 DB DDL과 비교하여 변경사항만 수정
4. validate : 현재 엔티티 매핑 정보와 DB 스키마가 같은지 비교한다. 만약 다르면 경고를 남기고, Application을 실행하지 않는다. 이 설정은 DDL 미 변경.

⚠ 주의 : spring.jpa.hibernate.use-new-id-generator-mappings 주의사항

이 옵션을 설정하지 않으면 하이버네이트는 과거 버전에서 사용했던 키 생성 전략을 사용하게 된다.
하이버 네이트 공식 문서는 true로 설정해서 JPA 표준에 맞춘 새로운 키 생성 전략을 권장한다.
하이버네이트는 과거 버전과 호환을 위해 신규 개발자에게 이 옵션을 설정하도록 했다.

💡 참고 :

JPA의 동작 환경은 순수 자바인 J2SE와 JSEE 표준 컨테이너 위에서 동작하는 것으로 나눌 수 있다.
스프링 프레임워크는 LocalContainerEntityManagerFactoryBean을 사용하여 J2SE 환경의 JPA를 마치 표준 컨테이너 위에서 동작하는 것처럼 에뮬레이션 한다.

📍 Member Entity

먼저 주니하랑은 해당 서비스를 위해 DB 설계를 어떻게 할지 고민한 것이에요.

여러 고민을 끝에 위와 같이 DB를 작성 해 보기로 했답니다!

👉 Entity Class 생성

@Entity

Entity Class는 Spring Data JPA에서는 @Entity를 추가해야만 하는 것이에요. 이 친구는 JPA가 관리를 하는 것이에요.
@Entity는 해당 클래스가 엔티티를 위한 클래스이며, 해당 클래스의 인스턴스들이 JPA로 관리되는 엔티티 객체를 의미하는 것이랍니다!

기본 생성자는 필수 (매개 변수가 없는 public 또는 protected 생성자)
final 클래스, enum, interface, inner 클래스에는 사용 불가.
저장할 필드에 final을 사용 불가

@NoArgsConstructor

기본 생성자를 만들어 주는 Annotation

@AllArgsConstructor

멤버 변수를 매개 변수로 갖는 생성자를 만들어 주는 Annotation

@Getter

멤버 변수에 대한 Getter Method를 만들어주는 Annotation

@ToString

toString()을 Override(재 정의)하여 각각의 멤버 변수들을 (Non Static Filed)를 출력
멤버 변수 이름을 출력되지 않게 하기 위한 방법
@ToString(includeFieldNames = false)
특정 멤버 변수가 toString()에 포함되지 않게 하려면
@ToString(exclude={'Field 이름1',' Field 이름2'})
명시적으로 특정 필드를 포함하게 하려면
@ToString(callSuper=true)
부모 클래스의 toString()을 호출하게 하려면
@ToString(callSuper=true)
기본적으로 getter가 있으면 해당 Method 호출이 되나, 이를 사용하지 않고, 필드를 직접 호출하려면
@ToString(doNotUseGetter=true)

@Id

DB에서 PK (Primary Key)를 지정하는 Annotaion인 것이에요.

@GeneratedValue

위에서 사용한 strategy=GenerationType.IDENTITY는 IDENTITY 전략이라고 하는데, MariaDB와 같은 DBMS에서 사용하는 AUTO_INCREMENT를 사용하도록 만드는 것이에요. 개발자가 엔티티에 직접 식별자를 할당하면 @Id만 있으면 되지만, 식별자가 생성되는 경우네느 @GeneratedValue를 통해 식별자 생성 전략을 구성해야 하는 것이에요.

IDENTITY 전략을 사용하려면 @GeneratedValue의 strategy 속성값을 GenerationType.IDENTITY로 지정하면 되는 것이에요. 이렇게 하면 JPA는 기본 키 값을 얻어오기 위해 DB를 추가로 조회해야 하는 것이에요.

자동 생성 : 대리 키 사용 방식
- IDENTITY : 기본 Key 생성을 DB에 위임
- SEQUENCE : DB 시퀀스를 사용해서 기본 키 할당
- TABLE : Key 생성 Table 사용
직접 할당 : 기본 키를 Application에 직접 할당

@Enumerated(EnumType.STRING)

먼저 @Enumerated는 JAVA의 enum Type을 Mapping할 때 사용하는 것이에요.

속 성	기 능	기 본 값
value	● EnumType.ORDINAL : enum 순서를 DB에 저장 ● EnumType.STRING : enum 이름을 DB에 저장	EnumType.ORDINAL

enum Class는 다음과 같이 사용하는 것이에요.

enum RoleType {
	ADMIN, USER
}

아래는 enum 이름으로 Mapping하는 것이에요.

@Enumerated(EnumType.STRING)
private RoleType roleType;

enum은 다음과 같이 사용하는 것이에요.

// DB에 문자 ADMIN으로 저장
number.setRoleType(RoleType.ADMIN);

@Enumerated를 사용하면 편리하게 enum Tyupe을 DB에 저장할 수 있는 것이에요.

EnumType.ORDINAL은 enum에 정의된 순서대로 ADMIN은 0, USER는 1 값이 DB에 저장 되는 것이에요.

장점 : DB에 저장되는 Data 크기가 작다.
단점 : 이미 저장된 enum의 순서를 변경할 수 없다.

EnumType.STRING은 enum 이름 그대로 ADMIN은 'ADMIN', USER는 'USER'라는 문자로 DB에 저장되는 것이에요.

장점 : 저장된 enum의 순서가 바뀌거나, enum이 추가 되어도 안전하다.
단점 : DB에 저장되는 Data 크기가 ORDINAL에 비해서 크다.

💡 참고 :

기본값인 ORDINAL은 주의해서 사용 할 것!

ADMIN(0번), USER(1번) 사이에 enum이 하나 추가되어 ADMIN(0번), NEW(1번), USER(2번)으로 설정되면 이제부터 USER는 2로 저장되나, 기존 DB에 저장된 값은 여전히 1로 남아 있다. 따라서 이런 문제가 발생하지 않는 EnumType.STRING을 권장한다.

주니하랑은 위의 Annotation들을 사용해서 Member라는 Entity를 구성했고, 회원 등급과 개인정보 수집 동의서에 대한 내용들을 받을 수 있게 처리한 것이에요.

회원 가입시에 회원 고유 번호(id), 회원 Email 주소(email), 회원 비밀번호(password), 회원 이름(name), 회원 별명(nick_name), 회원 전화번호(phone), 회원 등급(grade), 개인정보 수집 동의서(agree)를 받을 것이에요.