스프링부트 게시판 API 만들기 (2) - JSON 로그인 (1) - 회원 엔티티 설계

 

 

 

 

사실 어떻게 진행해야 할 지 고민을 조금 했습니다.

로그인을 먼저 하는게 맞는건지, 기능 구현이 먼저일지...

그런데 최근에 시큐리티를 공부하기도 했고, JWT 관련해서 공부를 조금 해보고 싶은 마음이 커서 (+ 추가로 제가 참고하는 블로그에서도 로그인을 먼저 했더라구요) 로그인 부터 만들도록 하겠습니다.

 

 

우선 엔티티는 회원 엔티티에서 로그인에 필요한 기본적인 정보만 가지고 생성하도록 하겠습니다.

로그인이 끝난 이후, 전체적인 애플리케이션의 요구사항을 분석하여 도메인을 설계 후 엔티티를 생성하는 방식으로 진행하겠습니다.

 

• 시큐리티를 이용한 JSON 데이터로 로그인 (진행 중)
• JWT를 이용한 인증
• 도메인, 테이블 설계, 엔티티 생성
• 댓글 삭제 로직 구현
• 회원가입 + 정보수정 등 회원 서비스 구현
• 게시판 서비스 구현
• 댓글 서비스 구현 (1댓글 -> *(무한) 대댓글 구조)
• 예외 처리
• 예외 메세지 국제화
• 카테고리별 게시판 분류
• 게시글 페이징
• 동적인 검색 조건을 사용한 검색
• 사용자 간 쪽지 기능
• 무한 쪽지 스크롤
• 게시물 & 댓글에 대한 알람
• 쪽지에 대한 알람
• 접속한 사용자 간 실시간 채팅
• 회원가입 시 검증(예: XX대학교 XX과가 아니면 가입할 수 없게)
• Swagger를 사용한 API 문서 만들기
• 신고 & 블랙리스트 기능
• AOP를 통한 로그
• 어드민 페이지
• 캐시
• 배포 (+ 무중단 배포)
• 배포 자동화
• 포트와 어댑터 설계를 따르는 패키지 구조 설계하기
• ...

 

 

 

 

 

 

 

 

 

회원가입 & 로그인 요구사항 분석

• 아이디와 비밀번호, 이름, 닉네임(별명), 나이를 입력받습니다.
• 아이디는 중복될 수 없습니다.
• 비밀번호와 이름, 닉네임과 나이는 변경할 수 있습니다.
• 비밀번호는 암호화되어 데이터베이스에 저장됩니다.
• 회원을 포함한 모든 엔티티는 데이터베이스에 저장될 때, 등록 시간과 업데이트 시간을 등록하도록 하겠습니다.
• 로그인에 성공하면 JWT를 발급해주며, 이를 통해 사용자는 우리의 게시판 서비스 API를 이용할 수 있습니다.
• 회원가입으로는 USER 권한의 회원만 가입할 수 있습니다. ADMIN 권한은 직접 데이터베이스에 입력하여 지정해주도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

회원 엔티티 작성

패키지는 다음과 같습니다.

 

@Table(name = "MEMBER")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
@AllArgsConstructor
@Builder
public class Member {

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

    @Column(nullable = false, length = 30, unique = true)
    private String username;//아이디

    private String password;//비밀번호

    @Column(nullable = false, length = 30)
    private String name;//이름(실명)

    @Column(nullable = false, length = 30)
    private String nickName;//별명

    @Column(nullable = false, length = 30)
    private Integer age;//나이

    @Enumerated(EnumType.STRING)
    private Role role;//권한 -> USER, ADMIN





    //== 정보 수정 ==//
    public void updatePassword(PasswordEncoder passwordEncoder, String password){
        this.password = passwordEncoder.encode(password);
    }

    public void updateName(String name){
        this.name = name;
    }

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

    public void updateAge(int age){
        this.age = age;
    }

    //== 패스워드 암호화 ==//
    public void encodePassword(PasswordEncoder passwordEncoder){
        this.password = passwordEncoder.encode(password);
    }

}

public enum Role {
    USER, ADMIN
}

