Merge pull request #19901 from nosan

* pr/19901:
  Polish contribution
  Handle message of @ResponseStatus-annotated exception with WebFlux

Closes gh-19901
pull/20429/head
Stephane Nicoll 5 years ago
commit 29fb2a3fd2

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2019 the original author or authors. * Copyright 2012-2020 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -24,6 +24,7 @@ import java.util.Map;
import org.springframework.core.annotation.AnnotatedElementUtils; import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatus;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindingResult; import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError; import org.springframework.validation.ObjectError;
import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.bind.annotation.ResponseStatus;
@ -80,39 +81,37 @@ public class DefaultErrorAttributes implements ErrorAttributes {
errorAttributes.put("timestamp", new Date()); errorAttributes.put("timestamp", new Date());
errorAttributes.put("path", request.path()); errorAttributes.put("path", request.path());
Throwable error = getError(request); Throwable error = getError(request);
HttpStatus errorStatus = determineHttpStatus(error); ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(error.getClass(),
ResponseStatus.class);
HttpStatus errorStatus = determineHttpStatus(error, responseStatus);
errorAttributes.put("status", errorStatus.value()); errorAttributes.put("status", errorStatus.value());
errorAttributes.put("error", errorStatus.getReasonPhrase()); errorAttributes.put("error", errorStatus.getReasonPhrase());
errorAttributes.put("message", determineMessage(error)); errorAttributes.put("message", determineMessage(error, responseStatus));
handleException(errorAttributes, determineException(error), includeStackTrace); handleException(errorAttributes, determineException(error), includeStackTrace);
return errorAttributes; return errorAttributes;
} }
private HttpStatus determineHttpStatus(Throwable error) { private HttpStatus determineHttpStatus(Throwable error, ResponseStatus responseStatus) {
if (error instanceof ResponseStatusException) { if (error instanceof ResponseStatusException) {
return ((ResponseStatusException) error).getStatus(); return ((ResponseStatusException) error).getStatus();
} }
ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(error.getClass(),
ResponseStatus.class);
if (responseStatus != null) { if (responseStatus != null) {
return responseStatus.code(); return responseStatus.code();
} }
return HttpStatus.INTERNAL_SERVER_ERROR; return HttpStatus.INTERNAL_SERVER_ERROR;
} }
private String determineMessage(Throwable error) { private String determineMessage(Throwable error, ResponseStatus responseStatus) {
if (error instanceof WebExchangeBindException) { if (error instanceof WebExchangeBindException) {
return error.getMessage(); return error.getMessage();
} }
if (error instanceof ResponseStatusException) { if (error instanceof ResponseStatusException) {
return ((ResponseStatusException) error).getReason(); return ((ResponseStatusException) error).getReason();
} }
ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(error.getClass(), if (responseStatus != null && StringUtils.hasText(responseStatus.reason())) {
ResponseStatus.class);
if (responseStatus != null) {
return responseStatus.reason(); return responseStatus.reason();
} }
return error.getMessage(); return (error.getMessage() != null) ? error.getMessage() : "";
} }
private Throwable determineException(Throwable error) { private Throwable determineException(Throwable error) {

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2019 the original author or authors. * Copyright 2012-2020 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -89,6 +89,18 @@ public class DefaultErrorAttributesTests {
Map<String, Object> attributes = this.errorAttributes.getErrorAttributes(buildServerRequest(request, error), Map<String, Object> attributes = this.errorAttributes.getErrorAttributes(buildServerRequest(request, error),
false); false);
assertThat(attributes.get("error")).isEqualTo(HttpStatus.I_AM_A_TEAPOT.getReasonPhrase()); assertThat(attributes.get("error")).isEqualTo(HttpStatus.I_AM_A_TEAPOT.getReasonPhrase());
assertThat(attributes.get("message")).isEqualTo("");
assertThat(attributes.get("status")).isEqualTo(HttpStatus.I_AM_A_TEAPOT.value());
}
@Test
public void annotatedResponseStatusCodeWithExceptionMessage() {
Exception error = new CustomException("Test Message");
MockServerHttpRequest request = MockServerHttpRequest.get("/test").build();
Map<String, Object> attributes = this.errorAttributes.getErrorAttributes(buildServerRequest(request, error),
false);
assertThat(attributes.get("error")).isEqualTo(HttpStatus.I_AM_A_TEAPOT.getReasonPhrase());
assertThat(attributes.get("message")).isEqualTo("Test Message");
assertThat(attributes.get("status")).isEqualTo(HttpStatus.I_AM_A_TEAPOT.value()); assertThat(attributes.get("status")).isEqualTo(HttpStatus.I_AM_A_TEAPOT.value());
} }
@ -218,6 +230,13 @@ public class DefaultErrorAttributesTests {
@ResponseStatus(HttpStatus.I_AM_A_TEAPOT) @ResponseStatus(HttpStatus.I_AM_A_TEAPOT)
private static class CustomException extends RuntimeException { private static class CustomException extends RuntimeException {
CustomException() {
}
CustomException(String message) {
super(message);
}
} }
@ResponseStatus(value = HttpStatus.I_AM_A_TEAPOT, reason = "Nope!") @ResponseStatus(value = HttpStatus.I_AM_A_TEAPOT, reason = "Nope!")

Loading…
Cancel
Save