MessageSource support for Spring MVC and WebFlux exceptions

See gh-28814

Author: rstoyanchev

spring-web/src/main/java/org/springframework/web/ErrorResponse.java

@@ -16,9 +16,13 @@
 
 package org.springframework.web;
 
+import java.util.Locale;
+
+import org.springframework.context.MessageSource;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatusCode;
 import org.springframework.http.ProblemDetail;
+import org.springframework.lang.Nullable;
 
 
 /**
@@ -59,4 +63,48 @@ default HttpHeaders getHeaders() {
 	 */
 	ProblemDetail getBody();
 
+	/**
+	 * Return a code to use to resolve the problem "detail" for this exception
+	 * through a {@link org.springframework.context.MessageSource}.
+	 * <p>By default this is initialized via
+	 * {@link #getDefaultDetailMessageCode(Class, String)} but each exception
+	 * overrides this to provide relevant data that that can be expanded into
+	 * placeholders within the message.
+	 */
+	default String getDetailMessageCode() {
+		return getDefaultDetailMessageCode(getClass(), null);
+	}
+
+	/**
+	 * Return the arguments to use to resolve the problem "detail" through a
+	 * {@link MessageSource}.
+	 */
+	@Nullable
+	default Object[] getDetailMessageArguments() {
+		return null;
+	}
+
+	/**
+	 * Variant of {@link #getDetailMessageArguments()} that uses the given
+	 * {@link MessageSource} to resolve the message arguments.
+	 * <p>By default this delegates to {@link #getDetailMessageArguments()}
+	 * by concrete implementations may override it, for example in order to
+	 * resolve validation errors through a {@code MessageSource}.
+	 */
+	@Nullable
+	default Object[] getDetailMessageArguments(MessageSource messageSource, Locale locale) {
+		return getDetailMessageArguments();
+	}
+
+	/**
+	 * Build a message code for the given exception type, which consists of
+	 * {@code "problemDetail."} followed by the full {@link Class#getName() class name}.
+	 * @param exceptionType the exception type for which to build a code
+	 * @param suffix an optional suffix, e.g. for exceptions that may have multiple
+	 * error message with different arguments.
+	 */
+	static String getDefaultDetailMessageCode(Class<?> exceptionType, @Nullable String suffix) {
+		return "problemDetail." + exceptionType.getName() + (suffix != null ? "." + suffix : "");
+	}
+
 }

spring-web/src/main/java/org/springframework/web/ErrorResponseException.java

@@ -46,6 +46,11 @@ public class ErrorResponseException extends NestedRuntimeException implements Er
 
 	private final ProblemDetail body;
 
+	private final String messageDetailCode;
+
+	@Nullable
+	private final Object[] messageDetailArguments;
+
 
 	/**
 	 * Constructor with a {@link HttpStatusCode}.
@@ -66,11 +71,32 @@ public ErrorResponseException(HttpStatusCode status, @Nullable Throwable cause)
 	 * subclass of {@code ProblemDetail} with extended fields.
 	 */
 	public ErrorResponseException(HttpStatusCode status, ProblemDetail body, @Nullable Throwable cause) {
+		this(status, body, cause, null, null);
+	}
+
+	/**
+	 * Constructor with a given {@link ProblemDetail}, and a
+	 * {@link org.springframework.context.MessageSource} code and arguments to
+	 * resolve the detail message with.
+	 * @since 6.0
+	 */
+	protected ErrorResponseException(
+			HttpStatusCode status, ProblemDetail body, @Nullable Throwable cause,
+			@Nullable String messageDetailCode, @Nullable Object[] messageDetailArguments) {
+
 		super(null, cause);
 		this.status = status;
 		this.body = body;
+		this.messageDetailCode = initMessageDetailCode(messageDetailCode);
+		this.messageDetailArguments = messageDetailArguments;
+	}
+
+	private String initMessageDetailCode(@Nullable String messageDetailCode) {
+		return (messageDetailCode != null ?
+				messageDetailCode : ErrorResponse.getDefaultDetailMessageCode(getClass(), null));
 	}
 
