Skip to content

Commit 2e915a3

Browse files
rstoyanchevrstoyanchev
committed
Provide access to API version in controller method
Closes gh-35424
1 parent 7ba736d commit 2e915a3

File tree

9 files changed

+401
-2
lines changed

9 files changed

+401
-2
lines changed

‎spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/ApiVersionMethodArgumentResolver.java‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/*
2+
* Copyright 2002-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.web.reactive.result.method.annotation;
18+
19+
import java.util.Optional;
20+
21+
import org.jspecify.annotations.Nullable;
22+
23+
import org.springframework.core.MethodParameter;
24+
import org.springframework.web.accept.MissingApiVersionException;
25+
import org.springframework.web.accept.SemanticApiVersionParser;
26+
import org.springframework.web.reactive.BindingContext;
27+
import org.springframework.web.reactive.HandlerMapping;
28+
import org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentResolver;
29+
import org.springframework.web.server.ServerWebExchange;
30+
31+
/**
32+
* Resolvers argument values of type {@link SemanticApiVersionParser.Version}.
33+
*
34+
* @author Rossen Stoyanchev
35+
* @since 7.0
36+
*/
37+
public class ApiVersionMethodArgumentResolver implements SyncHandlerMethodArgumentResolver {
38+
39+
@Override
40+
public boolean supportsParameter(MethodParameter parameter) {
41+
return (SemanticApiVersionParser.Version.class == parameter.nestedIfOptional().getNestedParameterType());
42+
}
43+
44+
@Override
45+
public @Nullable Object resolveArgumentValue(
46+
MethodParameter parameter, BindingContext bindingContext, ServerWebExchange exchange) {
47+
48+
Object version = exchange.getAttribute(HandlerMapping.API_VERSION_ATTRIBUTE);
49+
50+
if (parameter.getParameterType() == Optional.class) {
51+
return Optional.ofNullable(version);
52+
}
53+
54+
if (version == null) {
55+
if (!parameter.isOptional()) {
56+
// typically this should be caught earlier in AbstractHandlerMapping
57+
throw new MissingApiVersionException();
58+
}
59+
return null;
60+
}
61+
62+
if (version instanceof SemanticApiVersionParser.Version semanticApiVersion) {
63+
return semanticApiVersion;
64+
}
65+
66+
// Should never happen
67+
throw new IllegalStateException("Unexpected version type: " + version.getClass());
68+
}
69+
70+
}

‎spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/ControllerMethodResolver.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,7 @@ private static List<HandlerMethodArgumentResolver> initResolvers(ArgumentResolve
242242
result.add(new SessionStatusMethodArgumentResolver());
243243
}
244244
result.add(new WebSessionMethodArgumentResolver(adapterRegistry));
245+
result.add(new ApiVersionMethodArgumentResolver());
245246
if (KotlinDetector.isKotlinPresent()) {
246247
result.add(new ContinuationHandlerMethodArgumentResolver());
247248
}

