From 6a26db80b60819c949c720a0d444e4f44ccce3a6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Deleuze?= <sdeleuze@vmware.com>
Date: Tue, 13 Jun 2023 08:17:54 +0200
Subject: [PATCH] Refine RouterFunctionMapping ordering consistency

This commit changes the order of RouterFunctionMapping defined
in WebMvcConfigurationSupport from 3 to -1 in order to achieve
better consistency between WebMVC and WebFlux. It also reduces
the surprise factor. That way, functional routes are always
before annotation-based ones.

Closes gh-30278
---
 .../config/annotation/WebMvcConfigurationSupport.java     | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java
index 198f4492ed7..ae6ce3e62d2 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java
@@ -121,14 +121,14 @@ import org.springframework.web.util.pattern.PathPatternParser;
  *
  * <p>This class registers the following {@link HandlerMapping HandlerMappings}:</p>
  * <ul>
+ * <li>{@link RouterFunctionMapping}
+ * ordered at -1 to map {@linkplain org.springframework.web.servlet.function.RouterFunction router functions}.
  * <li>{@link RequestMappingHandlerMapping}
  * ordered at 0 for mapping requests to annotated controller methods.
  * <li>{@link HandlerMapping}
  * ordered at 1 to map URL paths directly to view names.
  * <li>{@link BeanNameUrlHandlerMapping}
  * ordered at 2 to map URL paths to controller bean names.
- * <li>{@link RouterFunctionMapping}
- * ordered at 3 to map {@linkplain org.springframework.web.servlet.function.RouterFunction router functions}.
  * <li>{@link HandlerMapping}
  * ordered at {@code Integer.MAX_VALUE-1} to serve static resource requests.
  * <li>{@link HandlerMapping}
@@ -535,7 +535,7 @@ public class WebMvcConfigurationSupport implements ApplicationContextAware, Serv
 	}
 
 	/**
-	 * Return a {@link RouterFunctionMapping} ordered at 3 to map
+	 * Return a {@link RouterFunctionMapping} ordered at -1 to map
 	 * {@linkplain org.springframework.web.servlet.function.RouterFunction router functions}.
 	 * Consider overriding one of these other more fine-grained methods:
 	 * <ul>
@@ -552,7 +552,7 @@ public class WebMvcConfigurationSupport implements ApplicationContextAware, Serv
 			@Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {
 
 		RouterFunctionMapping mapping = new RouterFunctionMapping();
-		mapping.setOrder(3);
+		mapping.setOrder(-1);  // go before RequestMappingHandlerMapping
 		mapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider));
 		mapping.setCorsConfigurations(getCorsConfigurations());
 		mapping.setMessageConverters(getMessageConverters());