Remove Spring MVC path extension content negotiation

See gh-34036

Author: rstoyanchev

framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-requestmapping.adoc

@@ -248,36 +248,6 @@ specific than other pattern that do not have double wildcards.
 For the full details, follow the above links to the pattern Comparators.
 
 
-[[mvc-ann-requestmapping-suffix-pattern-match]]
-== Suffix Match
-
-Starting in 5.3, by default Spring MVC no longer performs `.{asterisk}` suffix pattern
-matching where a controller mapped to `/person` is also implicitly mapped to
-`/person.{asterisk}`. As a consequence path extensions are no longer used to interpret
-the requested content type for the response -- for example, `/person.pdf`, `/person.xml`,
-and so on.
-
-Using file extensions in this way was necessary when browsers used to send `Accept` headers
-that were hard to interpret consistently. At present, that is no longer a necessity and
-using the `Accept` header should be the preferred choice.
-
-Over time, the use of file name extensions has proven problematic in a variety of ways.
-It can cause ambiguity when overlain with the use of URI variables, path parameters, and
-URI encoding. Reasoning about URL-based authorization
-and security (see next section for more details) also becomes more difficult.
-
-To completely disable the use of path extensions in versions prior to 5.3, set the following:
-
-* `useSuffixPatternMatching(false)`, see xref:web/webmvc/mvc-config/path-matching.adoc[PathMatchConfigurer]
-* `favorPathExtension(false)`, see xref:web/webmvc/mvc-config/content-negotiation.adoc[ContentNegotiationConfigurer]
-
-Having a way to request content types other than through the `"Accept"` header can still
-be useful, for example, when typing a URL in a browser. A safe alternative to path extensions is
-to use the query parameter strategy. If you must use file extensions, consider restricting
-them to a list of explicitly registered extensions through the `mediaTypes` property of
-xref:web/webmvc/mvc-config/content-negotiation.adoc[ContentNegotiationConfigurer].
-
-
 [[mvc-ann-requestmapping-rfd]]
 == Suffix Match and RFD
 

