스프링부트 게시판 API 만들기 (11) - 회원 예외처리, 공통 예외처리 클래스 만들기 (@ControllerAdvice, @ExceptionHandler 이용)

 

 

 

 

 

이번에는 회원 서비스에서 발생할 수 있는 예외들을 MemberException으로 모아, 공통으로 예외처리를 해주도록 하겠습니다.

예외처리는 @ControllerAdvice를 통해, 한곳에서 예외를 관리해주도록 하겠습니다.

 

 

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

 

 

 

 

 

 

 

 

 

 

 

BaseException

위치는 다음과 같습니다.

 

BaseException은 앞으로 정의할 모든 커스텀 예외의 부모 클래스로, 앞으로 생성할 커스텀 예외 클래스들을 BaseException 타입으로 처리할 수 있도록 하기 위해서 만들어주었습니다.

 

 

public abstract class BaseException extends RuntimeException{
    public abstract BaseExceptionType getExceptionType();
}

RuntimeException을 상속받은 추상 클래스로 설정해주었습니다.

BaseException은 BaseExceptionType을 반환하는 getExceptionType 메서드를 가지고 있습니다. 이는 이후 Enum으로 설정하여 에러 메세지와 Http 상태코드, 그리고 저희만의 에러코드를 설정해주어 관리해주도록 하겠습니다.

 

 

 

 

 

 

 

 

BaseExceptionType

public interface BaseExceptionType {
    int getErrorCode();

    HttpStatus getHttpStatus();

    String getErrorMessage();
}

에러코드와 Http상태, 그리고 에러 메세지를 가지고 있도록 만들어 주기 위해 다음과 같이 getter 메서드를 설정했습니다.

 

이제 Member에 대한 예외처리를 해보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

MemberException

위치는 다음과 같습니다.

public class MemberException extends BaseException {
    private BaseExceptionType exceptionType;


    public MemberException(BaseExceptionType exceptionType) {
        this.exceptionType = exceptionType;
    }

    @Override
    public BaseExceptionType getExceptionType() {
        return exceptionType;
    }
}

코드는 별거 없습니다.

BaseExceptionType을 멤버변수로 가지고 있으며, 생성자를 통해 생성하는 순간 ExceptionType을 설정하도록 만들어 주었습니다.

 

 

 

 

 

 

 

 

 

 

 

MemberExceptionType

public enum MemberExceptionType implements BaseExceptionType {
    //== 회원가입, 로그인 시 ==//
    ALREADY_EXIST_USERNAME(600, HttpStatus.OK, "이미 존재하는 아이디입니다."),
    WRONG_PASSWORD(601,HttpStatus.OK, "비밀번호가 잘못되었습니다."),
    NOT_FOUND_MEMBER(602, HttpStatus.OK, "회원 정보가 없습니다.");


    private int errorCode;
    private HttpStatus httpStatus;
    private String errorMessage;

    MemberExceptionType(int errorCode, HttpStatus httpStatus, String errorMessage) {
        this.errorCode = errorCode;
        this.httpStatus = httpStatus;
        this.errorMessage = errorMessage;
    }

    @Override
    public int getErrorCode() {
        return this.errorCode;
    }

    @Override
    public HttpStatus getHttpStatus() {
        return this.httpStatus;
    }

    @Override
    public String getErrorMessage() {
        return this.errorMessage;
    }
}

enum으로 생성해 주었습니다.

아직은 오류가 3종류밖에 없지만, 이후 더 추가될수도 있습니다.

 

에러코드와 Http 상태코드, 그리고 에러 메세지가 존재합니다.

그러나 저희는 Http 상태코드는 200으로 통일할 것이기에 Http.OK로 통일시켜 주었습니다.

그러면 굳이 넣어주지 않아도 200으로 처리하면 되는거 아니냐 하실 수도 있는데,

혹시 언제 제가 마음이 바뀌어서 상태코드를 따르게 처리할지 모르기 때문에, 변경에 대비하기 위해 넣어주었습니다.

 

 

이제 MemberException은 설정되었고 이를 코드에 적용시켜보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

MemberServiceImpl 변경

Exception을 발생시키는 예외를 모두 MemberException으로 변경해 주었습니다.