위를 통해 다음 요구사항을 만족시켰습니다.

• 아이디와 비밀번호, 이름, 닉네임(별명), 나이를 입력받습니다.
• 아이디는 중복될 수 없습니다.
• 비밀번호와 이름, 닉네임과 나이는 변경할 수 있습니다.
• 비밀번호는 암호화되어 데이터베이스에 저장됩니다.
• 회원을 포함한 모든 엔티티는 데이터베이스에 저장될 때, 등록 시간과 업데이트 시간을 등록하도록 하겠습니다.
• 로그인에 성공하면 JWT를 발급해주며, 이를 통해 사용자는 우리의 게시판 서비스 API를 이용할 수 있습니다.
• 회원가입으로는 USER 권한의 회원만 가입할 수 있습니다. ADMIN 권한은 직접 데이터베이스에 입력하여 지정해주도록 하겠습니다.

 

이제 '회원을 포함한 모든 엔티티는 데이터베이스에 저장될 때, 등록 시간과 업데이트 시간을 등록하도록 하겠습니다.' 라는 요구사항을 만족시켜보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

생성시간과 수정시간 등록

JPA의 Auditing을 사용하여 구현하도록 하겠습니다.

 

생성시간과 수정시간은 모든 엔티티에서 사용할 것이므로 @MappedSupperclass를 사용하여 여러 엔티티가 상속받을 수 있도록 만들어주겠습니다.

@EntityListeners(AuditingEntityListener.class)
@MappedSuperclass
@Getter
public abstract class BaseTimeEntity {

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

    @LastModifiedDate
    @Column(updatable = true)
    private LocalDateTime lastModifiedDate;
}

 

 

 

 

 

 

Auditing을 사용하시면 @EnableAuditing을 꼭 스프링 부트 설정 클래스에 적용해야 합니다.

@EnableJpaAuditing
@SpringBootApplication
public class MyboardApplication {

   public static void main(String[] args) {
      SpringApplication.run(MyboardApplication.class, args);
   }

}

 

 

 

 

 

 

Auditing이 무엇인지 모르시겠다면 다음 글을 참고 바랍니다.

[Spring Data JPA] Auditing

 

 

 

 

이제 이를 Member에 적용시켜 주겠습니다.

public class Member extends BaseTimeEntity {

 

 

 

 

 

 

지금까지 작성한 패키지 구조는 다음과 같습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

MemberRepository 생성

이제 Member 엔티티를 DB와 연동하여 저장, 조회 등의 역할을 수행하는 MemberRepository 인터페이스를 생성하겠습니다.

 

패키지는 다음의 위치에 생성합니다.

 

참고로 저는 패키지 구조를 아래 사이트를 참고하여 작성하였습니다.

패키지 구조는 어떻게 짜는 게 맞을까?

 

 

 

 

 

 

이제 MemberRepository를 생성하겠습니다.

public interface MemberRepository extends JpaRepository<Member, Long> {

    Optional<Member> findByUsername(String username);

    boolean existsByUsername(String username);
}

JpaRepository를 상속받았습니다.

 

이제 Repository를 활용한 테스트코드를 작성해보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

테스트코드 작성

MemberRepository를 클릭한 후 Ctrl + Shift + T

단축키가 작동하지 않는다면 위의 위치에 테스트코드를 생성해주세요.

 

 

 

 

 

테스트해야 할 기능은 다음과 같습니다.

• 회원 저장
• 회원 저장시 아이디가 없으면 오류
• 회원 저장시 이름이 없으면 오류
• 회원 저장시 닉네임이 없으면 오류
• 회원 저장시 나이가 없으면 오류
• 회원 저장시 중복된 아이디가 있으면 오류
• 회원 수정
• 회원 삭제
• existsByUsername이 잘 작동하는지
• username으로 회원 찾기 기능이 잘 작동하는지
• 가입 시 생성시간이 잘 등록되었는지

(회원 가입시 권한을 USER로 설정하는 부분은 이후 Service 로직에서 진행하겠습니다.)

 

 

 

 

 

 

이제 코드를 작성해보겠습니다.

 

 

 

 

기본적인 테스트코드의 구조는 다음과 같습니다.

import boardexample.myboard.domain.member.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;

import javax.persistence.EntityManager;

import java.util.Optional;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
@Transactional
class MemberRepositoryTest {