+
 	@Override
 	public HttpStatusCode getStatusCode() {
 		return this.status;
@@ -133,6 +159,16 @@ public final ProblemDetail getBody() {
 		return this.body;
 	}
 
+	@Override
+	public String getDetailMessageCode() {
+		return this.messageDetailCode;
+	}
+
+	@Override
+	public Object[] getDetailMessageArguments() {
+		return this.messageDetailArguments;
+	}
+
 	@Override
 	public String getMessage() {
 		return this.status + (!this.headers.isEmpty() ? ", headers=" + this.headers : "") + ", " + this.body;

spring-web/src/main/java/org/springframework/web/HttpMediaTypeException.java

@@ -23,6 +23,7 @@
 
 import org.springframework.http.MediaType;
 import org.springframework.http.ProblemDetail;
+import org.springframework.lang.Nullable;
 
 /**
  * Abstract base for exceptions related to media types. Adds a list of supported {@link MediaType MediaTypes}.
@@ -37,23 +38,49 @@ public abstract class HttpMediaTypeException extends ServletException implements
 
 	private final ProblemDetail body = ProblemDetail.forStatus(getStatusCode());
 
+	private final String messageDetailCode;
+
+	@Nullable
+	private final Object[] messageDetailArguments;
+
 
 	/**
 	 * Create a new HttpMediaTypeException.
 	 * @param message the exception message
+	 * @deprecated as of 6.0
 	 */
+	@Deprecated
 	protected HttpMediaTypeException(String message) {
-		super(message);
-		this.supportedMediaTypes = Collections.emptyList();
+		this(message, Collections.emptyList());
 	}
 
 	/**
 	 * Create a new HttpMediaTypeException with a list of supported media types.
 	 * @param supportedMediaTypes the list of supported media types
+	 * @deprecated as of 6.0
 	 */
+	@Deprecated
 	protected HttpMediaTypeException(String message, List<MediaType> supportedMediaTypes) {
+		this(message, supportedMediaTypes, null, null);
+	}
+
+	/**
+	 * Create a new HttpMediaTypeException with a list of supported media types.
+	 * @param supportedMediaTypes the list of supported media types
+	 * @param messageDetailCode the code to use to resolve the problem "detail"
+	 * through a {@link org.springframework.context.MessageSource}
+	 * @param messageDetailArguments the arguments to make available when
+	 * resolving the problem "detail" through a {@code MessageSource}
+	 * @since 6.0
+	 */
+	protected HttpMediaTypeException(String message, List<MediaType> supportedMediaTypes,
+			@Nullable String messageDetailCode, @Nullable Object[] messageDetailArguments) {
+
 		super(message);
 		this.supportedMediaTypes = Collections.unmodifiableList(supportedMediaTypes);
+		this.messageDetailCode = (messageDetailCode != null ?
+				messageDetailCode : ErrorResponse.getDefaultDetailMessageCode(getClass(), null));
+		this.messageDetailArguments = messageDetailArguments;
 	}
 
 
@@ -69,4 +96,14 @@ public ProblemDetail getBody() {
 		return this.body;
 	}
 
+	@Override
+	public String getDetailMessageCode() {
+		return this.messageDetailCode;
+	}
+
+	@Override
+	public Object[] getDetailMessageArguments() {
+		return this.messageDetailArguments;
+	}
+
 }

spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotAcceptableException.java

@@ -16,8 +16,8 @@
 
 package org.springframework.web;
 
+import java.util.Collections;
 import java.util.List;
-import java.util.stream.Collectors;
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
@@ -35,12 +35,16 @@
 @SuppressWarnings("serial")
 public class HttpMediaTypeNotAcceptableException extends HttpMediaTypeException {
 
+	private static final String PARSE_ERROR_DETAIL_CODE =
+			ErrorResponse.getDefaultDetailMessageCode(HttpMediaTypeNotAcceptableException.class, "parseError");
+
+
 	/**
 	 * Constructor for when the {@code Accept} header cannot be parsed.
 	 * @param message the parse error message
 	 */
 	public HttpMediaTypeNotAcceptableException(String message) {
-		super(message);
+		super(message, Collections.emptyList(), PARSE_ERROR_DETAIL_CODE, null);
 		getBody().setDetail("Could not parse Accept header.");
 	}
 
@@ -49,9 +53,8 @@ public HttpMediaTypeNotAcceptableException(String message) {
 	 * @param mediaTypes the list of supported media types
 	 */
 	public HttpMediaTypeNotAcceptableException(List<MediaType> mediaTypes) {
-		super("No acceptable representation", mediaTypes);
-		getBody().setDetail("Acceptable representations: " +
-				mediaTypes.stream().map(MediaType::toString).collect(Collectors.joining(", ", "'", "'")) + ".");
+		super("No acceptable representation", mediaTypes, null, new Object[] {mediaTypes});
+		getBody().setDetail("Acceptable representations: " + mediaTypes + ".");
 	}
 
 

spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotSupportedException.java

@@ -16,6 +16,7 @@
 
 package org.springframework.web;
 
+import java.util.Collections;
 import java.util.List;
 
 import org.springframework.http.HttpHeaders;
@@ -37,6 +38,10 @@
 @SuppressWarnings("serial")
 public class HttpMediaTypeNotSupportedException extends HttpMediaTypeException {
 
+	private static final String PARSE_ERROR_DETAIL_CODE =
+			ErrorResponse.getDefaultDetailMessageCode(HttpMediaTypeNotSupportedException.class, "parseError");
+
+
 	@Nullable
 	private final MediaType contentType;
 
@@ -49,7 +54,7 @@ public class HttpMediaTypeNotSupportedException extends HttpMediaTypeException {
 	 * @param message the exception message
 	 */
 	public HttpMediaTypeNotSupportedException(String message) {
-		super(message);
+		super(message, Collections.emptyList(), PARSE_ERROR_DETAIL_CODE, null);
 		this.contentType = null;
 		this.httpMethod = null;
 		getBody().setDetail("Could not parse Content-Type.");
@@ -89,7 +94,7 @@ public HttpMediaTypeNotSupportedException(
 	public HttpMediaTypeNotSupportedException(@Nullable MediaType contentType,
 			List<MediaType> supportedMediaTypes, @Nullable HttpMethod httpMethod, String message) {
 
-		super(message, supportedMediaTypes);
+		super(message, supportedMediaTypes, null, new Object[] {contentType, supportedMediaTypes});
 		this.contentType = contentType;
 		this.httpMethod = httpMethod;
 		getBody().setDetail("Content-Type '" + this.contentType + "' is not supported.");

spring-web/src/main/java/org/springframework/web/HttpRequestMethodNotSupportedException.java

@@ -52,7 +52,9 @@ public class HttpRequestMethodNotSupportedException extends ServletException imp
 	/**
 	 * Create a new HttpRequestMethodNotSupportedException.
 	 * @param method the unsupported HTTP request method
+	 * @deprecated 6.0 in favor of {@link #HttpRequestMethodNotSupportedException(String, Collection)}
 	 */
+	@Deprecated(since = "6.0", forRemoval = true)
 	public HttpRequestMethodNotSupportedException(String method) {
 		this(method, (String[]) null);
 	}
@@ -61,15 +63,17 @@ public HttpRequestMethodNotSupportedException(String method) {
 	 * Create a new HttpRequestMethodNotSupportedException.
 	 * @param method the unsupported HTTP request method
 	 * @param msg the detail message
+	 * @deprecated in favor of {@link #HttpRequestMethodNotSupportedException(String, Collection)}
 	 */
+	@Deprecated(since = "6.0", forRemoval = true)
 	public HttpRequestMethodNotSupportedException(String method, String msg) {
 		this(method, null, msg);
 	}
 
 	/**
 	 * Create a new HttpRequestMethodNotSupportedException.
 	 * @param method the unsupported HTTP request method
-	 * @param supportedMethods the actually supported HTTP methods (may be {@code null})
+	 * @param supportedMethods the actually supported HTTP methods (possibly {@code null})
 	 */
 	public HttpRequestMethodNotSupportedException(String method, @Nullable Collection<String> supportedMethods) {
 		this(method, (supportedMethods != null ? StringUtils.toStringArray(supportedMethods) : null));
@@ -78,8 +82,10 @@ public HttpRequestMethodNotSupportedException(String method, @Nullable Collectio
 	/**
 	 * Create a new HttpRequestMethodNotSupportedException.
 	 * @param method the unsupported HTTP request method
-	 * @param supportedMethods the actually supported HTTP methods (may be {@code null})
+	 * @param supportedMethods the actually supported HTTP methods (possibly {@code null})
+	 * @deprecated in favor of {@link #HttpRequestMethodNotSupportedException(String, Collection)}
 	 */
+	@Deprecated(since = "6.0", forRemoval = true)
 	public HttpRequestMethodNotSupportedException(String method, @Nullable String[] supportedMethods) {
 		this(method, supportedMethods, "Request method '" + method + "' is not supported");
 	}
@@ -89,7 +95,9 @@ public HttpRequestMethodNotSupportedException(String method, @Nullable String[]
 	 * @param method the unsupported HTTP request method
 	 * @param supportedMethods the actually supported HTTP methods
 	 * @param msg the detail message
+	 * @deprecated in favor of {@link #HttpRequestMethodNotSupportedException(String, Collection)}
 	 */
+	@Deprecated(since = "6.0", forRemoval = true)
 	public HttpRequestMethodNotSupportedException(String method, @Nullable String[] supportedMethods, String msg) {
 		super(msg);
 		this.method = method;
@@ -153,4 +161,9 @@ public ProblemDetail getBody() {
 		return this.body;
 	}
 
+	@Override
+	public Object[] getDetailMessageArguments() {
+		return new Object[] {getMethod(), getSupportedHttpMethods()};
+	}
+
 }