DATACMNS-330, DATACMNS-331 - Improved web configuration support.

Updated backing implementation of @EnableSpringDataWebSupport to use WebMvcConfigurerAdapter instead of WebMvcConfigurationSupport as the latter is a very custom beast in terms of configuration. Let the Spring HATEOAS specific configuration class extend the default one to register additional components. The default one accesses the FormattingConversionService through a qualified autowiring. It issues a warning in case none has been configured and asks the user to enable Spring MVC.

Updated Sonargraph architecture description to allow logging from web config layer.

Author: odrotbohm

Spring Data Commons.sonargraph

@@ -10,11 +10,14 @@
                     <element type="TypeFilter" name="Assignment">
                         <element type="IncludeTypePattern" name="**.config.**"/>
                     </element>
+                    <dependency toName="External|External::Subsystem|Logging" type="AllowedDependency"/>
                     <dependency toName="Project|spring-data-commons::Layer|Repositories::Subsystem|Support" type="AllowedDependency"/>
+                    <dependency toName="External|External::Subsystem|Spring" type="AllowedDependency"/>
                 </element>
-                <dependency toName="External|External" type="AllowedDependency"/>
                 <dependency toName="Project|spring-data-commons::Layer|Application" type="AllowedDependency"/>
+                <dependency toName="Project|spring-data-commons::Layer|Repositories" type="AllowedDependency"/>
                 <dependency toName="External|External::Subsystem|Java Beans" type="AllowedDependency"/>
+                <dependency toName="External|External::Subsystem|Logging" type="AllowedDependency"/>
                 <dependency toName="External|External::Subsystem|Reflection" type="AllowedDependency"/>
                 <dependency toName="External|External::Subsystem|Servlet API" type="AllowedDependency"/>
                 <dependency toName="External|External::Subsystem|Spring" type="AllowedDependency"/>
@@ -154,6 +157,12 @@
                     </element>
                     <stereotype name="Unrestricted"/>
                 </element>
+                <element type="Subsystem" name="Transactions">
+                    <element type="TypeFilter" name="Assignment">
+                        <element type="IncludeTypePattern" name="**.transaction.**"/>
+                    </element>
+                    <stereotype name="Unrestricted"/>
+                </element>
                 <dependency toName="Project|spring-data-commons::Layer|Application" type="AllowedDependency"/>
             </element>
             <element type="Layer" name="Application">
@@ -278,7 +287,7 @@
             </element>
             <element type="Subsystem" name="Logging">
                 <element type="TypeFilter" name="Assignment">
-                    <element type="IncludeTypePattern" name="org.slf4j.**"/>
+                    <element type="IncludeTypePattern" name="org.slf4j.*"/>
                 </element>
             </element>
             <element type="Subsystem" name="AOP">

src/main/java/org/springframework/data/web/config/EnableSpringDataWebSupport.java

@@ -20,8 +20,6 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import java.util.ArrayList;
-import java.util.List;
 
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.ImportSelector;
@@ -84,15 +82,8 @@ class SpringDataWebConfigurationImportSelector implements ImportSelector {
 		 */
 		@Override
 		public String[] selectImports(AnnotationMetadata importingClassMetadata) {
-
-			List<String> configs = new ArrayList<String>();
-
-			if (HATEOAS_PRESENT) {
-				configs.add(HateoasAwareSpringDataWebConfiguration.class.getName());
-			}
-
-			configs.add(SpringDataWebConfiguration.class.getName());
-			return configs.toArray(new String[configs.size()]);
+			return new String[] { HATEOAS_PRESENT ? HateoasAwareSpringDataWebConfiguration.class.getName()
+					: SpringDataWebConfiguration.class.getName() };
 		}
 	}
 }

src/main/java/org/springframework/data/web/config/HateoasAwareSpringDataWebConfiguration.java