    @Autowired MemberRepository memberRepository;
    @Autowired EntityManager em;
    
    @AfterEach
    private void after(){
        em.clear();
    }
}

이제 테스트를 하나씩 작성해보도록 하겠습니다.

 

 

 

 

 

 

 

 

회원저장 성공

@Test
public void 회원저장_성공() throws Exception {
    //given
    Member member = Member.builder().username("username").password("1234567890").name("Member1").nickName("NickName1").role(Role.USER).age(22).build();

    //when
    Member saveMember = memberRepository.save(member);

    //then
    Member findMember = memberRepository.findById(saveMember.getId()).orElseThrow(() -> new RuntimeException("저장된 회원이 없습니다"));//아직 예외 클래스를 만들지 않았기에 RuntimeException으로 처리하겠습니다.

    assertThat(findMember).isSameAs(saveMember);
    assertThat(findMember).isSameAs(member);
}

 

 

 

 

 

 

 

 

 

아이디 없이 회원가입시 오류

@Test
public void 오류_회원가입시_아이디가_없음() throws Exception {
    //given
    Member member = Member.builder().password("1234567890").name("Member1").nickName("NickName1").role(Role.USER).age(22).build();

    //when, then
    assertThrows(Exception.class, () -> memberRepository.save(member));
}

 

 

 

 

 

 

 

 

 

이름 없이 회원가입시 오류

@Test
public void 오류_회원가입시_이름이_없음() throws Exception {
    //given
    Member member = Member.builder().username("username").password("1234567890").nickName("NickName1").role(Role.USER).age(22).build();


    //when, then
    assertThrows(Exception.class, () -> memberRepository.save(member));
}

 

 

 

 

 

 

 

 

 

닉네임 없이 회원가입시 오류

@Test
public void 오류_회원가입시_닉네임이_없음() throws Exception {
    //given
    Member member = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).age(22).build();

    //when, then
    assertThrows(Exception.class, () -> memberRepository.save(member));
}

 

 

 

 

 

 

 

 

나이가 없이 회원가입시 오류

@Test
public void 오류_회원가입시_나이가_없음() throws Exception {
    //given
    Member member = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").build();

    //when, then
    assertThrows(Exception.class, () -> memberRepository.save(member));
}

 

 

 

 

 

 

 

 

 

회원가입시 중복된 아이디가 있으면 오류

    @Test
    public void 오류_회원가입시_중복된_아이디가_있음() throws Exception {
        //given
        Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        Member member2 = Member.builder().username("username").password("1111111111").name("Member2").role(Role.USER).nickName("NickName2").age(22).build();
       

        memberRepository.save(member1);
        clear();

        //when, then
        assertThrows(Exception.class, () -> memberRepository.save(member2));

    }

 

 

 

 

 

 

 

 

 

회원수정

    @Test
    public void 성공_회원수정() throws Exception {
        //given
        Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();

        String updatePassword = "updatePassword";
        String updateName = "updateName";
        String updateNickName = "updateNickName";
        int updateAge = 33;

        BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();

        //when
        Member findMember = memberRepository.findById(member1.getId()).orElseThrow(() -> new Exception());
        findMember.updateAge(updateAge);
        findMember.updateName(updateName);
        findMember.updateNickName(updateNickName);
        findMember.updatePassword(passwordEncoder,updatePassword);
        em.flush();

        //then
        Member findUpdateMember = memberRepository.findById(findMember.getId()).orElseThrow(() -> new Exception());

        assertThat(findUpdateMember).isSameAs(findMember);
        assertThat(passwordEncoder.matches(updatePassword, findUpdateMember.getPassword())).isTrue();
        assertThat(findUpdateMember.getName()).isEqualTo(updateName);
        assertThat(findUpdateMember.getName()).isNotEqualTo(member1.getName());
    }

 

 

 

 

 

 

 

 

 

