간단한 Spring Boot Restful API Sample Project 만들어보기 #2. 회원가입 구현하기

 

 

https://hyejin.tistory.com/1295

간단한 Spring Boot Restful API Sample Project 만들어보기 #1. Spring Security 설정 + CustomFilter 만들기

-> 이번 글은 회원 가입 로직을 구현하는 글로, 시큐리티 설정 관련 부분은 밑에 링크 클릭해서 확인 가능합니다 :) 

 

 

😀 : 생각해보면 스프링 시큐리티 설정 및 로그인 구현하기 전에 회원가입 로직을 만들었어야 한다.. 아놔 

회원 가입을 해야 회원 정보 저장하고, 로그인하니까..! 어찌보면 당연한건데 나는 스프링 설정할 생각뿐이었다 ㅋㅋㅋㅋ 하나에 꽂히면 이렇게 된다.;;; 암튼 그래서 이제서야 회원 가입 관련 글을 작성한다.. 

 

 

Member 

@Getter
@Entity
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Member extends BaseEntity
{
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String email; // email을 id로 사용할 것임!
    private String password;
    private String name;
    
    @Enumerated(EnumType.STRING)
    private MemberLevel memberLevel;
    
    @Enumerated(EnumType.STRING)
    private MemberStatus memberStatus;
    
    @Builder
    public Member(String email, String password, String name, MemberLevel memberLevel, MemberStatus memberStatus)
    {
       this.email = email;
       this.password = password;
       this.name = name;
       this.memberLevel = memberLevel;
       this.memberStatus = memberStatus;
    }
}

-> Member 는 엔티티로 id, email, password, name 기본 정보와 memberLevel, memberStatus 값을 enum 으로 갖는다. 

memberLevel 은 우선 생각으론 관리자냐, 사용자냐 를 구분할 것이고, 

memberStatus 에는 사용중인지, 사용 중지된 사용자인지 구분할 것이다. 

 

 

MemberLevel 

@Getter
@RequiredArgsConstructor
public enum MemberLevel
{
    USER("일반 사용자"),
    ADMIN("관리자");
    
    private final String text;

}

 

 

MemberStatus 

@Getter
@RequiredArgsConstructor
public enum MemberStatus
{
    USE("사용 중"),
    HOLD("중지");
    
    private final String text;
}

 

 

BaseEntity 

@Getter
@MappedSuperclass // 공통 맵핑 정보가 필요할 때 사용, 부모 클래스에서 선언하고 속성만 상속받고 싶을 때 사용
@EntityListeners(AutoCloseable.class) // JPA Entity에 이벤트 발생할 때 관련 코드 실행
public abstract class BaseEntity
{
    @CreatedDate // 생성 일자를 관리하는 필드, 현재 날짜 주입
    @Column(updatable = false) // 생성일자에 대한 필드이기 때문에 수정 불가하도록 설정
    private LocalDateTime registerDate;
    
    @LastModifiedDate // 조회한 Entity 값 변경할 때 시간 자동 저장
    private LocalDateTime modifiedDate;
}

-> 그리고 BaseEntity이다. BaseEntity는 추상클래스로 만들고, 이를 상속받은 엔티티들에 대한 등록일과 수정일을 추가한다. Member는 가입하면 가입일, 수정하면 수정일을 같이 저장해주는 게 좋을 것 같아서 추가했다. 

이때 등록일은 생성일자에 대한 필드니까 수정 불가하게 만들었다. 

 

 

AuthController

@Slf4j
@RestController
@RequestMapping("/auth")
@RequiredArgsConstructor
public class AuthController
{
    private final AuthService authService;
    
    @PostMapping("/signUp")
    public ApiResponse<SignResponse> signUp(@RequestBody SignUpCreateRequest request)
    {
       return ApiResponse.ok(authService.signUp(request));
    }
}

-> /auth/signUp post 요청으로 아이디와 비밀번호를 request body에 담아 호출하면, 회원 가입 후 정해진 ApiResponse에 맞게 리턴해준다. 

 

 

SignUpCreateRequest

@Getter
@Setter
@NoArgsConstructor
public class SignUpCreateRequest
{
    private String email;
    private String password;
    private String name;
    
    private MemberLevel memberLevel;
    
    private MemberStatus memberStatus;
    
    @Builder
    public SignUpCreateRequest(String email, String password, String name)
    {
       this.email = email;
       this.password = password;
       this.name = name;
       this.memberLevel = USER;
       this.memberStatus = USE;
    }
    
    public static Member toEntity(SignUpCreateRequest request)
    {
       return Member.builder()
             .name(request.getName())
             .email(request.getEmail())
             .password(request.getPassword())
             .memberLevel(USER)
             .memberStatus(USE)
             .build();
    }
}

