From ab5f1256bfc499dfcbca1f5468aaafb188d9f5dd Mon Sep 17 00:00:00 2001 From: Rossen Stoyanchev Date: Fri, 24 Jan 2014 11:09:12 -0500 Subject: [PATCH] Allow consolidating config in root context with Java This change makes it possible to provide no configuration for the DispatcherServlet when extending AbstractAnnotationConfigDispatcherServletInitializer, and therefore provide all config through the "root" context. Issue: SPR-11357 --- ...ionConfigDispatcherServletInitializer.java | 19 +++---- ...nfigDispatcherServletInitializerTests.java | 56 ++++++++++++++----- 2 files changed, 49 insertions(+), 26 deletions(-) diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java index 5de7a62f05..d71d6c076e 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2013 the original author or authors. + * Copyright 2002-2014 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. @@ -50,8 +50,7 @@ public abstract class AbstractAnnotationConfigDispatcherServletInitializer protected WebApplicationContext createRootApplicationContext() { Class[] rootConfigClasses = this.getRootConfigClasses(); if (!ObjectUtils.isEmpty(rootConfigClasses)) { - AnnotationConfigWebApplicationContext rootAppContext = - new AnnotationConfigWebApplicationContext(); + AnnotationConfigWebApplicationContext rootAppContext = new AnnotationConfigWebApplicationContext(); rootAppContext.register(rootConfigClasses); return rootAppContext; } @@ -64,18 +63,14 @@ public abstract class AbstractAnnotationConfigDispatcherServletInitializer * {@inheritDoc} *

This implementation creates an {@link AnnotationConfigWebApplicationContext}, * providing it the annotated classes returned by {@link #getServletConfigClasses()}. - * @throws IllegalArgumentException if {@link #getServletConfigClasses()} returns - * empty or {@code null} */ @Override protected WebApplicationContext createServletApplicationContext() { - AnnotationConfigWebApplicationContext servletAppContext = - new AnnotationConfigWebApplicationContext(); - Class[] servletConfigClasses = this.getServletConfigClasses(); - Assert.notEmpty(servletConfigClasses, - "getServletConfigClasses() did not return any configuration classes"); - - servletAppContext.register(servletConfigClasses); + AnnotationConfigWebApplicationContext servletAppContext = new AnnotationConfigWebApplicationContext(); + Class[] configClasses = this.getServletConfigClasses(); + if (!ObjectUtils.isEmpty(configClasses)) { + servletAppContext.register(configClasses); + } return servletAppContext; } diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/support/AnnotationConfigDispatcherServletInitializerTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/support/AnnotationConfigDispatcherServletInitializerTests.java index f19be0235a..a560e48535 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/support/AnnotationConfigDispatcherServletInitializerTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/support/AnnotationConfigDispatcherServletInitializerTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2012 the original author or authors. + * Copyright 2002-2014 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. @@ -21,22 +21,16 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; -import java.util.Collections; -import java.util.EnumSet; -import java.util.LinkedHashMap; -import java.util.Map; +import java.util.*; -import javax.servlet.DispatcherType; -import javax.servlet.Filter; +import javax.servlet.*; import javax.servlet.FilterRegistration.Dynamic; -import javax.servlet.Servlet; -import javax.servlet.ServletException; -import javax.servlet.ServletRegistration; import org.junit.Before; import org.junit.Test; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.mock.web.test.MockServletConfig; import org.springframework.mock.web.test.MockServletContext; import org.springframework.web.context.WebApplicationContext; import org.springframework.web.context.support.AnnotationConfigWebApplicationContext; @@ -89,11 +83,11 @@ public class AnnotationConfigDispatcherServletInitializerTests { assertNotNull(servlets.get(SERVLET_NAME)); DispatcherServlet servlet = (DispatcherServlet) servlets.get(SERVLET_NAME); - WebApplicationContext dispatcherServletContext = servlet.getWebApplicationContext(); - ((AnnotationConfigWebApplicationContext) dispatcherServletContext).refresh(); + WebApplicationContext wac = servlet.getWebApplicationContext(); + ((AnnotationConfigWebApplicationContext) wac).refresh(); - assertTrue(dispatcherServletContext.containsBean("bean")); - assertTrue(dispatcherServletContext.getBean("bean") instanceof MyBean); + assertTrue(wac.containsBean("bean")); + assertTrue(wac.getBean("bean") instanceof MyBean); assertEquals(1, servletRegistrations.size()); assertNotNull(servletRegistrations.get(SERVLET_NAME)); @@ -135,6 +129,33 @@ public class AnnotationConfigDispatcherServletInitializerTests { filterRegistration.getMappings().get(SERVLET_NAME)); } + // SPR-11357 + + @Test + public void rootContextOnly() throws ServletException { + initializer = new MyAnnotationConfigDispatcherServletInitializer() { + @Override + protected Class[] getRootConfigClasses() { + return new Class[]{MyConfiguration.class}; + } + @Override + protected Class[] getServletConfigClasses() { + return null; + } + }; + + initializer.onStartup(servletContext); + + DispatcherServlet servlet = (DispatcherServlet) servlets.get(SERVLET_NAME); + servlet.init(new MockServletConfig(this.servletContext)); + + WebApplicationContext wac = servlet.getWebApplicationContext(); + ((AnnotationConfigWebApplicationContext) wac).refresh(); + + assertTrue(wac.containsBean("bean")); + assertTrue(wac.getBean("bean") instanceof MyBean); + } + @Test public void noFilters() throws ServletException { initializer = new MyAnnotationConfigDispatcherServletInitializer() { @@ -167,6 +188,13 @@ public class AnnotationConfigDispatcherServletInitializerTests { filterRegistrations.put(filterName, registration); return registration; } + + @Override + public void addListener(T t) { + if (t instanceof ServletContextListener) { + ((ServletContextListener) t).contextInitialized(new ServletContextEvent(this)); + } + } } private static class MyAnnotationConfigDispatcherServletInitializer