‎spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/ApiVersionMethodArgumentResolverTests.java‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
/*
2+
* Copyright 2002-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.web.reactive.result.method.annotation;
18+
19+
import java.lang.reflect.Method;
20+
import java.util.Optional;
21+
22+
import org.jspecify.annotations.Nullable;
23+
import org.junit.jupiter.api.BeforeEach;
24+
import org.junit.jupiter.api.Test;
25+
26+
import org.springframework.core.MethodParameter;
27+
import org.springframework.web.accept.SemanticApiVersionParser;
28+
import org.springframework.web.accept.SemanticApiVersionParser.Version;
29+
import org.springframework.web.reactive.BindingContext;
30+
import org.springframework.web.reactive.HandlerMapping;
31+
import org.springframework.web.testfixture.http.server.reactive.MockServerHttpRequest;
32+
import org.springframework.web.testfixture.server.MockServerWebExchange;
33+
34+
import static org.assertj.core.api.Assertions.assertThat;
35+
36+
/**
37+
* Tests for {@link ApiVersionMethodArgumentResolver}.
38+
*
39+
* @author Rossen Stoyanchev
40+
*/
41+
class ApiVersionMethodArgumentResolverTests {
42+
43+
private final ApiVersionMethodArgumentResolver resolver = new ApiVersionMethodArgumentResolver();
44+
45+
private final MockServerWebExchange exchange = MockServerWebExchange.from(MockServerHttpRequest.get("/"));
46+
47+
private MethodParameter param;
48+
private MethodParameter nullableParam;
49+
private MethodParameter optionalParam;
50+
private MethodParameter intParam;
51+
52+
53+
@BeforeEach
54+
void setUp() throws Exception {
55+
56+
Method method = getClass().getDeclaredMethod(
57+
"handle", Version.class, Version.class, Optional.class, int.class);
58+
59+
this.param = new MethodParameter(method, 0);
60+
this.nullableParam = new MethodParameter(method, 1);
61+
this.optionalParam = new MethodParameter(method, 2);
62+
this.intParam = new MethodParameter(method, 3);
63+
}
64+
65+
@Test
66+
void supportsParameter() {
67+
assertThat(this.resolver.supportsParameter(this.param)).isTrue();
68+
assertThat(this.resolver.supportsParameter(this.nullableParam)).isTrue();
69+
assertThat(this.resolver.supportsParameter(this.optionalParam)).isTrue();
70+
assertThat(this.resolver.supportsParameter(this.intParam)).isFalse();
71+
}
72+
73+
@Test
74+
void resolveArgument() throws Exception {
75+
Version version = new SemanticApiVersionParser().parseVersion("1.2");
76+
this.exchange.getAttributes().put(HandlerMapping.API_VERSION_ATTRIBUTE, version);
77+
78+
Object actual = this.resolver.resolveArgumentValue(this.param, new BindingContext(), exchange);
79+
80+
assertThat(actual).isNotNull();
81+
assertThat(actual.getClass()).isEqualTo(Version.class);
82+
assertThat(actual).isSameAs(version);
83+
}
84+
85+
@Test
86+
void resolveNullableArgument() {
87+
Object actual = this.resolver.resolveArgumentValue(this.nullableParam, new BindingContext(), exchange);
88+
assertThat(actual).isNull();
89+
}
90+
91+
@Test
92+
void resolveOptionalArgument() {
93+
Version version = new SemanticApiVersionParser().parseVersion("1.2");
94+
this.exchange.getAttributes().put(HandlerMapping.API_VERSION_ATTRIBUTE, version);
95+
96+
Object actual = this.resolver.resolveArgumentValue(this.optionalParam, new BindingContext(), exchange);
97+
assertThat(((Optional) actual)).hasValue(version);
98+
}
99+
100+
@Test
101+
void resolveOptionalArgumentWhenEmpty() {
102+
Object actual = this.resolver.resolveArgumentValue(this.optionalParam, new BindingContext(), exchange);
103+
assertThat(((Optional) actual)).isEmpty();
104+
}
105+
106+
107+
@SuppressWarnings({"OptionalUsedAsFieldOrParameterType", "unused"})
108+
void handle(
109+
Version version,
110+
@Nullable Version nullableVersion,
111+
Optional<Version> optionalVersion,
112+
int value) {
113+
}
114+
115+
}

