스프링부트 게시판 API 만들기 (12) - 예외 발생시 HTTP 상태코드 변경, 테스트코드 변경 등, 코드 수정

 

 

 

이번 글에서는 새로운 기능을 작성하기 전에, 기존 코드를 바꾸는 시간을 갖겠습니다.

지금까지 예외가 발생해도 항상 상태코드를 200으로 발생시켰었는데, 이를 다시 예외 케이스에 맞게 상태코드를 반환해보려 합니다.

그렇게 중요한 부분은 아니기에 건너뛰셔도 됩니다. 단지 이후 저와 코드가 일부 다를 수 있으니, 그부분만 주의해주시면 됩니당.

 

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

 

 

 

 

 

 

 

 

 

 

 

MemberExceptionType 코드 수정

원래는 모든 상황에서 HttpStatus.OK를 지정해 주었는데 이를 아래와 같이 바꾸었습니다.

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

 

 

 

 

 

 

 

 

 

 

LoginFailureHandler 코드 수정

@Slf4j
public class LoginFailureHandler extends SimpleUrlAuthenticationFailureHandler {

    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {
        //response.setStatus(HttpServletResponse.SC_OK);//TODO: 에러코드 변경 SC
        response.setStatus(HttpServletResponse.SC_BAD_REQUEST);//

        response.getWriter().write("fail");
        log.info("로그인에 실패했습니다");
    }
}

주석 처리된 부분에서, 그 아래 코드로 바꾸었습니다.

 

 

 

 

 

 

 

 

 

ExceptionAdvice 코드 수정

@RestControllerAdvice
@Slf4j
public class ExceptionAdvice {


    //HttpMessageNotReadableException  => json 파싱 오류

    @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());
    }



    
    //@Valid 에서 예외 발생
    @ExceptionHandler(BindException.class)
    public ResponseEntity handleValidEx(BindException exception){

        log.error("@ValidException 발생! {}", exception.getMessage() );
        return new ResponseEntity(new ExceptionDto(2000),HttpStatus.BAD_REQUEST);
    }

    //HttpMessageNotReadableException  => json 파싱 오류
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity httpMessageNotReadableExceptionEx(HttpMessageNotReadableException exception){

        log.error("Json을 파싱하는 과정에서 예외 발생! {}", exception.getMessage() );
        return new ResponseEntity(new ExceptionDto(3000),HttpStatus.BAD_REQUEST);
    }


    @ExceptionHandler(Exception.class)
    public ResponseEntity handleMemberEx(Exception exception) {

        exception.printStackTrace();
        return new ResponseEntity(HttpStatus.BAD_REQUEST);
    }


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

 

회원가입 시, 필드를 입력하지 않아 생기는 오류와,  JSON 파싱 과정에서 생기는 오류들의 상태코드를 400으로 바꾸어 주었습니다.

 

 

이제 바뀐 상태 코드에 따라 작동하지 않는 테스트코드를 수정하겠습니다.

 

 

 

 

 

 

 

 

 

LoginTest 변경

변경된 테스트코드는 다음과 같습니다.

@Test
public void 로그인_실패_아이디틀림() throws Exception {
    //given
    Map<String, String> map = new HashMap<>();
    map.put("username",USERNAME+"123");
    map.put("password",PASSWORD);


    //when
    MvcResult result = mockMvc.perform(MockMvcRequestBuilders
                    .post(LOGIN_RUL)
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(objectMapper.writeValueAsString(map)))
            .andDo(print())
            //.andExpect(status().isOk())//TODO 상테코드변경
            .andExpect(status().isBadRequest())
            .andReturn();


    //then
    assertThat(result.getResponse().getHeader(accessHeader)).isNull();
    assertThat(result.getResponse().getHeader(refreshHeader)).isNull();

}

 

 

 

 

 

 

