Remove Spring MVC suffixPattern and trailingSlash matching

See gh-34036

Author: rstoyanchev

spring-test/src/main/java/org/springframework/test/web/servlet/client/MockMvcWebTestClient.java

@@ -370,16 +370,6 @@ ControllerSpec mappedInterceptors(
 		 */
 		ControllerSpec patternParser(PathPatternParser parser);
 
-		/**
-		 * Whether to match trailing slashes.
-		 * <p>This is delegated to
-		 * {@link StandaloneMockMvcBuilder#setUseTrailingSlashPatternMatch(boolean)}.
-		 * @deprecated as of 6.0, see
-		 * {@link PathPatternParser#setMatchOptionalTrailingSeparator(boolean)}
-		 */
-		@Deprecated(since = "6.0")
-		ControllerSpec useTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch);
-
 		/**
 		 * Configure placeholder values to use.
 		 * <p>This is delegated to

spring-test/src/main/java/org/springframework/test/web/servlet/client/StandaloneMockMvcSpec.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -152,13 +152,6 @@ public StandaloneMockMvcSpec patternParser(PathPatternParser parser) {
 		return this;
 	}
 
-	@SuppressWarnings("deprecation")
-	@Override
-	public StandaloneMockMvcSpec useTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch) {
-		this.mockMvcBuilder.setUseTrailingSlashPatternMatch(useTrailingSlashPatternMatch);
-		return this;
-	}
-
 	@Override
 	public StandaloneMockMvcSpec placeholderValue(String name, String value) {
 		this.mockMvcBuilder.addPlaceholderValue(name, value);

spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java

@@ -130,10 +130,6 @@ public class StandaloneMockMvcBuilder extends AbstractMockMvcBuilder<StandaloneM
 	@Nullable
 	private PathPatternParser patternParser;
 
-	private boolean useSuffixPatternMatch = false;
-
-	private boolean useTrailingSlashPatternMatch = false;
-
 	@Nullable
 	private Boolean removeSemicolonContent;
 
@@ -323,33 +319,6 @@ public StandaloneMockMvcBuilder setPatternParser(@Nullable PathPatternParser par
 		return this;
 	}
 
-	/**
-	 * Whether to use suffix pattern match (".*") when matching patterns to
-	 * requests. If enabled a method mapped to "/users" also matches to "/users.*".
-	 * <p>The default value is {@code false}.
-	 * @deprecated as of 5.2.4. See class-level note in
-	 * {@link RequestMappingHandlerMapping} on the deprecation of path extension
-	 * config options.
-	 */
-	@Deprecated
-	public StandaloneMockMvcBuilder setUseSuffixPatternMatch(boolean useSuffixPatternMatch) {
-		this.useSuffixPatternMatch = useSuffixPatternMatch;
-		this.preferPathMatcher |= useSuffixPatternMatch;
-		return this;
-	}
-
-	/**
-	 * Whether to match to URLs irrespective of the presence of a trailing slash.
-	 * If enabled a method mapped to "/users" also matches to "/users/".
-	 * @deprecated as of 6.0, see
-	 * {@link PathPatternParser#setMatchOptionalTrailingSeparator(boolean)}
-	 */
-	@Deprecated(since = "6.0")
-	public StandaloneMockMvcBuilder setUseTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch) {
-		this.useTrailingSlashPatternMatch = useTrailingSlashPatternMatch;
-		return this;
-	}
-
 	/**
 	 * Set if ";" (semicolon) content should be stripped from the request URI. The value,
 	 * if provided, is in turn set on
@@ -469,7 +438,6 @@ protected Map<String, Object> extendMvcSingletons(@Nullable ServletContext servl
 	/** Using the MVC Java configuration as the starting point for the "standalone" setup. */
 	private class StandaloneConfiguration extends WebMvcConfigurationSupport {
 
-		@SuppressWarnings("deprecation")
 		public RequestMappingHandlerMapping getHandlerMapping(
 				FormattingConversionService mvcConversionService,
 				ResourceUrlProvider mvcResourceUrlProvider) {
@@ -478,7 +446,6 @@ public RequestMappingHandlerMapping getHandlerMapping(
 			handlerMapping.setEmbeddedValueResolver(new StaticStringValueResolver(placeholderValues));
 			if (patternParser == null && preferPathMatcher) {
 				handlerMapping.setPatternParser(null);
-				handlerMapping.setUseSuffixPatternMatch(useSuffixPatternMatch);
 				if (removeSemicolonContent != null) {
 					UrlPathHelper pathHelper = new UrlPathHelper();
 					pathHelper.setRemoveSemicolonContent(removeSemicolonContent);
@@ -488,7 +455,6 @@ public RequestMappingHandlerMapping getHandlerMapping(
 			else if (patternParser != null) {
 				handlerMapping.setPatternParser(patternParser);
 			}
-			handlerMapping.setUseTrailingSlashMatch(useTrailingSlashPatternMatch);
 			handlerMapping.setOrder(0);
 			handlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
 			return handlerMapping;

spring-test/src/test/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilderTests.java

@@ -74,25 +74,6 @@ void placeHoldersInRequestMapping() throws Exception {
 		assertThat(((HandlerMethod) chain.getHandler()).getMethod().getName()).isEqualTo("handleWithPlaceholders");
 	}
 
-	@Test  // SPR-13637
-	@SuppressWarnings("deprecation")
-	void suffixPatternMatch() throws Exception {
-		TestStandaloneMockMvcBuilder builder = new TestStandaloneMockMvcBuilder(new PersonController());
-		builder.setUseSuffixPatternMatch(false);
-		builder.build();
-
-		RequestMappingHandlerMapping hm = builder.wac.getBean(RequestMappingHandlerMapping.class);
-
-		MockHttpServletRequest request = new MockHttpServletRequest("GET", "/persons");
-		HandlerExecutionChain chain = hm.getHandler(request);
-		assertThat(chain).isNotNull();
-		assertThat(((HandlerMethod) chain.getHandler()).getMethod().getName()).isEqualTo("persons");
-
-		request = new MockHttpServletRequest("GET", "/persons.xml");
-		chain = hm.getHandler(request);
-		assertThat(chain).isNull();
-	}
-
 	@Test  // SPR-12553
 	void applicationContextAttribute() {
 		TestStandaloneMockMvcBuilder builder = new TestStandaloneMockMvcBuilder(new PlaceholderController());

spring-webmvc/src/main/java/org/springframework/web/servlet/config/AnnotationDrivenBeanDefinitionParser.java

@@ -409,21 +409,7 @@ private void configurePathMatchingProperties(
 		Element pathMatchingElement = DomUtils.getChildElementByTagName(element, "path-matching");
 		Object source = context.extractSource(element);
 		if (pathMatchingElement != null) {
-			if (pathMatchingElement.hasAttribute("trailing-slash")) {
-				boolean useTrailingSlashMatch = Boolean.parseBoolean(pathMatchingElement.getAttribute("trailing-slash"));
-				handlerMappingDef.getPropertyValues().add("useTrailingSlashMatch", useTrailingSlashMatch);
-			}
 			boolean preferPathMatcher = false;
-			if (pathMatchingElement.hasAttribute("suffix-pattern")) {
-				boolean useSuffixPatternMatch = Boolean.parseBoolean(pathMatchingElement.getAttribute("suffix-pattern"));
-				handlerMappingDef.getPropertyValues().add("useSuffixPatternMatch", useSuffixPatternMatch);
-				preferPathMatcher |= useSuffixPatternMatch;
-			}
-			if (pathMatchingElement.hasAttribute("registered-suffixes-only")) {
-				boolean useRegisteredSuffixPatternMatch = Boolean.parseBoolean(pathMatchingElement.getAttribute("registered-suffixes-only"));
-				handlerMappingDef.getPropertyValues().add("useRegisteredSuffixPatternMatch", useRegisteredSuffixPatternMatch);
-				preferPathMatcher |= useRegisteredSuffixPatternMatch;
-			}
 
 			RuntimeBeanReference pathHelperRef = null;
 			if (pathMatchingElement.hasAttribute("path-helper")) {

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/PathMatchConfigurer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -23,7 +23,6 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.AntPathMatcher;
 import org.springframework.util.PathMatcher;
-import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
 import org.springframework.web.util.UrlPathHelper;
 import org.springframework.web.util.pattern.PathPattern;
 import org.springframework.web.util.pattern.PathPatternParser;
@@ -49,18 +48,9 @@ public class PathMatchConfigurer {
 	@Nullable
 	private PathPatternParser patternParser;
 
-	@Nullable
-	private Boolean trailingSlashMatch;
-
 	@Nullable
 	private Map<String, Predicate<Class<?>>> pathPrefixes;
 
-	@Nullable
-	private Boolean suffixPatternMatch;
-
-	@Nullable
-	private Boolean registeredSuffixPatternMatch;
-
 	@Nullable
 	private UrlPathHelper urlPathHelper;
 
@@ -84,8 +74,6 @@ public class PathMatchConfigurer {
 	 * <p><strong>Note:</strong> This property is mutually exclusive with the
 	 * following other, {@code AntPathMatcher} related properties:
 	 * <ul>
-	 * <li>{@link #setUseSuffixPatternMatch(Boolean)}
-	 * <li>{@link #setUseRegisteredSuffixPatternMatch(Boolean)}
 	 * <li>{@link #setUrlPathHelper(UrlPathHelper)}
 	 * <li>{@link #setPathMatcher(PathMatcher)}
 	 * </ul>
@@ -103,20 +91,6 @@ public PathMatchConfigurer setPatternParser(@Nullable PathPatternParser patternP
 		return this;
 	}
 
-	/**
-	 * Whether to match to URLs irrespective of the presence of a trailing slash.
-	 * If enabled a method mapped to "/users" also matches to "/users/".
-	 * <p>The default was changed in 6.0 from {@code true} to {@code false} in
-	 * order to support the deprecation of the property.
-	 * @deprecated as of 6.0, see
-	 * {@link PathPatternParser#setMatchOptionalTrailingSeparator(boolean)}
-	 */
-	@Deprecated(since = "6.0")
-	public PathMatchConfigurer setUseTrailingSlashMatch(Boolean trailingSlashMatch) {
-		this.trailingSlashMatch = trailingSlashMatch;
-		return this;
-	}
-
 	/**
 	 * Configure a path prefix to apply to matching controller methods.
 	 * <p>Prefixes are used to enrich the mappings of every {@code @RequestMapping}
@@ -136,49 +110,6 @@ public PathMatchConfigurer addPathPrefix(String prefix, Predicate<Class<?>> pred
 		return this;
 	}
 
-	/**
-	 * Whether to use suffix pattern match (".*") when matching patterns to
-	 * requests. If enabled a method mapped to "/users" also matches to "/users.*".
-	 * <p><strong>Note:</strong> This property is mutually exclusive with
-	 * {@link #setPatternParser(PathPatternParser)}. If set, it enables use of
-	 * String path matching, unless a {@code PathPatternParser} is also
-	 * explicitly set in which case this property is ignored.
-	 * <p>By default this is set to {@code false}.
-	 * @deprecated as of 5.2.4. See class-level note in
-	 * {@link RequestMappingHandlerMapping} on the deprecation of path extension
-	 * config options. As there is no replacement for this method, in 5.2.x it is
-	 * necessary to set it to {@code false}. In 5.3 the default changes to
-	 * {@code false} and use of this property becomes unnecessary.
-	 */
-	@Deprecated
-	public PathMatchConfigurer setUseSuffixPatternMatch(@Nullable Boolean suffixPatternMatch) {
-		this.suffixPatternMatch = suffixPatternMatch;
-		this.preferPathMatcher |= (suffixPatternMatch != null && suffixPatternMatch);
-		return this;
-	}
-
-	/**
-	 * Whether suffix pattern matching should work only against path extensions
-	 * explicitly registered when you
-	 * {@link WebMvcConfigurer#configureContentNegotiation configure content
-	 * negotiation}. This is generally recommended to reduce ambiguity and to
-	 * avoid issues such as when a "." appears in the path for other reasons.
-	 * <p><strong>Note:</strong> This property is mutually exclusive with
-	 * {@link #setPatternParser(PathPatternParser)}. If set, it enables use of
-	 * String path matching, unless a {@code PathPatternParser} is also
-	 * explicitly set in which case this property is ignored.
-	 * <p>By default this is set to "false".
-	 * @deprecated as of 5.2.4. See class-level note in
-	 * {@link RequestMappingHandlerMapping} on the deprecation of path extension
-	 * config options.
-	 */
-	@Deprecated
-	public PathMatchConfigurer setUseRegisteredSuffixPatternMatch(@Nullable Boolean registeredSuffixPatternMatch) {
-		this.registeredSuffixPatternMatch = registeredSuffixPatternMatch;
-		this.preferPathMatcher |= (registeredSuffixPatternMatch != null && registeredSuffixPatternMatch);
-		return this;
-	}
-
 	/**
 	 * Set the UrlPathHelper to use to resolve the mapping path for the application.
 	 * <p><strong>Note:</strong> This property is mutually exclusive with
@@ -232,39 +163,11 @@ public PathPatternParser getPatternParser() {
 		return this.patternParser;
 	}
 
-	@Nullable
-	@Deprecated
-	public Boolean isUseTrailingSlashMatch() {
-		return this.trailingSlashMatch;
-	}
-
 	@Nullable
 	protected Map<String, Predicate<Class<?>>> getPathPrefixes() {
 		return this.pathPrefixes;
 	}
 
-	/**
-	 * Whether to use registered suffixes for pattern matching.
-	 * @deprecated as of 5.2.4, see deprecation note on
-	 * {@link #setUseRegisteredSuffixPatternMatch(Boolean)}.
-	 */
-	@Nullable
-	@Deprecated
-	public Boolean isUseRegisteredSuffixPatternMatch() {
-		return this.registeredSuffixPatternMatch;
-	}
-
-	/**
-	 * Whether to use registered suffixes for pattern matching.
-	 * @deprecated as of 5.2.4, see deprecation note on
-	 * {@link #setUseSuffixPatternMatch(Boolean)}.
-	 */
-	@Nullable
-	@Deprecated
-	public Boolean isUseSuffixPatternMatch() {
-		return this.suffixPatternMatch;
-	}
-
 	@Nullable
 	public UrlPathHelper getUrlPathHelper() {
 		return this.urlPathHelper;

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java

@@ -321,22 +321,6 @@ public RequestMappingHandlerMapping requestMappingHandlerMapping(
 		initHandlerMapping(mapping, conversionService, resourceUrlProvider);
 
 		PathMatchConfigurer pathConfig = getPathMatchConfigurer();
-		if (pathConfig.preferPathMatcher()) {
-			Boolean useSuffixPatternMatch = pathConfig.isUseSuffixPatternMatch();
-			if (useSuffixPatternMatch != null) {
-				mapping.setUseSuffixPatternMatch(useSuffixPatternMatch);
-			}
-			Boolean useRegisteredSuffixPatternMatch = pathConfig.isUseRegisteredSuffixPatternMatch();
-			if (useRegisteredSuffixPatternMatch != null) {
-				mapping.setUseRegisteredSuffixPatternMatch(useRegisteredSuffixPatternMatch);
-			}
-		}
-
-		Boolean useTrailingSlashMatch = pathConfig.isUseTrailingSlashMatch();
-		if (useTrailingSlashMatch != null) {
-			mapping.setUseTrailingSlashMatch(useTrailingSlashMatch);
-		}
-
 		if (pathConfig.getPathPrefixes() != null) {
 			mapping.setPathPrefixes(pathConfig.getPathPrefixes());
 		}
@@ -520,6 +504,8 @@ private void initHandlerMapping(
 		else if (pathConfig.getPatternParser() != null) {
 			mapping.setPatternParser(pathConfig.getPatternParser());
 		}
+		// else: AbstractHandlerMapping defaults to PathPatternParser
+
 		mapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider));
 		mapping.setCorsConfigurations(getCorsConfigurations());
 	}