spring-web/src/main/java/org/springframework/web/accept/AbstractMappingContentNegotiationStrategy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 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.
@@ -83,8 +83,7 @@ public boolean isUseRegisteredExtensionsOnly() {
 	/**
 	 * Whether to ignore requests with unknown file extension. Setting this to
 	 * {@code false} results in {@code HttpMediaTypeNotAcceptableException}.
-	 * <p>By default this is set to {@literal false} but is overridden in
-	 * {@link PathExtensionContentNegotiationStrategy} to {@literal true}.
+	 * <p>By default, this is set to {@literal false}.
 	 */
 	public void setIgnoreUnknownExtensions(boolean ignoreUnknownExtensions) {
 		this.ignoreUnknownExtensions = ignoreUnknownExtensions;

spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManager.java

@@ -139,17 +139,6 @@ public List<String> resolveFileExtensions(MediaType mediaType) {
 		return doResolveExtensions(resolver -> resolver.resolveFileExtensions(mediaType));
 	}
 
-	/**
-	 * {@inheritDoc}
-	 * <p>At startup this method returns extensions explicitly registered with
-	 * either {@link PathExtensionContentNegotiationStrategy} or
-	 * {@link ParameterContentNegotiationStrategy}. At runtime if there is a
-	 * "path extension" strategy and its
-	 * {@link PathExtensionContentNegotiationStrategy#setUseRegisteredExtensionsOnly(boolean)
-	 * useRegisteredExtensionsOnly} property is set to "false", the list of extensions may
-	 * increase as file extensions are resolved via
-	 * {@link org.springframework.http.MediaTypeFactory} and cached.
-	 */
 	@Override
 	public List<String> getAllFileExtensions() {
 		return doResolveExtensions(MediaTypeFileExtensionResolver::getAllFileExtensions);

spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java

@@ -23,16 +23,13 @@
 import java.util.Map;
 import java.util.Properties;
 
-import jakarta.servlet.ServletContext;
-
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.http.MediaType;
 import org.springframework.http.MediaTypeFactory;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.CollectionUtils;
-import org.springframework.web.context.ServletContextAware;
 
 /**
  * Factory to create a {@code ContentNegotiationManager} and configure it with
@@ -56,12 +53,6 @@
  * <td>Off</td>
  * </tr>
  * <tr>
- * <td>{@link #setFavorPathExtension favorPathExtension}</td>
- * <td>false (as of 5.3)</td>
- * <td>{@link PathExtensionContentNegotiationStrategy}</td>
- * <td>Off</td>
- * </tr>
- * <tr>
  * <td>{@link #setIgnoreAcceptHeader ignoreAcceptHeader}</td>
  * <td>false</td>
  * <td>{@link HeaderContentNegotiationStrategy}</td>
@@ -85,20 +76,11 @@
  * methods and set the exact strategies to use via
  * {@link #setStrategies(List)}.
  *
- * <p><strong>Deprecation Note:</strong> As of 5.2.4,
- * {@link #setFavorPathExtension(boolean) favorPathExtension} and
- * {@link #setIgnoreUnknownPathExtensions(boolean) ignoreUnknownPathExtensions}
- * are deprecated in order to discourage using path extensions for content
- * negotiation and for request mapping with similar deprecations on
- * {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping
- * RequestMappingHandlerMapping}. For further context, please read issue
- * <a href="https://github.com/spring-projects/spring-framework/issues/24179">#24719</a>.
  * @author Rossen Stoyanchev
  * @author Brian Clozel
  * @since 3.2
  */
-public class ContentNegotiationManagerFactoryBean
-		implements FactoryBean<ContentNegotiationManager>, ServletContextAware, InitializingBean {
+public class ContentNegotiationManagerFactoryBean implements FactoryBean<ContentNegotiationManager>, InitializingBean {
 
 	@Nullable
 	private List<ContentNegotiationStrategy> strategies;
@@ -108,12 +90,8 @@ public class ContentNegotiationManagerFactoryBean
 
 	private String parameterName = "format";
 
-	private boolean favorPathExtension = false;
-
 	private final Map<String, MediaType> mediaTypes = new HashMap<>();
 
-	private boolean ignoreUnknownPathExtensions = true;
-
 	@Nullable
 	private Boolean useRegisteredExtensionsOnly;
 
@@ -125,9 +103,6 @@ public class ContentNegotiationManagerFactoryBean
 	@Nullable
 	private ContentNegotiationManager contentNegotiationManager;
 
-	@Nullable
-	private ServletContext servletContext;
-
 
 	/**
 	 * Set the exact list of strategies to use.
@@ -161,30 +136,12 @@ public void setParameterName(String parameterName) {
 		this.parameterName = parameterName;
 	}
 
-	/**
-	 * Whether the path extension in the URL path should be used to determine
-	 * the requested media type.
-	 * <p>By default this is set to {@code false} in which case path extensions
-	 * have no impact on content negotiation.
-	 * @deprecated as of 5.2.4. See class-level note 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 void setFavorPathExtension(boolean favorPathExtension) {
-		this.favorPathExtension = favorPathExtension;
-	}
-
 	/**
 	 * Add a mapping from a key to a MediaType where the key are normalized to
 	 * lowercase and may have been extracted from a path extension, a filename
 	 * extension, or passed as a query parameter.
 	 * <p>The {@link #setFavorParameter(boolean) parameter strategy} requires
-	 * such mappings in order to work while the {@link #setFavorPathExtension(boolean)
-	 * path extension strategy} can fall back on lookups via
-	 * {@link ServletContext#getMimeType} and
-	 * {@link org.springframework.http.MediaTypeFactory}.
+	 * such mappings in order to work.
 	 * <p><strong>Note:</strong> Mappings registered here may be accessed via
 	 * {@link ContentNegotiationManager#getMediaTypeMappings()} and may be used
 	 * not only in the parameter and path extension strategies. For example,
@@ -227,35 +184,10 @@ public void addMediaTypes(@Nullable Map<String, MediaType> mediaTypes) {
 	}
 
 	/**
-	 * Whether to ignore requests with path extension that cannot be resolved
-	 * to any media type. Setting this to {@code false} will result in an
-	 * {@code HttpMediaTypeNotAcceptableException} if there is no match.
-	 * <p>By default this is set to {@code true}.
-	 * @deprecated as of 5.2.4. See class-level note on the deprecation of path
-	 * extension config options.
-	 */
-	@Deprecated
-	public void setIgnoreUnknownPathExtensions(boolean ignore) {
-		this.ignoreUnknownPathExtensions = ignore;
-	}
-
-	/**
-	 * Indicate whether to use the Java Activation Framework as a fallback option
-	 * to map from file extensions to media types.
-	 * @deprecated as of 5.0, in favor of {@link #setUseRegisteredExtensionsOnly(boolean)},
-	 * which has reverse behavior.
-	 */
-	@Deprecated
-	public void setUseJaf(boolean useJaf) {
-		setUseRegisteredExtensionsOnly(!useJaf);
-	}
-
-	/**
-	 * When {@link #setFavorPathExtension favorPathExtension} or
-	 * {@link #setFavorParameter(boolean)} is set, this property determines
+	 * When {@link #setFavorParameter(boolean)} is set, this property determines
 	 * whether to use only registered {@code MediaType} mappings or to allow
 	 * dynamic resolution, for example, via {@link MediaTypeFactory}.
-	 * <p>By default this is not set in which case dynamic resolution is on.
+	 * <p>By default, this is not set in which case dynamic resolution is on.
 	 */
 	public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) {
 		this.useRegisteredExtensionsOnly = useRegisteredExtensionsOnly;
@@ -303,14 +235,6 @@ public void setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy) {
 		this.defaultNegotiationStrategy = strategy;
 	}
 
-	/**
-	 * Invoked by Spring to inject the ServletContext.
-	 */
-	@Override
-	public void setServletContext(ServletContext servletContext) {
-		this.servletContext = servletContext;
-	}
-
 
 	@Override
 	public void afterPropertiesSet() {
@@ -321,28 +245,13 @@ public void afterPropertiesSet() {
 	 * Create and initialize a {@link ContentNegotiationManager} instance.
 	 * @since 5.0
 	 */
-	@SuppressWarnings("deprecation")
 	public ContentNegotiationManager build() {
 		List<ContentNegotiationStrategy> strategies = new ArrayList<>();
 
 		if (this.strategies != null) {
 			strategies.addAll(this.strategies);
 		}
 		else {
-			if (this.favorPathExtension) {
-				PathExtensionContentNegotiationStrategy strategy;
-				if (this.servletContext != null && !useRegisteredExtensionsOnly()) {
-					strategy = new ServletPathExtensionContentNegotiationStrategy(this.servletContext, this.mediaTypes);
-				}
-				else {
-					strategy = new PathExtensionContentNegotiationStrategy(this.mediaTypes);
-				}
-				strategy.setIgnoreUnknownExtensions(this.ignoreUnknownPathExtensions);
-				if (this.useRegisteredExtensionsOnly != null) {
-					strategy.setUseRegisteredExtensionsOnly(this.useRegisteredExtensionsOnly);
-				}
-				strategies.add(strategy);
-			}
 			if (this.favorParameter) {
 				ParameterContentNegotiationStrategy strategy = new ParameterContentNegotiationStrategy(this.mediaTypes);
 				strategy.setParameterName(this.parameterName);
@@ -367,7 +276,7 @@ public ContentNegotiationManager build() {
 		// Ensure media type mappings are available via ContentNegotiationManager#getMediaTypeMappings()
 		// independent of path extension or parameter strategies.
 
-		if (!CollectionUtils.isEmpty(this.mediaTypes) && !this.favorPathExtension && !this.favorParameter) {
+		if (!CollectionUtils.isEmpty(this.mediaTypes) && !this.favorParameter) {
 			this.contentNegotiationManager.addFileExtensionResolvers(
 					new MappingMediaTypeFileExtensionResolver(this.mediaTypes));
 		}
@@ -387,9 +296,4 @@ public Class<?> getObjectType() {
 		return ContentNegotiationManager.class;
 	}
 
-	@Override
-	public boolean isSingleton() {
-		return true;
-	}
-
 }