@Test
public void 로그인_실패_비밀번호틀림() throws Exception {
    //given
    Map<String, String> map = new HashMap<>();
    map.put("username",USERNAME);
    map.put("password",PASSWORD+"123");


    //when
    MvcResult result = mockMvc.perform(MockMvcRequestBuilders
                    .post(LOGIN_RUL)
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(objectMapper.writeValueAsString(map)))
            .andDo(print())
            //.andExpect(status().isOk())//TODO 상태코드변경
            .andExpect(status().isBadRequest())
            .andReturn();


    //then
    assertThat(result.getResponse().getHeader(accessHeader)).isNull();
    assertThat(result.getResponse().getHeader(refreshHeader)).isNull();

}

 

 

 

 

 

 

// 로그인_데이터형식_JSON이_아니면_200
@Test
public void 로그인_데이터형식_JSON이_아니면_400() throws Exception {

    //given
    Map<String, String> map = new HashMap<>();
    map.put("username",USERNAME);
    map.put("password",PASSWORD);


    //when
    MvcResult result = mockMvc.perform(MockMvcRequestBuilders
                    .post(LOGIN_RUL)
                    .contentType(MediaType.APPLICATION_FORM_URLENCODED)
                    .content(objectMapper.writeValueAsString(map)))
            .andDo(print())
            //.andExpect(status().isOk())  TODO 상태코드변겅
            .andExpect(status().isBadRequest())
            .andReturn();

    //then
    assertThat(result.getResponse().getContentAsString()).isEqualTo(LOGIN_FAIL_MESSAGE);
}

 

 

 

 

 

 

 

 

 

 

 

 

 

JwtFilterAuthenticationTest 변경

@Test
public void 로그인_주소로_보내면_필터작동_X() throws Exception {
    //given
    Map accessAndRefreshToken = getAccessAndRefreshToken();
    String accessToken= (String) accessAndRefreshToken.get(accessHeader);
    String refreshToken= (String) accessAndRefreshToken.get(refreshHeader);

    //when, then
    MvcResult result = mockMvc.perform(post(LOGIN_RUL)  //get인 경우 config에서 permitAll을 했기에 notFound
                    .header(refreshHeader, BEARER + refreshToken)
                    .header(accessHeader, BEARER + accessToken))
            //.andExpect(status().isOk())  TODO : 테스트코드수정
            .andExpect(status().isBadRequest())
            .andReturn();

    assertThat(result.getResponse().getContentAsString()).isEqualTo(LOGIN_FAIL_MESSAGE);

}

 

 

 

 

 

 

 

 

 

 

 

MemberControllerTest 변경

    @Test
    public void 비밀번호수정_실패_검증비밀번호가_틀림() throws Exception {
        //given
        String signUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, nickName, age));
        signUp(signUpData);

        String accessToken = getAccessToken();

        Map<String, Object> map = new HashMap<>();
        map.put("checkPassword",password+"1");
        map.put("toBePassword",password+"!@#@!#@!#");

        String updatePassword = objectMapper.writeValueAsString(map);


        //when
        mockMvc.perform(
                        put("/member/password")
                                .header(accessHeader,BEARER+accessToken)
                                .contentType(MediaType.APPLICATION_JSON)
                                .content(updatePassword))
                //.andExpect(status().isOk());//TODO 테스트코드 수정
                .andExpect(status().isBadRequest());//TODO 테스트코드 수정

        //then
        Member member = memberRepository.findByUsername(username).orElseThrow(() -> new Exception("회원이 없습니다"));
        assertThat(passwordEncoder.matches(password, member.getPassword())).isTrue();
        assertThat(passwordEncoder.matches(password+"!@#@!#@!#", member.getPassword())).isFalse();
    }

 

 

 

 

 

 