회원삭제

@Test
public void 성공_회원삭제() throws Exception {
    //given
    Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
    memberRepository.save(member1);
    clear();

    //when
    memberRepository.delete(member1);
    clear();

    //then
    assertThrows(Exception.class, () -> memberRepository.findById(member1.getId()).orElseThrow(() -> new Exception()));
}

 

 

 

 

 

 

 

 

 

existByUsername 정상작동 테스트

@Test
public void existByUsername_정상작동() throws Exception {
    //given
    String username = "username";
    Member member1 = Member.builder().username(username).password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
    memberRepository.save(member1);
    clear();

    //when, then
    assertThat(memberRepository.existsByUsername(username)).isTrue();
    assertThat(memberRepository.existsByUsername(username+"123")).isFalse();

}

 

 

 

 

 

 

 

 

 

findByUsername 정상작동 테스트

    @Test
    public void findByUsername_정상작동() throws Exception {
        //given
        String username = "username";
        Member member1 = Member.builder().username(username).password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();


        //when, then
        assertThat(memberRepository.findByUsername(username).get().getUsername()).isEqualTo(member1.getUsername());
        assertThat(memberRepository.findByUsername(username).get().getName()).isEqualTo(member1.getName());
        assertThat(memberRepository.findByUsername(username).get().getId()).isEqualTo(member1.getId());
        assertThrows(Exception.class,
                () -> memberRepository.findByUsername(username+"123")
                        .orElseThrow(() -> new Exception()));

    }

 

 

 

 

 

 

 

 

 

회원가입 시 생성시간 등록

@Test
public void 회원가입시_생성시간_등록() throws Exception {
    //given
    Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
    memberRepository.save(member1);
    clear();

    //when
    Member findMember = memberRepository.findById(member1.getId()).orElseThrow(() -> new Exception());

    //then
    assertThat(findMember.getCreatedDate()).isNotNull();
    assertThat(findMember.getLastModifiedDate()).isNotNull();

}

 

 

 

 

 

 

 

 

 

이렇게 테스트를 모두 끝내보았습니다.

테스트의 전체 코드는 아래와 같습니다.

package boardexample.myboard.domain.member.repository;

import boardexample.myboard.domain.member.Member;
import boardexample.myboard.domain.member.Role;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.DelegatingPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.transaction.annotation.Transactional;

import javax.persistence.EntityManager;

import java.util.Optional;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
@Transactional
class MemberRepositoryTest {


    @Autowired MemberRepository memberRepository;
    @Autowired EntityManager em;



    private void clear(){
        em.flush();
        em.clear();
    }

    @AfterEach
    private void after(){
        em.clear();
    }

    @Test
    public void 회원저장_성공() throws Exception {
        //given
        Member member = Member.builder().username("username").password("1234567890").name("Member1").nickName("NickName1").role(Role.USER).age(22).build();

        //when
        Member saveMember = memberRepository.save(member);

        //then
        Member findMember = memberRepository.findById(saveMember.getId()).orElseThrow(() -> new RuntimeException("저장된 회원이 없습니다"));//아직 예외 클래스를 만들지 않았기에 RuntimeException으로 처리하겠습니다.

        assertThat(findMember).isSameAs(saveMember);
        assertThat(findMember).isSameAs(member);
    }

    @Test
    public void 오류_회원가입시_아이디가_없음() throws Exception {
        //given
        Member member = Member.builder().password("1234567890").name("Member1").nickName("NickName1").role(Role.USER).age(22).build();

        //when, then
        assertThrows(Exception.class, () -> memberRepository.save(member));
    }

    @Test
    public void 오류_회원가입시_이름이_없음() throws Exception {
        //given
        Member member = Member.builder().username("username").password("1234567890").nickName("NickName1").role(Role.USER).age(22).build();

        //when, then
        assertThrows(Exception.class, () -> memberRepository.save(member));
    }

    @Test
    public void 오류_회원가입시_닉네임이_없음() throws Exception {
        //given
        Member member = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).age(22).build();

