[구현] Spring에서 에러를 내는 3가지 방법

에러를.. 내봅시다

프로젝트에서 에러를 낼 때 내가 사용하는 방법은 총 세 가지이다.

1. ResponseEntity 사용
2. Custom 예외 클래스 만들기
3. ControllerAdvice 사용하기

개인적으로 아주 간단한 프로젝트가 아니라면 3번을 추천한다.

하나씩 봐보자면,

 

1. ResponseEntity 사용

설명할 게 없을 정도로 매우 간단한 것이 장점이다.

단점은 코드가 지저분해진다는 점이다.

new ResponseEntity<>({보낼 데이터}, HttpStatus.{status});

이 한 줄만 리턴하면 된다.

하지만 예외처리할 게 여러개가 되면 너무 복잡해진다.

    @PostMapping("/users/login")
    public ResponseEntity<HashMap> socialLogin(@RequestBody UserDto.LoginDto loginDto) {

        HashMap<String, Object> responseMap = new HashMap<>();
        User user = userService.signIn(loginDto.getSocialType(), loginDto.getSocialToken());

        if (loginDto.getSocialType().equals("kakao")) {
            if (user == null) {
                responseMap.put("status", 404);
                responseMap.put("message", "회원 정보 없음");
                return new ResponseEntity<>(responseMap, HttpStatus.NOT_FOUND);
            }

            responseMap.put("status", 200);
            responseMap.put("message", "로그인 성공");
            responseMap.put("data", new HashMap<String, String>() {{
                put("token", jwtTokenProvider.createToken(user.getSocialId(), user.getRoles()));
            }});
            return new ResponseEntity<>(responseMap, HttpStatus.OK);
        } else {
            responseMap.put("status", 401);
            responseMap.put("message", "소셜 타입 오류");
            return new ResponseEntity<>(responseMap, HttpStatus.NOT_FOUND);
        }
        responseMap.put("status", 404);
        responseMap.put("message", "회원 정보 없음");
        return new ResponseEntity<>(responseMap, HttpStatus.NOT_FOUND);
    }

위 경우 응답은 아래 모양으로 나간다.

{
    "message": "회원 정보 없음",
    "status": 404
}

 

ResponseEntity를 전부 Service 단계에서 return 하고, 그를 그대로 Controller에서 반환하는 방법도 있긴 하지만,

코드 가독성이 별로일 것 같다.

간단하게 에러를 내야할 때 좋은 방법이다.

 

2. Custom 예외 클래스 만들기

역시 매우 간단하다.

하지만 모든 에러에 대해 전부 클래스를 만들어야 한다는 단점이 있다.

@ResponseStatus(code = HttpStatus.NOT_FOUND, reason = "해당 id에 해당하는 데이터가 없습니다.")
public class NotFoundIdException extends RuntimeException{ }

이런 클래스를 하나 만들어서 필요할 때 Throw 해주면 된다.

{
  "timestamp": "2023-04-02T13:13:11.287+00:00",
  "status": 400,
  "error": "Bad Request",
  "trace": "{trace}",
  "message": "잘못된 쿼리 파라미터 값 입니다.",
  "path": "/api/dresses/search"
}

이런 형식의 데이터가 전송된다.

3. ControllerAdvice 사용하기

가장 추천하는 방법이다.

깔끔하고, 많은 에러를 많은 클래스를 만들지 않고도 해결할 수 있다.

@RequiredArgsConstructor
@Getter
public enum ErrorResponseStatus {

    BAD_REQUEST_WRONG_TAG_EXCEPTION(HttpStatus.BAD_REQUEST, "잘못된 태그"),
    
    UNAUTHORIZED_WRONG_SOCIAL_TYPE(HttpStatus.UNAUTHORIZED, "잘못된 소셜 타입"),
    UNAUTHORIZED_INVALID_SOCIAL_TOKEN(HttpStatus.UNAUTHORIZED, "잘못된 소셜 토큰"),

    NOT_FOUND_USER_EXCEPTION(HttpStatus.NOT_FOUND, "회원 정보 없음"),
    NOT_FOUND_PASSWORD_EXCEPTION(HttpStatus.NOT_FOUND, "비밀번호 불일치"),

    CONFLICT_DUPLICATED_NICKNAME(HttpStatus.CONFLICT, "중복된 닉네임");

    private final HttpStatus code;
    private final String message;
}

이런 enum 파일을 하나 생성하고,

이 enum 파일로 생성될 수 있는 Exception 파일을 생성한다.

@Getter
@AllArgsConstructor
public class CustomException extends RuntimeException {
    private final ErrorResponseStatus errorResponseStatus;
}

다음 위 Exception 파일을 handle하는 ExceptionHandler를 만들어준다.

@RestControllerAdvice 또는 @ControllerAdvice를 붙여야 Spring이 인식해서 에러를 발생시켜준다.

@RestControllerAdvice
public class ExceptionHandler extends ResponseEntityExceptionHandler{

    @org.springframework.web.bind.annotation.ExceptionHandler(value = CustomException.class)
    protected ResponseEntity<ResponseTemplate> handleCustomException(CustomException e) {
        return ResponseTemplate.toResponseEntity(e.getResponseCode());
    }
}

ResponseTemplete의 toResponseEntity 메소드를 리턴하면서 에러가 발생하는데,

toResponseEntity에서는 ErrorResponseStatus의 status와 내용을 받아와 ResponseEntity에 집어 넣어서 위 1번과 같은 방법으로 에러를 발생시키고 있다.

@Builder
@AllArgsConstructor
public class ResponseTemplate {

    public int status;

    public String message;

    private final LocalDateTime timestamp = LocalDateTime.now();

    public static ResponseEntity<ResponseTemplate> toResponseEntity(ErrorResponseStatus errorResponseStatus) {
        return ResponseEntity
                .status(errorResponseStatus.getHttpStatus())
                .body(ResponseTemplate.builder()
                        .status(errorResponseStatus.getHttpStatus().value())
                        .message(errorResponseStatus.getMessage())
                        .build()
                );
    }
}

 

위 4개의 클래스만 만들어주면 수 많은 에러를 코드를 재활용하여 발생시킬 수 있어 가장 애용하는 방법이다.

1, 2번보다는 조금 복잡하게 느껴질 수 있다는 단점은 있으니 상황에 따라 필요한 방법을 사용하면 좋을 것 같다.