‎spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/ControllerMethodResolverTests.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ void requestMappingArgumentResolvers() {
120120
assertThat(next(resolvers, index).getClass()).isEqualTo(PrincipalMethodArgumentResolver.class);
121121
assertThat(next(resolvers, index).getClass()).isEqualTo(SessionStatusMethodArgumentResolver.class);
122122
assertThat(next(resolvers, index).getClass()).isEqualTo(WebSessionMethodArgumentResolver.class);
123+
assertThat(next(resolvers, index).getClass()).isEqualTo(ApiVersionMethodArgumentResolver.class);
123124
assertThat(next(resolvers, index).getClass()).isEqualTo(ContinuationHandlerMethodArgumentResolver.class);
124125

125126
assertThat(next(resolvers, index).getClass()).isEqualTo(CustomArgumentResolver.class);
@@ -157,6 +158,7 @@ void modelAttributeArgumentResolvers() {
157158
assertThat(next(resolvers, index).getClass()).isEqualTo(ServerWebExchangeMethodArgumentResolver.class);
158159
assertThat(next(resolvers, index).getClass()).isEqualTo(PrincipalMethodArgumentResolver.class);
159160
assertThat(next(resolvers, index).getClass()).isEqualTo(WebSessionMethodArgumentResolver.class);
161+
assertThat(next(resolvers, index).getClass()).isEqualTo(ApiVersionMethodArgumentResolver.class);
160162
assertThat(next(resolvers, index).getClass()).isEqualTo(ContinuationHandlerMethodArgumentResolver.class);
161163

162164
assertThat(next(resolvers, index).getClass()).isEqualTo(CustomArgumentResolver.class);
@@ -190,6 +192,7 @@ void initBinderArgumentResolvers() {
190192

191193
assertThat(next(resolvers, index).getClass()).isEqualTo(ModelMethodArgumentResolver.class);
192194
assertThat(next(resolvers, index).getClass()).isEqualTo(ServerWebExchangeMethodArgumentResolver.class);
195+
assertThat(next(resolvers, index).getClass()).isEqualTo(ApiVersionMethodArgumentResolver.class);
193196

194197
assertThat(next(resolvers, index).getClass()).isEqualTo(CustomSyncArgumentResolver.class);
195198

@@ -224,6 +227,7 @@ void exceptionHandlerArgumentResolvers() {
224227
assertThat(next(resolvers, index).getClass()).isEqualTo(ServerWebExchangeMethodArgumentResolver.class);
225228
assertThat(next(resolvers, index).getClass()).isEqualTo(PrincipalMethodArgumentResolver.class);
226229
assertThat(next(resolvers, index).getClass()).isEqualTo(WebSessionMethodArgumentResolver.class);
230+
assertThat(next(resolvers, index).getClass()).isEqualTo(ApiVersionMethodArgumentResolver.class);
227231
assertThat(next(resolvers, index).getClass()).isEqualTo(ContinuationHandlerMethodArgumentResolver.class);
228232

229233
assertThat(next(resolvers, index).getClass()).isEqualTo(CustomArgumentResolver.class);

‎spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/RequestMappingVersionIntegrationTests.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
2323
import org.springframework.http.RequestEntity;
2424
import org.springframework.http.ResponseEntity;
25+
import org.springframework.web.accept.SemanticApiVersionParser.Version;
2526
import org.springframework.web.bind.annotation.GetMapping;
2627
import org.springframework.web.bind.annotation.RestController;
2728
import org.springframework.web.client.HttpClientErrorException;
@@ -104,7 +105,8 @@ String noVersion() {
104105
}
105106

106107
@GetMapping(version = "1.2+")
107-
String version1_2() {
108+
String version1_2(Version version) {
109+
assertThat(version).isNotNull();
108110
return getBody("1.2");
109111
}
110112

‎spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ApiVersionMethodArgumentResolver.java‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
/*
2+
* Copyright 2002-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.web.servlet.mvc.method.annotation;
18+
19+
import java.util.Optional;
20+
21+
import jakarta.servlet.http.HttpServletRequest;
22+
import org.jspecify.annotations.Nullable;
23+
24+
import org.springframework.core.MethodParameter;
25+
import org.springframework.util.Assert;
26+
import org.springframework.web.accept.MissingApiVersionException;
27+
import org.springframework.web.accept.SemanticApiVersionParser;
28+
import org.springframework.web.bind.support.WebDataBinderFactory;
29+
import org.springframework.web.context.request.NativeWebRequest;
30+
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
31+
import org.springframework.web.method.support.ModelAndViewContainer;
32+
import org.springframework.web.servlet.HandlerMapping;
33+
34+
/**
35+
* Resolvers argument values of type {@link SemanticApiVersionParser.Version}.
36+
*
37+
* @author Rossen Stoyanchev
38+
* @since 7.0
39+
*/
40+
public class ApiVersionMethodArgumentResolver implements HandlerMethodArgumentResolver {
41+
42+
@Override
43+
public boolean supportsParameter(MethodParameter parameter) {
44+
return (SemanticApiVersionParser.Version.class == parameter.nestedIfOptional().getNestedParameterType());
45+
}
46+
47+
@Override
48+
public @Nullable Object resolveArgument(
49+
MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
50+
NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
51+
52+
HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
53+
Assert.state(request != null, "No HttpServletRequest");
54+
Object version = request.getAttribute(HandlerMapping.API_VERSION_ATTRIBUTE);
55+
56+
if (parameter.getParameterType() == Optional.class) {
57+
return Optional.ofNullable(version);
58+
}
59+
60+
if (version == null) {
61+
if (!parameter.isOptional()) {
62+
// typically this should be caught earlier in AbstractHandlerMapping
63+
throw new MissingApiVersionException();
64+
}
65+
return null;
66+
}
67+
68+
if (version instanceof SemanticApiVersionParser.Version semanticApiVersion) {
69+
return semanticApiVersion;
70+
}
71+
72+
// Should never happen
73+
throw new IllegalStateException("Unexpected version type: " + version.getClass());
74+
}
75+
76+
}

‎spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapter.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -671,6 +671,7 @@ private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
671671
resolvers.add(new ErrorsMethodArgumentResolver());
672672
resolvers.add(new SessionStatusMethodArgumentResolver());
673673
resolvers.add(new UriComponentsBuilderMethodArgumentResolver());
674+
resolvers.add(new ApiVersionMethodArgumentResolver());
674675
if (KotlinDetector.isKotlinPresent()) {
675676
resolvers.add(new ContinuationHandlerMethodArgumentResolver());
676677
}

0 commit comments

Comments
 (0)