spring boot rest api 의 success response, error response 를 표준화 해보자
Summary
“REST API 가 책임져야 하는 것” 에 대하여 좋은 글을 읽어볼 수 있었다.
해당 포스트와 직접적인 연관은 없지만 아래 글을 읽고 REST api 의 response 가 어떤 책임을 수행해야 하는 지 좀 더 명확히 할 수 있었다
rest api 의 response 가 책임져야 하는 것
spring 에서 성공 실패 응답을 표준화 하기 위해 필요했던 두 가지
성공 혹은 실패 응답을 담기 위한 POJO 클래스
참고한 POJO 클래스는 다음 포스트에서 제공한 POJO 와 거의 동일하다. 조만간 필요 시 statusCode 등을 추가하여 변경할 예정이다.
How to standardize spring boot api response
성공 혹은 실패 시 이를 controller 단에서 최종적으로 응답하기 전에 처리해주기 위한 ControllerAdvice
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
@ControllerAdvice
public class GlobalResponseHandler extends ResponseEntityExceptionHandler implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return true;
}
@Override
public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType,
Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
ServerHttpResponse response) {
if (methodParameter.getContainingClass().isAnnotationPresent(RestController.class)) {
if (!Objects.requireNonNull(methodParameter.getMethod()).isAnnotationPresent(IgnoreResponseBinding.class)) {
if ((!(o instanceof ErrorResponse)) && (!(o instanceof SuccessResponse))) {
SuccessResponse<Object> responseBody = new SuccessResponse<>(o);
return responseBody;
}
}
}
return o;
}
// handleHttpMediaTypeNotSupported : triggers when the JSON is invalid
@Override
protected ResponseEntity<Object> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex,
HttpHeaders headers, HttpStatusCode status, WebRequest request) {
List<String> details = new ArrayList<String>();
StringBuilder builder = new StringBuilder();
builder.append(ex.getContentType());
builder.append(" media type is not supported. Supported media types are ");
ex.getSupportedMediaTypes().forEach(t -> builder.append(t).append(", "));
details.add(builder.toString());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Invalid JSON", details);
return ResponseEntityBuilder.build(err);
}
// handleHttpMessageNotReadable : triggers when the JSON is malformed
@Override
protected ResponseEntity<Object> handleHttpMessageNotReadable(HttpMessageNotReadableException ex,
HttpHeaders headers, HttpStatusCode status, WebRequest request) {
List<String> details = new ArrayList<String>();
details.add(ex.getMessage());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Malformed JSON request",
details);
return ResponseEntityBuilder.build(err);
}
// handleMethodArgumentNotValid : triggers when @Valid fails
@Override
protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
HttpHeaders headers, HttpStatusCode status, WebRequest request) {
List<String> details = new ArrayList<String>();
details = ex.getBindingResult()
.getFieldErrors()
.stream()
.map(error -> error.getObjectName() + " : " + error.getDefaultMessage())
.collect(Collectors.toList());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Validation Errors",
details);
return ResponseEntityBuilder.build(err);
}
// handleMissingServletRequestParameter : triggers when there are missing parameters
@Override
protected ResponseEntity<Object> handleMissingServletRequestParameter(MissingServletRequestParameterException ex,
HttpHeaders headers, HttpStatusCode status, WebRequest request) {
List<String> details = new ArrayList<String>();
details.add(ex.getParameterName() + " parameter is missing");
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Missing Parameters",
details);
return ResponseEntityBuilder.build(err);
}
// handleMethodArgumentTypeMismatch : triggers when a parameter's type does not match
@ExceptionHandler(MethodArgumentTypeMismatchException.class)
protected ResponseEntity<Object> handleMethodArgumentTypeMismatch(MethodArgumentTypeMismatchException ex,
WebRequest request) {
List<String> details = new ArrayList<String>();
details.add(ex.getMessage());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Mismatch Type", details);
return ResponseEntityBuilder.build(err);
}
// handleConstraintViolationException : triggers when @Validated fails
@ExceptionHandler(ConstraintViolationException.class)
public ResponseEntity<?> handleConstraintViolationException(Exception ex, WebRequest request) {
List<String> details = new ArrayList<String>();
details.add(ex.getMessage());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Constraint Violation",
details);
return ResponseEntityBuilder.build(err);
}
// handleResourceNotFoundException : triggers when there is no resource with the specified ID in BDD
@ExceptionHandler(ResourceNotFoundException.class)
public ResponseEntity<Object> handleResourceNotFoundException(ResourceNotFoundException ex) {
List<String> details = new ArrayList<String>();
details.add(ex.getMessage());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.NOT_FOUND, "Resource Not Found", details);
return ResponseEntityBuilder.build(err);
}
// handleNoHandlerFoundException : triggers when the handler method is invalid
@Override
protected ResponseEntity<Object> handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers,
HttpStatusCode status, WebRequest request) {
List<String> details = new ArrayList<String>();
details.add(String.format("Could not find the %s method for URL %s", ex.getHttpMethod(), ex.getRequestURL()));
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Method Not Found", details);
return ResponseEntityBuilder.build(err);
}
@ExceptionHandler({Exception.class})
public ResponseEntity<Object> handleAll(Exception ex, WebRequest request) {
List<String> details = new ArrayList<String>();
details.add(ex.getLocalizedMessage());
ErrorResponse err = new ErrorResponse(LocalDateTime.now(), HttpStatus.BAD_REQUEST, "Error occurred", details);
return ResponseEntityBuilder.build(err);
}
}
Never miss a story from us, subscribe to our newsletter