Spring Boot를 활용하여 게시판 API 서버 제작 (2) - 엔티티 설계, Repository 구현

🚩Overview

로그인에 사용될 Member 엔티티를 설계하고, Member가 저장될 Repository를 구현하고 테스트합니다.
 

🚩Member Entity 설계

📁 Member

@Entity
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Member extends BaseEntity { // (1)

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "member_id")
    private Long id;

    private String username;
    private String password;
    private String nickname;
    private String email;
	
    // (2)
    @OneToMany(mappedBy = "member", orphanRemoval = true)
    private List<MemberRole> roles;

    public Member(String username, String password, String nickname, String email, List<Role> roles) {
        this.username = username;
        this.password = password;
        this.nickname = nickname;
        this.email = email;
        this.roles = roles.stream()
                .map(r -> new MemberRole(r)).collect(Collectors.toList());
    }

    public void updateNickName(String nickname) {
        this.nickname = nickname;
    }

    public void updateEmail(String email) {
        this.email = email;
    }

    public void updatePassword(String password) {
        this.email = email;
    }
}

 

@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
@Getter
public class BaseEntity {

    @CreatedDate
    @Column(updatable = false)
    private LocalDateTime createdTime;

    @LastModifiedDate
    private LocalDateTime lastModified;

    @PreUpdate
    public void onPreUpdate() {
        this.lastModified = LocalDateTime.now();
    }
}

• 1. 회원 엔티티 생성 및 변경 시 생성, 변경 날짜를 갖는 컬럼을 갖도록 설계하였습니다. 
  • BaseEntity를 설계하고 @MappedSuperClass로 등록
  • @EnableJpaAuditing : 스프링 부트 설정 클래스에 적용
  • @EntityListeners(AuditingEntityListener.class) : Base 엔티티에 적용

Spring Data JPA의 확장 기능인 Auditing에 대해서는 아래 자료를 참고해주세요.
 

[JPA] Spring Data JPA - 확장 기능

 

• 2. 회원은 여러 개의 권한을 가질 수 있습니다. 따라서 Role과 다대다 관계를 갖는데, MemberRole 중간 다리 엔티티를 설계하여 일대다-다대일 매핑으로 풀어냈습니다.
  • @ManyToMany로 생성된 중간 테이블은 관계 설정에 필수적으로 필요한 정보들만 담겨있을 뿐 비즈니스 로직상 필요한 정보들은 담기지 않기 때문에 실무에서는 @ManyToMany을 잘 사용하지 않고 직접 중간 테이블을 만들어 OneToMany - ManyToOne으로 풀어내서 연관관계를 매핑하였습니다.
  • Member가 저장될 때 MemberRole 또한 연쇄적으로 저장되거나 제거될 수 있도록 cascade 옵션을 ALL로 설정했습니다 
  • orphanRemoval=true로 설정해서 MemberRole이 고아 객체가 되었을 때, MemberRole을 자동으로 삭제하도록 설정
  • 식별관계 사용 : 다대다 매핑은 중간 테이블에 @IdClass를 사용하여 중간테이블 양 옆의 PK를 복합키로 사용하는 방법

영속성 전이, 고아객체, 다대다 관계 매핑에 대해서는 아래 자료를 참고해주세요.
 

[JPA] 영속성 전이 by Cascade 옵션

 
 
📁 MemberRole 

@Entity
@Getter
@AllArgsConstructor
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@EqualsAndHashCode
@IdClass(MemberRoleId.class)
public class MemberRole {

    @Id
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "member_id")
    private Member member;

    @Id
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "role_id")
    private Role role;
}

• 받아온 식별자는 외래키로만 사용하고 새로운 식별자를 추가하는 것을 비식별관계라고 합니다.
• 비식별 관계에서는 부모 엔티티를 삭제하더라도 자식 엔티티를 자동으로 삭제하지 않습니다. 자식 엔티티를 수동으로 삭제해야 합니다.
• 비식별관계를 사용하는 것이 식별자 클래스를 만들지 않고 단순하게 ORM 매핑을 할 수 있을 뿐더러 비즈니스 키에 의존하지 않는다는 장점이 있습니다. 실무에서 또한 다대다 매핑에서 비식별관계를 사용하는 전략을 선호한다고 합니다.
• 따라서 저 또한 비식별관계를 사용하는 전략으로 매핑하였었는데, 비식별관계로 하게되면 cascade 옵션 사용에 제약이 있어서 식별위와 같이  식별관계로 변경하여 진행하였습니다. 

식별관계, 비식별관계 매핑에 대해서는 아래를 참고해주세요.

[JPA] 다대다 단방향, 양방향 연관관계 매핑

📁 Role

@Entity
@Getter
@NoArgsConstructor
public class Role {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "role_id")
    private Long id;

    @Enumerated(value = EnumType.STRING)
    private RoleType roleType;
}

Role에서는 아래와 같이 RoleType을 정의하여 @Enumerated 속성에 EnumType.STRING으로 지정 시 ENUM 이름 그대로 데이터베이스에 저장하도록 설정해주었습니다.
 
@Enumerated 어노테이션에 대해서는 아래 자료를 참고해주세요.

[JPA] Entity Mapping : 필드 ➡️ 컬럼 매핑

 
RoleType

@RequiredArgsConstructor
public enum RoleType {
    USER("ROLE_NORMAL"), MANAGER("ROLE_MANAGER"), ADMIN("ROLE_ADMIN");
    private final String value;
}

 
로그인 기능에 필요한 Member 엔티티의 설계가 끝났습니다.
서버를 켜서 데이터베이스에 테이블이 잘 만들어졌는지 확인해봅시다.
(application.yml의 spirng.jpa.hibernate.ddl-auto 옵션을 create로 변경하여 설계한 엔티티의 테이블을 DB에 자동 생성하도록 설정)

데이터베이스에 설계한대로 테이블이 잘 만들어졌습니다.
이제 Member 엔티티를 저장할 Repository를 구현해봅시다.

---

🚩MemberRepository 구현

Repository는 Spring Data JPA를 사용하여 구현합니다.

public interface MemberRepository extends JpaRepository<Member,Long> {

    @EntityGraph(attributePaths = "roles")
    Optional<Member> findOneWithRolesByUsername(String username);
    Optional<Member> findByUsername(String username);
    List<Member> findAllByNickname(String nickname); 
    boolean existsByUsername(String username);
    boolean existsByEmail(String email);
}

• @EntityGraph을 사용해서 Member의 username으로 해당 유저의 Role까지 함께 조회할 수 있도록 쿼리 메소드를 생성하였습니다.
• 그 외에도 여러 쿼리 메소드를 생성해보았는데, Repository Test에서 사용해보도록 하겠습니다.

쿼리 메소드와, @EntityGraph에 대해서는 아래 자료를 참고해주세요.

[JPA] Spring Data JPA - 쿼리 메소드 기능