        //when, then
        assertThrows(Exception.class, () -> memberRepository.save(member));
    }

    @Test
    public void 오류_회원가입시_나이가_없음() throws Exception {
        //given
        Member member = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").build();

        //when, then
        assertThrows(Exception.class, () -> memberRepository.save(member));
    }

    @Test
    public void 오류_회원가입시_중복된_아이디가_있음() throws Exception {
        //given
        Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        Member member2 = Member.builder().username("username").password("1111111111").name("Member2").role(Role.USER).nickName("NickName2").age(22).build();

        memberRepository.save(member1);
        clear();

        //when, then
        assertThrows(Exception.class, () -> memberRepository.save(member2));

    }

    @Test
    public void 성공_회원수정() throws Exception {
        //given
        Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();

        String updatePassword = "updatePassword";
        String updateName = "updateName";
        String updateNickName = "updateNickName";
        int updateAge = 33;

        BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();

        //when
        Member findMember = memberRepository.findById(member1.getId()).orElseThrow(() -> new Exception());
        findMember.updateAge(updateAge);
        findMember.updateName(updateName);
        findMember.updateNickName(updateNickName);
        findMember.updatePassword(passwordEncoder,updatePassword);
        em.flush();

        //then
        Member findUpdateMember = memberRepository.findById(findMember.getId()).orElseThrow(() -> new Exception());

        assertThat(findUpdateMember).isSameAs(findMember);
        assertThat(passwordEncoder.matches(updatePassword, findUpdateMember.getPassword())).isTrue();
        assertThat(findUpdateMember.getName()).isEqualTo(updateName);
        assertThat(findUpdateMember.getName()).isNotEqualTo(member1.getName());
    }

    @Test
    public void 성공_회원삭제() throws Exception {
        //given
        Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();

        //when
        memberRepository.delete(member1);
        clear();

        //then
        assertThrows(Exception.class,
                () -> memberRepository.findById(member1.getId())
                        .orElseThrow(() -> new Exception()));
    }


    @Test
    public void existByUsername_정상작동() throws Exception {
        //given
        String username = "username";
        Member member1 = Member.builder().username(username).password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();

        //when, then
        assertThat(memberRepository.existsByUsername(username)).isTrue();
        assertThat(memberRepository.existsByUsername(username+"123")).isFalse();

    }


    @Test
    public void findByUsername_정상작동() throws Exception {
        //given
        String username = "username";
        Member member1 = Member.builder().username(username).password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();


        //when, then
        assertThat(memberRepository.findByUsername(username).get().getUsername()).isEqualTo(member1.getUsername());
        assertThat(memberRepository.findByUsername(username).get().getName()).isEqualTo(member1.getName());
        assertThat(memberRepository.findByUsername(username).get().getId()).isEqualTo(member1.getId());
        assertThrows(Exception.class,
                () -> memberRepository.findByUsername(username+"123")
                        .orElseThrow(() -> new Exception()));

    }

    @Test
    public void 회원가입시_생성시간_등록() throws Exception {
        //given
        Member member1 = Member.builder().username("username").password("1234567890").name("Member1").role(Role.USER).nickName("NickName1").age(22).build();
        memberRepository.save(member1);
        clear();

        //when
        Member findMember = memberRepository.findById(member1.getId()).orElseThrow(() -> new Exception());

        //then
        assertThat(findMember.getCreatedDate()).isNotNull();
        assertThat(findMember.getLastModifiedDate()).isNotNull();

    }


}

 

 

 

 

 

 

다음에는 회원가입과 로그인을 진행해보도록 하겠습니다.

전체 코드는 깃허브에서 확인하실 수 있습니다.

 

https://github.com/ShinDongHun1/SpringBoot-Board-API

GitHub - ShinDongHun1/SpringBoot-Board-API

 

 

 

 

 

 

 

 

 

 

 

📔 Reference

패키지 구조 참고

패키지 구조는 어떻게 짜는 게 맞을까?

 

지속 가능한 소프트웨어 설계 패턴: 포트와 어댑터 아키텍처 적용하기 - LINE ENGINEERING

 

 

 

게시판 참고

스프링부트 게시판 API 서버 만들기 (1) - 프로젝트 생성