root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

RequestMappingInfo defaults to PathPatternParser 

This changes ensures RequestMappingInfo uses PathPatternParser by default
as all AbstractHandlerMapping implementations do as of 6.0.

RequestMappingInfo instances are typically created internally and aligned with
the RequestMappingHandlerMapping in terms of path mapping options.
If a RequestMappingInfo is registered programmatically, the caller needs to also
ensure they are aligned. However, if the two should be aligned by default.

Closes gh-31662
This commit is contained in:
rstoyanchev 2023-11-27 10:27:56 +00:00
parent 54ecbb2bc8
commit 43700302c6
4 changed files with 61 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/RequestMappingInfo.java
View File

@ -705,27 +705,28 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
@SuppressWarnings("deprecation") @SuppressWarnings("deprecation")
public RequestMappingInfo build() { public RequestMappingInfo build() {
PathPatternsRequestCondition pathPatterns = null; PathPatternsRequestCondition pathPatternsCondition = null;
PatternsRequestCondition patterns = null; PatternsRequestCondition patternsCondition = null;
if (this.options.patternParser != null) { if (this.options.getPathMatcher() != null) {
pathPatterns = (ObjectUtils.isEmpty(this.paths) ? patternsCondition = (ObjectUtils.isEmpty(this.paths) ?
EMPTY_PATH_PATTERNS :
new PathPatternsRequestCondition(this.options.patternParser, this.paths));
}
else {
patterns = (ObjectUtils.isEmpty(this.paths) ?
EMPTY_PATTERNS : EMPTY_PATTERNS :
new PatternsRequestCondition( new PatternsRequestCondition(
this.paths, null, this.options.getPathMatcher(), this.paths, null, this.options.getPathMatcher(),
this.options.useSuffixPatternMatch(), this.options.useTrailingSlashMatch(), this.options.useSuffixPatternMatch(), this.options.useTrailingSlashMatch(),
this.options.getFileExtensions())); this.options.getFileExtensions()));
} }
else {
PathPatternParser parser = (this.options.getPatternParser() != null ?
this.options.getPatternParser() : new PathPatternParser());
pathPatternsCondition = (ObjectUtils.isEmpty(this.paths) ?
EMPTY_PATH_PATTERNS : new PathPatternsRequestCondition(parser, this.paths));
}
ContentNegotiationManager manager = this.options.getContentNegotiationManager(); ContentNegotiationManager manager = this.options.getContentNegotiationManager();
return new RequestMappingInfo( return new RequestMappingInfo(
this.mappingName, pathPatterns, patterns, this.mappingName, pathPatternsCondition, patternsCondition,
ObjectUtils.isEmpty(this.methods) ? ObjectUtils.isEmpty(this.methods) ?
EMPTY_REQUEST_METHODS : new RequestMethodsRequestCondition(this.methods), EMPTY_REQUEST_METHODS : new RequestMethodsRequestCondition(this.methods),
ObjectUtils.isEmpty(this.params) ? ObjectUtils.isEmpty(this.params) ?
@ -737,8 +738,7 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
ObjectUtils.isEmpty(this.produces) && !this.hasAccept ? ObjectUtils.isEmpty(this.produces) && !this.hasAccept ?
EMPTY_PRODUCES : new ProducesRequestCondition(this.produces, this.headers, manager), EMPTY_PRODUCES : new ProducesRequestCondition(this.produces, this.headers, manager),
this.customCondition != null ? this.customCondition != null ?
new RequestConditionHolder(this.customCondition) : EMPTY_CUSTOM, new RequestConditionHolder(this.customCondition) : EMPTY_CUSTOM, this.options);
this.options);
} }
} }
@ -894,7 +894,9 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
* {@link AbstractHandlerMapping#setPatternParser(PathPatternParser)}. * {@link AbstractHandlerMapping#setPatternParser(PathPatternParser)}.
* <p><strong>Note:</strong> This property is mutually exclusive with * <p><strong>Note:</strong> This property is mutually exclusive with
* {@link #setPathMatcher(PathMatcher)}. * {@link #setPathMatcher(PathMatcher)}.
* <p>By default this is not enabled. * <p>By default this is not set, but {@link RequestMappingInfo.Builder}
* defaults to using {@link PathPatternParser} unless
* {@link #setPathMatcher(PathMatcher)} is explicitly set.
* @since 5.3 * @since 5.3
*/ */
public void setPatternParser(@Nullable PathPatternParser patternParser) { public void setPatternParser(@Nullable PathPatternParser patternParser) {
@ -936,7 +938,9 @@ public final class RequestMappingInfo implements RequestCondition<RequestMapping
/** /**
* Set a custom PathMatcher to use for the PatternsRequestCondition. * Set a custom PathMatcher to use for the PatternsRequestCondition.
* <p>By default this is not set. * <p>By default this is not set. You must set it explicitly if you want
* {@link PathMatcher} to be used, or otherwise {@link RequestMappingInfo}
* defaults to using {@link PathPatternParser}.
*/ */
public void setPathMatcher(@Nullable PathMatcher pathMatcher) { public void setPathMatcher(@Nullable PathMatcher pathMatcher) {
this.pathMatcher = pathMatcher; this.pathMatcher = pathMatcher;

29
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/RequestMappingInfoHandlerMappingTests.java
View File

@ -38,6 +38,7 @@ import org.springframework.http.server.RequestPath;
import org.springframework.http.server.observation.ServerRequestObservationContext; import org.springframework.http.server.observation.ServerRequestObservationContext;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
import org.springframework.util.AntPathMatcher;
import org.springframework.util.MultiValueMap; import org.springframework.util.MultiValueMap;
import org.springframework.web.HttpMediaTypeNotAcceptableException; import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpMediaTypeNotSupportedException; import org.springframework.web.HttpMediaTypeNotSupportedException;
@ -258,10 +259,13 @@ class RequestMappingInfoHandlerMappingTests {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@PathPatternsParameterizedTest @PathPatternsParameterizedTest
void handleMatchUriTemplateVariables(TestRequestMappingInfoHandlerMapping mapping) { void handleMatchUriTemplateVariables(TestRequestMappingInfoHandlerMapping mapping) {
RequestMappingInfo key = RequestMappingInfo.paths("/{path1}/{path2}").build(); RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();
config.setPathMatcher(new AntPathMatcher());
RequestMappingInfo info = RequestMappingInfo.paths("/{path1}/{path2}").options(config).build();
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2"); MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2");
String lookupPath = new UrlPathHelper().getLookupPathForRequest(request); String lookupPath = new UrlPathHelper().getLookupPathForRequest(request);
mapping.handleMatch(key, lookupPath, request); mapping.handleMatch(info, lookupPath, request);
String name = HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE; String name = HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE;
Map<String, String> uriVariables = (Map<String, String>) request.getAttribute(name); Map<String, String> uriVariables = (Map<String, String>) request.getAttribute(name);
@ -274,7 +278,10 @@ class RequestMappingInfoHandlerMappingTests {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@PathPatternsParameterizedTest // SPR-9098 @PathPatternsParameterizedTest // SPR-9098
void handleMatchUriTemplateVariablesDecode(TestRequestMappingInfoHandlerMapping mapping) { void handleMatchUriTemplateVariablesDecode(TestRequestMappingInfoHandlerMapping mapping) {
RequestMappingInfo key = RequestMappingInfo.paths("/{group}/{identifier}").build(); RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();
config.setPathMatcher(new AntPathMatcher());
RequestMappingInfo info = RequestMappingInfo.paths("/{group}/{identifier}").options(config).build();
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/group/a%2Fb"); MockHttpServletRequest request = new MockHttpServletRequest("GET", "/group/a%2Fb");
UrlPathHelper pathHelper = new UrlPathHelper(); UrlPathHelper pathHelper = new UrlPathHelper();
@ -282,7 +289,7 @@ class RequestMappingInfoHandlerMappingTests {
String lookupPath = pathHelper.getLookupPathForRequest(request); String lookupPath = pathHelper.getLookupPathForRequest(request);
mapping.setUrlPathHelper(pathHelper); mapping.setUrlPathHelper(pathHelper);
mapping.handleMatch(key, lookupPath, request); mapping.handleMatch(info, lookupPath, request);
String name = HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE; String name = HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE;
Map<String, String> uriVariables = (Map<String, String>) request.getAttribute(name); Map<String, String> uriVariables = (Map<String, String>) request.getAttribute(name);
@ -294,20 +301,26 @@ class RequestMappingInfoHandlerMappingTests {
@PathPatternsParameterizedTest @PathPatternsParameterizedTest
void handleMatchBestMatchingPatternAttribute(TestRequestMappingInfoHandlerMapping mapping) { void handleMatchBestMatchingPatternAttribute(TestRequestMappingInfoHandlerMapping mapping) {
RequestMappingInfo key = RequestMappingInfo.paths("/{path1}/2", "/**").build(); RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();
config.setPathMatcher(new AntPathMatcher());
RequestMappingInfo info = RequestMappingInfo.paths("/{path1}/2", "/**").options(config).build();
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2"); MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2");
mapping.handleMatch(key, "/1/2", request); mapping.handleMatch(info, "/1/2", request);
assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)).isEqualTo("/{path1}/2"); assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)).isEqualTo("/{path1}/2");
} }
@PathPatternsParameterizedTest @PathPatternsParameterizedTest
void handleMatchBestMatchingPatternAttributeInObservationContext(TestRequestMappingInfoHandlerMapping mapping) { void handleMatchBestMatchingPatternAttributeInObservationContext(TestRequestMappingInfoHandlerMapping mapping) {
RequestMappingInfo key = RequestMappingInfo.paths("/{path1}/2", "/**").build(); RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();
config.setPathMatcher(new AntPathMatcher());
RequestMappingInfo info = RequestMappingInfo.paths("/{path1}/2", "/**").options(config).build();
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2"); MockHttpServletRequest request = new MockHttpServletRequest("GET", "/1/2");
ServerRequestObservationContext observationContext = new ServerRequestObservationContext(request, new MockHttpServletResponse()); ServerRequestObservationContext observationContext = new ServerRequestObservationContext(request, new MockHttpServletResponse());
request.setAttribute(ServerHttpObservationFilter.CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE, observationContext); request.setAttribute(ServerHttpObservationFilter.CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE, observationContext);
mapping.handleMatch(key, "/1/2", request); mapping.handleMatch(info, "/1/2", request);
assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)).isEqualTo("/{path1}/2"); assertThat(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)).isEqualTo("/{path1}/2");
assertThat(observationContext.getPathPattern()).isEqualTo("/{path1}/2"); assertThat(observationContext.getPathPattern()).isEqualTo("/{path1}/2");

28
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/RequestMappingInfoTests.java
View File

@ -26,6 +26,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.http.HttpHeaders; import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType; import org.springframework.http.MediaType;
import org.springframework.util.AntPathMatcher;
import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.handler.PathPatternsParameterizedTest; import org.springframework.web.servlet.handler.PathPatternsParameterizedTest;
import org.springframework.web.servlet.handler.PathPatternsTestUtils; import org.springframework.web.servlet.handler.PathPatternsTestUtils;
@ -48,8 +49,8 @@ class RequestMappingInfoTests {
@SuppressWarnings("unused") @SuppressWarnings("unused")
static Stream<RequestMappingInfo.Builder> pathPatternsArguments() { static Stream<RequestMappingInfo.Builder> pathPatternsArguments() {
RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration(); RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();
config.setPatternParser(new PathPatternParser()); config.setPathMatcher(new AntPathMatcher());
return Stream.of(RequestMappingInfo.paths().options(config), RequestMappingInfo.paths()); return Stream.of(RequestMappingInfo.paths(), RequestMappingInfo.paths().options(config));
} }
@ -86,6 +87,13 @@ class RequestMappingInfoTests {
assertThat(info.getCustomCondition()).isSameAs(result.getCustomCondition()); assertThat(info.getCustomCondition()).isSameAs(result.getCustomCondition());
} }
@Test // gh-31662
void pathPatternByDefault() {
RequestMappingInfo info = RequestMappingInfo.paths().build();
assertThat(info.getPathPatternsCondition()).isNotNull();
assertThat(info.getPatternsCondition()).isNull();
}
@PathPatternsParameterizedTest @PathPatternsParameterizedTest
void matchPatternsCondition(RequestMappingInfo.Builder builder) { void matchPatternsCondition(RequestMappingInfo.Builder builder) {
@ -105,7 +113,7 @@ class RequestMappingInfoTests {
@Test @Test
void matchParamsCondition() { void matchParamsCondition() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", true);
request.setParameter("foo", "bar"); request.setParameter("foo", "bar");
RequestMappingInfo info = RequestMappingInfo.paths("/foo").params("foo=bar").build(); RequestMappingInfo info = RequestMappingInfo.paths("/foo").params("foo=bar").build();
@ -121,7 +129,7 @@ class RequestMappingInfoTests {
@Test @Test
void matchHeadersCondition() { void matchHeadersCondition() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", true);
request.addHeader("foo", "bar"); request.addHeader("foo", "bar");
RequestMappingInfo info = RequestMappingInfo.paths("/foo").headers("foo=bar").build(); RequestMappingInfo info = RequestMappingInfo.paths("/foo").headers("foo=bar").build();
@ -137,7 +145,7 @@ class RequestMappingInfoTests {
@Test @Test
void matchConsumesCondition() { void matchConsumesCondition() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", true);
request.setContentType("text/plain"); request.setContentType("text/plain");
RequestMappingInfo info = RequestMappingInfo.paths("/foo").consumes("text/plain").build(); RequestMappingInfo info = RequestMappingInfo.paths("/foo").consumes("text/plain").build();
@ -153,7 +161,7 @@ class RequestMappingInfoTests {
@Test @Test
void matchProducesCondition() { void matchProducesCondition() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", true);
request.addHeader("Accept", "text/plain"); request.addHeader("Accept", "text/plain");
RequestMappingInfo info = RequestMappingInfo.paths("/foo").produces("text/plain").build(); RequestMappingInfo info = RequestMappingInfo.paths("/foo").produces("text/plain").build();
@ -169,7 +177,7 @@ class RequestMappingInfoTests {
@Test @Test
void matchCustomCondition() { void matchCustomCondition() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/foo", true);
request.setParameter("foo", "bar"); request.setParameter("foo", "bar");
RequestMappingInfo info = RequestMappingInfo.paths("/foo").params("foo=bar").build(); RequestMappingInfo info = RequestMappingInfo.paths("/foo").params("foo=bar").build();
@ -189,7 +197,7 @@ class RequestMappingInfoTests {
RequestMappingInfo oneMethod = RequestMappingInfo.paths().methods(GET).build(); RequestMappingInfo oneMethod = RequestMappingInfo.paths().methods(GET).build();
RequestMappingInfo oneMethodOneParam = RequestMappingInfo.paths().methods(GET).params("foo").build(); RequestMappingInfo oneMethodOneParam = RequestMappingInfo.paths().methods(GET).params("foo").build();
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/", true);
Comparator<RequestMappingInfo> comparator = (info, otherInfo) -> info.compareTo(otherInfo, request); Comparator<RequestMappingInfo> comparator = (info, otherInfo) -> info.compareTo(otherInfo, request);
List<RequestMappingInfo> list = asList(noMethods, oneMethod, oneMethodOneParam); List<RequestMappingInfo> list = asList(noMethods, oneMethod, oneMethodOneParam);
@ -204,7 +212,7 @@ class RequestMappingInfoTests {
@Test @Test
// SPR-14383 // SPR-14383
void compareToWithHttpHeadMapping() { void compareToWithHttpHeadMapping() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("GET", "/", true);
request.setMethod("HEAD"); request.setMethod("HEAD");
request.addHeader("Accept", "application/json"); request.addHeader("Accept", "application/json");
@ -297,7 +305,7 @@ class RequestMappingInfoTests {
@Test @Test
void preFlightRequest() { void preFlightRequest() {
MockHttpServletRequest request = PathPatternsTestUtils.initRequest("OPTIONS", "/foo", false); MockHttpServletRequest request = PathPatternsTestUtils.initRequest("OPTIONS", "/foo", true);
request.addHeader(HttpHeaders.ORIGIN, "https://domain.com"); request.addHeader(HttpHeaders.ORIGIN, "https://domain.com");
request.addHeader(HttpHeaders.ACCESS_CONTROL_REQUEST_METHOD, "POST"); request.addHeader(HttpHeaders.ACCESS_CONTROL_REQUEST_METHOD, "POST");

7
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/CrossOriginTests.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"); * 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.
@ -38,6 +38,7 @@ import org.springframework.http.HttpHeaders;
import org.springframework.http.server.RequestPath; import org.springframework.http.server.RequestPath;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
import org.springframework.util.AntPathMatcher;
import org.springframework.util.CollectionUtils; import org.springframework.util.CollectionUtils;
import org.springframework.web.bind.annotation.CrossOrigin; import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
@ -595,8 +596,8 @@ class CrossOriginTests {
RequestMapping annotation = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class); RequestMapping annotation = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class);
if (annotation != null) { if (annotation != null) {
RequestMappingInfo.BuilderConfiguration options = new RequestMappingInfo.BuilderConfiguration(); RequestMappingInfo.BuilderConfiguration options = new RequestMappingInfo.BuilderConfiguration();
if (getPatternParser() != null) { if (getPatternParser() == null) {
options.setPatternParser(getPatternParser()); options.setPathMatcher(new AntPathMatcher());
} }
return RequestMappingInfo.paths(annotation.value()) return RequestMappingInfo.paths(annotation.value())
.methods(annotation.method()) .methods(annotation.method())