-> 회원 가입할 땐, email, password, name 등을 받는다고 생각하고, 
MemberLevel, MemberStatus는 생성할 때 자동으로 USER, USE로 지정된다. 

 

 

ApiResponse

@Getter
public class ApiResponse<T>
{
    private int code;
    private HttpStatus status;
    private String message;
    private T data;
    
    public ApiResponse(HttpStatus status, String message, T data)
    {
       this.code = status.value();
       this.status = status;
       this.message = message;
       this.data = data;
    }
    
    public static <T> ApiResponse<T> of(HttpStatus status, String message, T data)
    {
       return new ApiResponse<>(status, message, data);
    }
    
    public static <T> ApiResponse<T> of(HttpStatus status, T data)
    {
       return of(status, status.name(), data);
    }
    
    public static <T> ApiResponse<T> ok(T data)
    {
       return of(HttpStatus.OK, data);
    }
    
}

-> 내가 만든 Restful api response 형식을 만들었다. 

code에는 상태값, status에는 응답 상태, message에는 응답 메시지, data에 이제 리턴된 값을 받을 것이다. 

 

 

AuthService

@Slf4j
@Service
@RequiredArgsConstructor
public class AuthService
{
    private final MemberRepository memberRepository;
    
    private final PasswordEncoder passwordEncoder;
    
    public SignResponse signUp(SignUpCreateRequest request)
    {
       Optional<Member> byEmail = memberRepository.findByEmail(request.getEmail());
       
       if (byEmail.isPresent()) {
          throw new AlreadyExistsException();
       }
       
       String rawPassword = request.getPassword();
       String encryptedPassword = passwordEncoder.encode(rawPassword);
       request.setPassword(encryptedPassword);
       
       Member member = SignUpCreateRequest.toEntity(request);
       
       Member saveMember = memberRepository.save(member);
       return new SignResponse(saveMember.getEmail());
    }
}

-> 회원 가입 서비스 로직이다. 
먼저 request에서 받은 email 정보를 가지고 MemberRepository에서 해당 email을 가진 회원이 있는지 조회하고, 만약 있다면 예외를 던진다. (중복 이메일 안됨!) 

 

이제 이메일이 중복되지 않는다면 받은 비밀번호를 암호화해서 db에 저장한다. 

그리고 return할 때는 email 정보만 리턴해준다. 

 

 

BaseException 

@Getter
public abstract class BaseException extends RuntimeException
{
    public BaseException(String message)
    {
       super(message);
    }
    
    public BaseException(String message, Throwable cause)
    {
       super(message, cause);
    }
    
    public abstract HttpStatus getStatus();
}

-> BaseException는 RuntimeException을 상속받은 추상 클래스로 커스텀한 예외를 만들기 위한 클래스라고 할 수 있다. 

 

AlreadyExistsException 

public class AlreadyExistsException extends BaseException
{
    private static final String MESSAGE = "이미 가입된 이메일입니다.";
    
    public AlreadyExistsException()
    {
       super(MESSAGE);
    }
    
    @Override
    public HttpStatus getStatus()
    {
       return null;
    }
}

-> 그리고 BaseException 을 상속받아서 이미 가입된 이메일에 대한 예외를 커스텀해서 만들어줬다. 

 

 

SignResponse 

@Getter
@Setter
public class SignResponse
{
    private String email;
    
    public SignResponse(String email)
    {
       this.email = email;
    }
}

-> 간단하게 우선 회원가입 후 리턴하는 vo에는 email만 담긴다. (여기는 수정될지, 이건 아직 보류) 

 

 

 

MemberRepository

@Repository
public interface MemberRepository extends JpaRepository<Member, Long>
{
    Optional<Member> findByEmail(String email);
}

-> JpaRepository를 상속받아 만들고, email을 통해 회원 정보를 조회할 수 있게 추가했다. 

 

 

 

회원 가입은 간단하다..! 

샘플  프로젝트니까 우선 이렇게 만들었고, 만든 회원 가입이 정상 동작하는지 확인해보면 

### 회원 가입
POST http://localhost:8080/auth/signUp
Content-Type: application/json

{
  "name" : "test",
  "email" : "test@gmail.com",
  "password": "1231"
}

 

 

이렇게 우리가 지정한 apiResponse에 맞게 응답이 내려온다. 😊

 

 

 

👩‍💻 : 회원 가입은 우선 간단하게 이런식으로 만들었다 ! 

이제 이 다음에는 jwt 를 이용해서 인증 처리하는 방법을 구현해볼 예정이다.