@Service
@RequiredArgsConstructor
@Transactional
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;
    private final PasswordEncoder passwordEncoder;



    @Override
    public void signUp(MemberSignUpDto memberSignUpDto) throws Exception {
        Member member = memberSignUpDto.toEntity();
        member.addUserAuthority();
        member.encodePassword(passwordEncoder);

        if(memberRepository.findByUsername(memberSignUpDto.username()).isPresent()){
            throw new MemberException(MemberExceptionType.ALREADY_EXIST_USERNAME);
        }

        memberRepository.save(member);
    }

    @Override
    public void update(MemberUpdateDto memberUpdateDto) throws Exception {
        Member member = memberRepository.findByUsername(SecurityUtil.getLoginUsername()).orElseThrow(() -> new MemberException(MemberExceptionType.NOT_FOUND_MEMBER));

        memberUpdateDto.age().ifPresent(member::updateAge);
        memberUpdateDto.name().ifPresent(member::updateName);
        memberUpdateDto.nickName().ifPresent(member::updateNickName);
    }


    @Override
    public void updatePassword(String checkPassword, String toBePassword) throws Exception {
        Member member = memberRepository.findByUsername(SecurityUtil.getLoginUsername()).orElseThrow(() -> new MemberException(MemberExceptionType.NOT_FOUND_MEMBER));

        if(!member.matchPassword(passwordEncoder, checkPassword) ) {
            throw new MemberException(MemberExceptionType.WRONG_PASSWORD);
        }

        member.updatePassword(passwordEncoder, toBePassword);
    }


    @Override
    public void withdraw(String checkPassword) throws Exception {
        Member member = memberRepository.findByUsername(SecurityUtil.getLoginUsername()).orElseThrow(() -> new MemberException(MemberExceptionType.NOT_FOUND_MEMBER));

        if(!member.matchPassword(passwordEncoder, checkPassword) ) {
            throw new MemberException(MemberExceptionType.WRONG_PASSWORD);
        }

        memberRepository.delete(member);
    }




    @Override
    public MemberInfoDto getInfo(Long id) throws Exception {
        Member findMember = memberRepository.findById(id).orElseThrow(() -> new MemberException(MemberExceptionType.NOT_FOUND_MEMBER));
        return new MemberInfoDto(findMember);
    }

    @Override
    public MemberInfoDto getMyInfo() throws Exception {
        Member findMember = memberRepository.findByUsername(SecurityUtil.getLoginUsername()).orElseThrow(() -> new MemberException(MemberExceptionType.NOT_FOUND_MEMBER));
        return new MemberInfoDto(findMember);
    }
}

 

 

 

 

 

 

 

 

 

 

 

ExceptionAdvice 변경

마지막입니다. 컨트롤러에서 발생한 MemberException을 포함해서, 이후 발생할 커스텀 예외들을 처리해줄 수 있도록 ExceptionAdvice를 변경해 주겠습니다.

 

 

@RestControllerAdvice
@Slf4j
public class ExceptionAdvice {


    @ExceptionHandler(BaseException.class)
    public ResponseEntity handleBaseEx(BaseException exception){
        log.error("BaseException errorMessage(): {}",exception.getExceptionType().getErrorMessage());
        log.error("BaseException errorCode(): {}",exception.getExceptionType().getErrorCode());

        return new ResponseEntity(new ExceptionDto(exception.getExceptionType().getErrorCode()),exception.getExceptionType().getHttpStatus());
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity handleMemberEx(Exception exception){
        exception.printStackTrace();
        return new ResponseEntity(HttpStatus.OK);
    }


    @Data
    @AllArgsConstructor
    static class ExceptionDto {
        private Integer errorCode;
    }
}

(서버에서 예외가 발생하더라도, 상태코드는 200을 반환하도록 설정했습니다.)

 

 

 

 

 

 

 

 

 

 

 

테스트코드 수정

현재 MemberException을 설정해 줌으로써, 고장난 테스트코드들을 고쳐주도록 하겠습니다.

 

참고로 아직 접근 권한이 없는 페이지에 접근했을 때와 없는 페이지에 제공했을 때는 403, 404를 발생시킵니다.

원래는 이도 다 200으로 처리하려 했으나, 대부분의 사이트에서 없는 주소로 접근했을 경우 200을 뿌리는 경우는 보지 못하였습니다.

따라서 이는 403, 404 그대로 처리하도록 냅두도록 하겠습니다.

 

 

 

 

MemberControllerTest 수정

@Test
public void 회원정보조회_실패_없는회원조회() throws Exception {
    //given
    String signUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, nickName, age));
    signUp(signUpData);

    String accessToken = getAccessToken();


    //when
    MvcResult result = mockMvc.perform(
                    get("/member/2211")
                            .characterEncoding(StandardCharsets.UTF_8)
                            .header(accessHeader, BEARER + accessToken))
            .andExpect(status().isOk()).andReturn();

    //then TODO: 여기 오류남, 상태코드 600 반환함, 고치기
    assertThat(result.getResponse().getContentAsString()).isEqualTo("");//빈 문자열
}

다음 테스트에서 오류가 발생합니다.

 

 

 

이를 다음과 같이 변경해줍니다.

