Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Expose MethodParameter in MissingServletRequestParameterException

Browse Source 
See gh-26219
This commit is contained in:
rstoyanchev
2023-06-13 10:52:48 +01:00
parent 6b50b7b72a
commit 1e3161b161
2 changed files with 49 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
spring-web/src/main/java/org/springframework/web/bind/MissingServletRequestParameterException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,6 +16,9 @@
package org.springframework.web.bind;
import org.springframework.core.MethodParameter;
import org.springframework.lang.Nullable;
/**
* {@link ServletRequestBindingException} subclass that indicates a missing parameter.
*
@@ -29,6 +32,9 @@ public class MissingServletRequestParameterException extends MissingRequestValue
private final String parameterType;
@Nullable
private final MethodParameter parameter;
/**
* Constructor for MissingServletRequestParameterException.
@@ -36,7 +42,28 @@ public class MissingServletRequestParameterException extends MissingRequestValue
* @param parameterType the expected type of the missing parameter
*/
public MissingServletRequestParameterException(String parameterName, String parameterType) {
this(parameterName, parameterType, false);
super("", false, null, new Object[] {parameterName});
this.parameterName = parameterName;
this.parameterType = parameterType;
this.parameter = null;
getBody().setDetail(initBodyDetail(this.parameterName));
}
/**
* Constructor with a {@link MethodParameter} instead of a String parameterType.
* @param parameterName the name of the missing parameter
* @param parameter the target method parameter for the missing value
* @param missingAfterConversion whether the value became null after conversion
* @since 6.1
*/
public MissingServletRequestParameterException(
String parameterName, MethodParameter parameter, boolean missingAfterConversion) {
super("", missingAfterConversion, null, new Object[] {parameterName});
this.parameterName = parameterName;
this.parameterType = parameter.getNestedParameterType().getSimpleName();
this.parameter = parameter;
getBody().setDetail(initBodyDetail(this.parameterName));
}
/**
@@ -45,14 +72,21 @@ public class MissingServletRequestParameterException extends MissingRequestValue
* @param parameterType the expected type of the missing parameter
* @param missingAfterConversion whether the value became null after conversion
* @since 5.3.6
* @deprecated in favor of {@link #MissingServletRequestParameterException(String, MethodParameter, boolean)}
*/
@Deprecated(since = "6.1", forRemoval = true)
public MissingServletRequestParameterException(
String parameterName, String parameterType, boolean missingAfterConversion) {
super("", missingAfterConversion, null, new Object[] {parameterName});
this.parameterName = parameterName;
this.parameterType = parameterType;
getBody().setDetail("Required parameter '" + this.parameterName + "' is not present.");
this.parameter = null;
getBody().setDetail(initBodyDetail(this.parameterName));
}
private static String initBodyDetail(String name) {
return "Required parameter '" + name + "' is not present.";
}
@@ -77,4 +111,14 @@ public class MissingServletRequestParameterException extends MissingRequestValue
return this.parameterType;
}
/**
* Return the target {@link MethodParameter} if the exception was raised for
* a controller method argument.
* @since 6.1
*/
@Nullable
public MethodParameter getMethodParameter() {
return this.parameter;
}
}

5
spring-web/src/main/java/org/springframework/web/method/annotation/RequestParamMethodArgumentResolver.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -214,8 +214,7 @@ public class RequestParamMethodArgumentResolver extends AbstractNamedValueMethod
}
}
else {
throw new MissingServletRequestParameterException(name,
parameter.getNestedParameterType().getSimpleName(), missingAfterConversion);
throw new MissingServletRequestParameterException(name, parameter, missingAfterConversion);
}
}