전역 에러 처리 메시지 관리

안녕하세요. messages.properties 파일에 다음과 같이 어떤 type에 따라서 어떤 오류메세지를 반환할지를 정해줄 수 있구요

NotNull={0}은(는) 필수 입력 값 입니다.
NotBlank={0}은(는) 빈값 일 수 없습니다.
typeMismatch={0}에 잘못된 타입을 입력하셨습니다. {1} 형으로 입력해주세요.
Size={0}은 {2}부터 {1}사이의 숫자를 입력해야합니다.

GlobalExceptionHandler에 messageSource 빈을 주입 후 messages.properties에 있는 값을 읽어와서 구성할 수 있습니다. 타입오류인 경우도 아래처럼 처리가 가능합니다.

@Slf4j
@RequiredArgsConstructor
@RestControllerAdvice
public class GlobalExceptionHandler {

    private final MessageSource messageSource;

    /**
     * javax.bean validation 처리
     */
    @ExceptionHandler(value = {
            MethodArgumentNotValidException.class
    })
    public ResponseEntity<ErrorResponse> handleBadRequest(MethodArgumentNotValidException e, HttpServletRequest request) {
        StringBuilder sb = new StringBuilder();
        e.getBindingResult().getAllErrors()
                .forEach(c -> {
                    String field = ((FieldError) c).getField();
                    String errorMessage = getErrorMessage(c);
                    sb.append(errorMessage).append(" ");
                });
        String message = sb.toString();
        ErrorResponse errorResponse = ErrorResponse.of(HttpStatus.BAD_REQUEST.toString(), message);
        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                .body(errorResponse);
    }

    /**
     * 필드 TypeMismatch 오류 처리
     * @return
     */
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity<ErrorResponse> handleTypeMismatchExceptions(HttpMessageNotReadableException ex, HttpServletRequest request){

        Pattern errorFieldPattern = Pattern.compile("\\[[\"](.*?)[\"]\\]");
        Matcher errorFieldMatcher = errorFieldPattern.matcher(ex.getCause().getMessage());
        String errorField = errorFieldMatcher.find() ? errorFieldMatcher.group(1) : "FAIL";

        Pattern rightTypePattern = Pattern.compile("[`](.*?)[`]");
        Matcher rightTypeMatcher = rightTypePattern.matcher(ex.getMessage());
        String rightType = rightTypeMatcher.find() ? rightTypeMatcher.group(1) : "?";
        String errorMessage = messageSource.getMessage("typeMismatch", new Object[] {errorField, rightType}, Locale.KOREA);
        
        ErrorResponse errorResponse = ErrorResponse.of(HttpStatus.BAD_REQUEST.toString(), errorMessage);
        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                .body(errorResponse);
    }

    private String getErrorMessage(ObjectError error) {
        String[] codes = error.getCodes();
        for (String code : codes) {
            try {
                String message = messageSource.getMessage(code, error.getArguments(), Locale.KOREA);
                return message;
            } catch (NoSuchMessageException ignored) {}
        }
        return error.getDefaultMessage();
    }
    

}

안녕하세요 vnfthr 님, 인프런 AI 인턴이에요.

강의에서 보신 예시 코드는 enum을 사용하여 특정 에러에 대한 메시지를 정적으로 관리하고 계신 것 같네요. 메시지를 properties 파일로 따로 관리하는 방법은 가능합니다.

먼저, 메시지를 관리할 properties 파일을 생성합니다. 예를 들어, messages.properties 파일을 생성합니다. 그리고 해당 파일에 에러 코드와 에러 메시지를 key-value 형식으로 작성합니다. 예를 들어, “001=business Exception test”와 같이 작성하면 됩니다.

그 후, 메시지를 사용하는 곳에서는 messageSource bean을 사용하여 properties 파일에서 해당 에러 메시지를 가져오는 방식으로 구현하시면 됩니다.

예시 코드를 보여드리면 다음과 같습니다.

@Value("${file.path}")
private String filePath;

@Autowired
private MessageSource messageSource;

...

// 에러 메시지 사용 예시
String errorCode = "001";
String errorMessage = messageSource.getMessage(errorCode, null, LocaleContextHolder.getLocale());

이렇게 하시면 properties 파일에 작성된 에러 메시지를 가져와서 사용하실 수 있습니다.

참고로, messageSource는 Spring Framework에서 제공하는 기능이므로 Spring Framework를 사용하고 계시다면 해당 기능을 활용하실 수 있습니다.

위의 내용이 참고가 되었는지 확인 부탁드립니다. 추가로 궁금한 점이 있다면 언제든지 물어보세요. 감사합니다!