@Test
public void 회원정보조회_실패_없는회원조회() throws Exception {
    //given
    String signUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, nickName, age));
    signUp(signUpData);

    String accessToken = getAccessToken();


    //when
    MvcResult result = mockMvc.perform(
                    get("/member/2211")
                            .characterEncoding(StandardCharsets.UTF_8)
                            .header(accessHeader, BEARER + accessToken))
            .andExpect(status().isOk()).andReturn();

    //then
    Map<String, Integer> map = objectMapper.readValue(result.getResponse().getContentAsString(), Map.class);
    assertThat(map.get("errorCode")).isEqualTo(MemberExceptionType.NOT_FOUND_MEMBER.getErrorCode());//빈 문자열
}

 

 

 

 

 

 

 

 

 

 

 

MemberServiceTest 변경

@Test
public void 회원가입_성공() throws Exception {
    //given
    MemberSignUpDto memberSignUpDto = makeMemberSignUpDto();

    //when
    memberService.signUp(memberSignUpDto);
    clear();

    //then  TODO : 여기 MEMBEREXCEPTION으로 고치기
    Member member = memberRepository.findByUsername(memberSignUpDto.username()).orElseThrow(() -> new Exception("회원이 없습니다"));
    assertThat(member.getId()).isNotNull();
    assertThat(member.getUsername()).isEqualTo(memberSignUpDto.username());
    assertThat(member.getName()).isEqualTo(memberSignUpDto.name());
    assertThat(member.getNickName()).isEqualTo(memberSignUpDto.nickName());
    assertThat(member.getAge()).isEqualTo(memberSignUpDto.age());
    assertThat(member.getRole()).isSameAs(Role.USER);

}

위의 메서드를 변경해주도록 하겠습니다

 

 

 

 

아래와 같이 바꾸어줍니다.

@Test
public void 회원가입_성공() throws Exception {
    //given
    MemberSignUpDto memberSignUpDto = makeMemberSignUpDto();

    //when
    memberService.signUp(memberSignUpDto);
    clear();

    //then
    Member member = memberRepository.findByUsername(memberSignUpDto.username()).orElseThrow(() -> new MemberException(MemberExceptionType.NOT_FOUND_MEMBER));
    assertThat(member.getId()).isNotNull();
    assertThat(member.getUsername()).isEqualTo(memberSignUpDto.username());
    assertThat(member.getName()).isEqualTo(memberSignUpDto.name());
    assertThat(member.getNickName()).isEqualTo(memberSignUpDto.nickName());
    assertThat(member.getAge()).isEqualTo(memberSignUpDto.age());
    assertThat(member.getRole()).isSameAs(Role.USER);

}

 

 

 

 

 

 

 

 

 

 

 

다음 메서드도 바꿔주도록 하겠습니다.

@Test
public void 회원탈퇴_실패_비밀번호가_일치하지않음() throws Exception {
    //given
    MemberSignUpDto memberSignUpDto = setMember();

    //when, then TODO : MemberException으로 고쳐야 함
    assertThat(assertThrows(Exception.class ,() -> memberService.withdraw(PASSWORD+"1")).getMessage()).isEqualTo("비밀번호가 일치하지 않습니다.");

}

 

 

 

 

 

 

아래와 같이 바꾸어줍니다.

@Test
public void 회원탈퇴_실패_비밀번호가_일치하지않음() throws Exception {
    //given
    MemberSignUpDto memberSignUpDto = setMember();

    //when, then
    assertThat(assertThrows(MemberException.class ,() -> memberService.withdraw(PASSWORD+"1")).getExceptionType()).isEqualTo(MemberExceptionType.WRONG_PASSWORD);

}

 

 

 

 

 

 

 

 

 

 

 

 

마지막입니다

@Test
public void 회원가입_실패_원인_아이디중복() throws Exception {
    //given
    MemberSignUpDto memberSignUpDto = makeMemberSignUpDto();
    memberService.signUp(memberSignUpDto);
    clear();

    //when, then TODO : MemberException으로 고쳐야 함
    assertThat(assertThrows(Exception.class, () -> memberService.signUp(memberSignUpDto)).getMessage()).isEqualTo("이미 존재하는 아이디입니다.");

}

 

 

 

 

 

 

아래와 같이 바꾸어줍니다

@Test
public void 회원가입_실패_원인_아이디중복() throws Exception {
    //given
    MemberSignUpDto memberSignUpDto = makeMemberSignUpDto();
    memberService.signUp(memberSignUpDto);
    clear();

    //when, then
    assertThat(assertThrows(MemberException.class, () -> memberService.signUp(memberSignUpDto)).getExceptionType()).isEqualTo(MemberExceptionType.ALREADY_EXIST_USERNAME);

}

 

 

 

 

 

 

 

이렇게 해서 예외처리까지 다루어보았습니다. 

다음 시간에는 Member 엔티티에 이어서 Post와 Comment에 대한 서비스 로직을 작성하도록 하겠습니다.

감사합니다

 

 

 

 

 

 

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

 

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

GitHub - ShinDongHun1/SpringBoot-Board-API