Skip to content

Commit b340597

Browse files
committed
Allow @ProjectedPayload to be used on parameters.
The `@ProjectedPayload` annotation can now be used on parameters. This prepares for the upcoming removal of support for non-annotated projections. Fixes #3258 Related tickets #2937 Signed-off-by: Chris Bono <[email protected]>
1 parent 18ced24 commit b340597

File tree

3 files changed

+27
-7
lines changed

3 files changed

+27
-7
lines changed

src/main/java/org/springframework/data/web/ProjectedPayload.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,23 @@
1515
*/
1616
package org.springframework.data.web;
1717

18-
import static java.lang.annotation.ElementType.*;
19-
import static java.lang.annotation.RetentionPolicy.*;
20-
2118
import java.lang.annotation.Documented;
19+
import java.lang.annotation.ElementType;
2220
import java.lang.annotation.Retention;
21+
import java.lang.annotation.RetentionPolicy;
2322
import java.lang.annotation.Target;
2423

2524
/**
2625
* Annotation to mark projection interfaces that are supposed to be used as projection interface to bind request or
2726
* response payloads to.
2827
*
2928
* @author Oliver Gierke
29+
* @author Chris Bono
3030
* @soundtrack
3131
* @since 1.13
3232
*/
3333
@Documented
34-
@Retention(RUNTIME)
35-
@Target(TYPE)
34+
@Retention(RetentionPolicy.RUNTIME)
35+
@Target({ ElementType.TYPE, ElementType.PARAMETER })
3636
public @interface ProjectedPayload {
3737
}

src/main/java/org/springframework/data/web/ProxyingHandlerMethodArgumentResolver.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ public boolean supportsParameter(MethodParameter parameter) {
9191
}
9292

9393
// Annotated parameter (excluding multipart @ModelAttribute)
94-
if (parameter.hasParameterAnnotation(ProjectedPayload.class) ||
95-
(parameter.hasParameterAnnotation(ModelAttribute.class) && !MultipartResolutionDelegate.isMultipartArgument(parameter))) {
94+
if ((parameter.hasParameterAnnotation(ProjectedPayload.class) || parameter.hasParameterAnnotation(
95+
ModelAttribute.class)) && !MultipartResolutionDelegate.isMultipartArgument(parameter)) {
9696
return true;
9797
}
9898

src/test/java/org/springframework/data/web/ProxyingHandlerMethodArgumentResolverUnitTests.java

+20
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,22 @@ void doesNotSupportAtModelAttributeForMultipartParam() throws Exception {
9898
assertThat(resolver.supportsParameter(parameter)).isFalse();
9999
}
100100

101+
@Test // GH-3258
102+
void doesSupportAtProjectedPayload() throws Exception {
103+
104+
var parameter = getParameter("withProjectedPayload", SampleInterface.class);
105+
106+
assertThat(resolver.supportsParameter(parameter)).isTrue();
107+
}
108+
109+
@Test // GH-3258
110+
void doesNotSupportAtProjectedPayloadForMultipartParam() throws Exception {
111+
112+
var parameter = getParameter("withProjectedPayloadMultipart", MultipartFile.class);
113+
114+
assertThat(resolver.supportsParameter(parameter)).isFalse();
115+
}
116+
101117
private static MethodParameter getParameter(String methodName, Class<?> parameterType) {
102118

103119
var method = ReflectionUtils.findMethod(Controller.class, methodName, parameterType);
@@ -124,5 +140,9 @@ interface Controller {
124140
void withModelAttribute(@ModelAttribute SampleInterface param);
125141

126142
void withModelAttributeMultipart(@ModelAttribute MultipartFile file);
143+
144+
void withProjectedPayload(@ProjectedPayload SampleInterface param);
145+
146+
void withProjectedPayloadMultipart(@ProjectedPayload MultipartFile file);
127147
}
128148
}

0 commit comments

Comments
 (0)