@Test
public void 회원탈퇴_실패_비밀번호틀림() throws Exception {
    //given
    String signUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, nickName, age));
    signUp(signUpData);

    String accessToken = getAccessToken();

    Map<String, Object> map = new HashMap<>();
    map.put("checkPassword",password+11);

    String updatePassword = objectMapper.writeValueAsString(map);

    //when
    mockMvc.perform(
                    delete("/member")
                            .header(accessHeader,BEARER+accessToken)
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(updatePassword))
            //.andExpect(status().isOk()); //TODO 테스트코드 수정
            .andExpect(status().isBadRequest()); 

    //then
    Member member = memberRepository.findByUsername(username).orElseThrow(() -> new Exception("회원이 없습니다"));
    assertThat(member).isNotNull();


}

 

 

 

 

 

 

@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();//TODO: 테스트코드 수정 ok에서 변겅
            .andExpect(status().isNotFound()).andReturn();

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

 

 

 

 

 

 

 

    @Test
    public void 회원가입_실패_필드가_없음() throws Exception {
        //given
        String noUsernameSignUpData = objectMapper.writeValueAsString(new MemberSignUpDto(null, password, name, nickName, age));
        String noPasswordSignUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, null, name, nickName, age));
        String noNameSignUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, null, nickName, age));
        String noNickNameSignUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, null, age));
        String noAgeSignUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, nickName, null));

        //when, then
/*        signUp(noUsernameSignUpData);//예외가 발생하더라도 상태코드는 200
        signUp(noPasswordSignUpData);//예외가 발생하더라도 상태코드는 200
        signUp(noNameSignUpData);//예외가 발생하더라도 상태코드는 200
        signUp(noNickNameSignUpData);//예외가 발생하더라도 상태코드는 200
        signUp(noAgeSignUpData);//예외가 발생하더라도 상태코드는 200*/

        signUpFail(noUsernameSignUpData);//예외가 발생하면 상태코드는 400
        signUpFail(noPasswordSignUpData);//예외가 발생하면 상태코드는 400
        signUpFail(noNameSignUpData);//예외가 발생하면 상태코드는 400
        signUpFail(noNickNameSignUpData);//예외가 발생하면 상태코드는 400
        signUpFail(noAgeSignUpData);//예외가 발생하면 상태코드는 400

        assertThat(memberRepository.findAll().size()).isEqualTo(0);
    }

signUpFail은 다음과 같습니다.

private void signUpFail(String signUpData) throws Exception {
    mockMvc.perform(
                    post(SIGN_UP_URL)
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(signUpData))
            .andExpect(status().isBadRequest());
}

 

 

 

 

 

 

 

 

 

 

@Test
public void 비밀번호수정_실패_바꾸려는_비밀번호_형식_올바르지않음() throws Exception {
    //given
    String signUpData = objectMapper.writeValueAsString(new MemberSignUpDto(username, password, name, nickName, age));
    signUp(signUpData);

    String accessToken = getAccessToken();

    Map<String, Object> map = new HashMap<>();
    map.put("checkPassword",password);
    map.put("toBePassword","123123");

    String updatePassword = objectMapper.writeValueAsString(map);


    //when
    mockMvc.perform(
                    put("/member/password")
                            .header(accessHeader,BEARER+accessToken)
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(updatePassword))
            //.andExpect(status().isOk());
            .andExpect(status().isBadRequest());

    //then
    Member member = memberRepository.findByUsername(username).orElseThrow(() -> new Exception("회원이 없습니다"));
    assertThat(passwordEncoder.matches(password, member.getPassword())).isTrue();
    assertThat(passwordEncoder.matches("123123", member.getPassword())).isFalse();
}

 

 

 

 

 

네 이렇게 해서 코드 수정이 끝났습니다.

이제 다음 시간에는 Post Service와, 파일을 저장하는 File Service를 만들어 보도록 하겠습니다.

 

 

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

 

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

GitHub - ShinDongHun1/SpringBoot-Board-API

 

 

 

 

 

 

 

 

이상하거나 오류가 나는 부분이 있다면 댓글로 알려주시면 감사하겠습니다.

광고도 한번씩 눌러주시면 감사하겠습니다  :)