@@ -17,13 +17,11 @@
 
 import java.util.List;
 
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.web.PagedResourcesAssembler;
 import org.springframework.data.web.PagedResourcesAssemblerArgumentResolver;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
-import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
 
 /**
  * JavaConfig class to register {@link PagedResourcesAssembler} and {@link PagedResourcesAssemblerArgumentResolver}.
@@ -32,28 +30,25 @@
  * @author Oliver Gierke
  */
 @Configuration
-class HateoasAwareSpringDataWebConfiguration extends WebMvcConfigurationSupport {
-
-	@Autowired
-	SpringDataWebConfiguration config;
+class HateoasAwareSpringDataWebConfiguration extends SpringDataWebConfiguration {
 
 	@Bean
 	public PagedResourcesAssembler<?> pagedResourcesAssembler() {
-		return new PagedResourcesAssembler<Object>(config.pageableResolver(), null);
+		return new PagedResourcesAssembler<Object>(pageableResolver(), null);
 	}
 
 	@Bean
 	public PagedResourcesAssemblerArgumentResolver pagedResourcesAssemblerArgumentResolver() {
-		return new PagedResourcesAssemblerArgumentResolver(config.pageableResolver(), null);
+		return new PagedResourcesAssemblerArgumentResolver(pageableResolver(), null);
 	}
 
 	/* 
 	 * (non-Javadoc)
 	 * @see org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport#addArgumentResolvers(java.util.List)
 	 */
 	@Override
-	protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
-		config.addArgumentResolvers(argumentResolvers);
+	public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
+		super.addArgumentResolvers(argumentResolvers);
 		argumentResolvers.add(pagedResourcesAssemblerArgumentResolver());
 	}
 }

src/main/java/org/springframework/data/web/config/SpringDataWebConfiguration.java

@@ -17,14 +17,18 @@
 
 import java.util.List;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.repository.support.DomainClassConverter;
 import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
 import org.springframework.data.web.SortHandlerMethodArgumentResolver;
 import org.springframework.format.support.FormattingConversionService;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
-import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
 /**
  * Configuration class to register {@link PageableHandlerMethodArgumentResolver},
@@ -34,7 +38,13 @@
  * @author Oliver Gierke
  */
 @Configuration
-class SpringDataWebConfiguration extends WebMvcConfigurationSupport {
+class SpringDataWebConfiguration extends WebMvcConfigurerAdapter {
+
+	private static final Logger LOGGER = LoggerFactory.getLogger(SpringDataWebConfiguration.class);
+
+	@Autowired(required = false)
+	@Qualifier("mvcConversionService")
+	FormattingConversionService conversionService;
 
 	@Bean
 	public PageableHandlerMethodArgumentResolver pageableResolver() {
@@ -48,7 +58,16 @@ public SortHandlerMethodArgumentResolver sortResolver() {
 
 	@Bean
 	public DomainClassConverter<FormattingConversionService> mvcDomainClassConverter() {
-		return new DomainClassConverter<FormattingConversionService>(mvcConversionService());
+
+		if (conversionService == null) {
+
+			LOGGER.warn("No default Spring MVC FormattingConversionService registered! Have you forgotten to "
+					+ "use @EnableWebMvc or register a configuration class extending WebMvcConfigurationSupport?");
+
+			return null;
+		}
+
+		return new DomainClassConverter<FormattingConversionService>(conversionService);
 	}
 
 	/* 

src/test/java/org/springframework/data/web/config/EnableSpringDataWebSupportIntegrationTests.java

@@ -35,6 +35,7 @@
 import org.springframework.data.web.config.EnableSpringDataWebSupport.SpringDataWebConfigurationImportSelector;
 import org.springframework.util.ReflectionUtils;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
 
 /**
@@ -46,6 +47,7 @@
 public class EnableSpringDataWebSupportIntegrationTests {
 
 	@Configuration
+	@EnableWebMvc
 	@EnableSpringDataWebSupport
 	static class SampleConfig {