Refine DispatcherServletPathProvider creation

Closes gh-13527

Author: mbhave

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/DispatcherServletAutoConfiguration.java

@@ -33,6 +33,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
 import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
@@ -116,12 +117,6 @@ public MultipartResolver multipartResolver(MultipartResolver resolver) {
 			return resolver;
 		}
 
-		@Bean
-		public DispatcherServletPathProvider mainDispatcherServletPathProvider() {
-			return () -> DispatcherServletConfiguration.this.serverProperties.getServlet()
-					.getPath();
-		}
-
 	}
 
 	@Configuration
@@ -161,6 +156,14 @@ public ServletRegistrationBean<DispatcherServlet> dispatcherServletRegistration(
 			return registration;
 		}
 
+		@Bean
+		@ConditionalOnMissingBean(DispatcherServletPathProvider.class)
+		@ConditionalOnSingleCandidate(DispatcherServlet.class)
+		public DispatcherServletPathProvider dispatcherServletPathProvider() {
+			return () -> DispatcherServletRegistrationConfiguration.this.serverProperties
+					.getServlet().getPath();
+		}
+
 	}
 
 	@Order(Ordered.LOWEST_PRECEDENCE - 10)

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/servlet/DispatcherServletAutoConfigurationTests.java

@@ -35,6 +35,7 @@
 import org.springframework.web.servlet.DispatcherServlet;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
 
 /**
  * Tests for {@link DispatcherServletAutoConfiguration}.
@@ -65,6 +66,8 @@ public void registrationNonServletBean() {
 				.run((context) -> {
 					assertThat(context).doesNotHaveBean(ServletRegistrationBean.class);
 					assertThat(context).doesNotHaveBean(DispatcherServlet.class);
+					assertThat(context)
+							.doesNotHaveBean(DispatcherServletPathProvider.class);
 				});
 	}
 
@@ -73,7 +76,8 @@ public void registrationNonServletBean() {
 	@Test
 	public void registrationOverrideWithDispatcherServletWrongName() {
 		this.contextRunner
-				.withUserConfiguration(CustomDispatcherServletDifferentName.class)
+				.withUserConfiguration(CustomDispatcherServletDifferentName.class,
+						CustomDispatcherServletPathProvider.class)
 				.run((context) -> {
 					ServletRegistrationBean<?> registration = context
 							.getBean(ServletRegistrationBean.class);
@@ -86,8 +90,8 @@ public void registrationOverrideWithDispatcherServletWrongName() {
 
 	@Test
 	public void registrationOverrideWithAutowiredServlet() {
-		this.contextRunner.withUserConfiguration(CustomAutowiredRegistration.class)
-				.run((context) -> {
+		this.contextRunner.withUserConfiguration(CustomAutowiredRegistration.class,
+				CustomDispatcherServletPathProvider.class).run((context) -> {
 					ServletRegistrationBean<?> registration = context
 							.getBean(ServletRegistrationBean.class);
 					assertThat(registration.getUrlMappings()).containsExactly("/foo");
@@ -112,6 +116,40 @@ public void servletPath() {
 				});
 	}
 
+	@Test
+	public void pathProviderNotCreatedWhenMultipleDispatcherServletsPresent() {
+		this.contextRunner
+				.withUserConfiguration(CustomDispatcherServletDifferentName.class)
+				.run((context) -> assertThat(context)
+						.doesNotHaveBean(DispatcherServletPathProvider.class));
+	}
+
+	@Test
+	public void pathProviderWhenCustomDispatcherServletSameNameShouldReturnConfiguredServletPath() {
+		this.contextRunner.withUserConfiguration(CustomDispatcherServletSameName.class)
+				.withPropertyValues("server.servlet.path:/spring")
+				.run((context) -> assertThat(context
+						.getBean(DispatcherServletPathProvider.class).getServletPath())
+								.isEqualTo("/spring"));
+	}
+
+	@Test
+	public void pathProviderNotCreatedWhenDefaultDispatcherServletNotAvailable() {
+		this.contextRunner
+				.withUserConfiguration(CustomDispatcherServletDifferentName.class,
+						NonServletConfiguration.class)
+				.run((context) -> assertThat(context)
+						.doesNotHaveBean(DispatcherServletPathProvider.class));
+	}
+
+	@Test
+	public void pathProviderNotCreatedWhenCustomRegistrationBeanPresent() {
+		this.contextRunner
+				.withUserConfiguration(CustomDispatcherServletRegistration.class)
+				.run((context) -> assertThat(context)
+						.doesNotHaveBean(DispatcherServletPathProvider.class));
+	}
+
 	@Test
 	public void multipartConfig() {
 		this.contextRunner.withUserConfiguration(MultipartConfiguration.class)
@@ -198,6 +236,16 @@ public DispatcherServlet customDispatcherServlet() {
 
 	}
 
+	@Configuration
+	protected static class CustomDispatcherServletPathProvider {
+
+		@Bean
+		public DispatcherServletPathProvider dispatcherServletPathProvider() {
+			return mock(DispatcherServletPathProvider.class);
+		}
+
+	}
+
 	@Configuration
 	protected static class CustomAutowiredRegistration {
 
@@ -210,6 +258,11 @@ public ServletRegistrationBean<?> dispatcherServletRegistration(
 			return registration;
 		}
 
+		@Bean
+		public DispatcherServletPathProvider dispatcherServletPathProvider() {
+			return mock(DispatcherServletPathProvider.class);
+		}
+
 	}
 
 	@Configuration
@@ -232,6 +285,30 @@ public MultipartResolver getMultipartResolver() {
 
 	}
 
+	@Configuration
+	protected static class CustomDispatcherServletSameName {
+
+		@Bean(name = DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
+		public DispatcherServlet dispatcherServlet() {
+			return new DispatcherServlet();
+		}
+
+	}
+
+	@Configuration
+	protected static class CustomDispatcherServletRegistration {
+
+		@Bean(name = DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
+		public ServletRegistrationBean<DispatcherServlet> dispatcherServletRegistration(
+				DispatcherServlet dispatcherServlet) {
+			ServletRegistrationBean<DispatcherServlet> registration = new ServletRegistrationBean<>(
+					dispatcherServlet, "/foo");
+			registration.setName("customDispatcher");
+			return registration;
+		}
+
+	}
+
 	private static class MockMultipartResolver implements MultipartResolver {
 
 		@Override