This method will create a {@code HttpHandler} using {@link #createHttpHandler()}, - * and use it to create a {@code ServletHttpHandlerAdapter} with the name returned by - * {@link #getServletName()}, and mapping it to the patterns - * returned from {@link #getServletMappings()}. - *
Further customization can be achieved by overriding {@link - * #customizeRegistration(ServletRegistration.Dynamic)} or + * and use it to create a {@code ServletHttpHandlerAdapter} with the name returned + * by {@link #getServletName()}, and mapping it to the patterns returned from + * {@link #getServletMappings()}. + *
Further customization can be achieved by overriding + * {@link #customizeRegistration(ServletRegistration.Dynamic)} or * {@link #createServlet(HttpHandler)}. - * @param servletContext the context to register the servlet against + * @param servletContext the context to register the servlet with */ protected void registerHandlerAdapter(ServletContext servletContext) { String servletName = getServletName(); - Assert.hasLength(servletName, "getServletName() must not return empty or null"); + Assert.hasLength(servletName, "getServletName() must not return null or empty"); HttpHandler httpHandler = createHttpHandler(); - Assert.notNull(httpHandler, "createHttpHandler() did not return a HttpHandler" + - "for servlet [" + servletName + "]"); + Assert.notNull(httpHandler, "createHttpHandler() must not return null"); ServletHttpHandlerAdapter servlet = createServlet(httpHandler); - Assert.notNull(servlet, "createHttpHandler() did not return a ServletHttpHandlerAdapter " + - "for servlet [" + servletName + "]"); + Assert.notNull(servlet, "createServlet(HttpHandler) must not return null"); ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, servlet); - Assert.notNull(registration, - "Failed to register servlet with name '" + servletName + "'." + - "Check if there is another servlet registered under the same name."); + if (registration == null) { + throw new IllegalStateException("Failed to register servlet with name '" + servletName + "'. " + + "Check if there is another servlet registered under the same name."); + } registration.setLoadOnStartup(1); registration.addMapping(getServletMappings()); @@ -101,7 +100,7 @@ public abstract class AbstractServletHttpHandlerAdapterInitializer implements We /** * Create a {@link ServletHttpHandlerAdapter} with the specified . - *
Default implementation returns a {@code ServletHttpHandlerAdapter} + *
The default implementation returns a {@code ServletHttpHandlerAdapter} * with the provided {@code httpHandler}. */ protected ServletHttpHandlerAdapter createServlet(HttpHandler httpHandler) { @@ -109,7 +108,7 @@ public abstract class AbstractServletHttpHandlerAdapterInitializer implements We } /** - * Specify the servlet mapping(s) for the {@code ServletHttpHandlerAdapter} — + * Specify the servlet mapping(s) for the {@code ServletHttpHandlerAdapter}: * for example {@code "/"}, {@code "/app"}, etc. * @see #registerHandlerAdapter(ServletContext) */ @@ -123,4 +122,5 @@ public abstract class AbstractServletHttpHandlerAdapterInitializer implements We */ protected void customizeRegistration(ServletRegistration.Dynamic registration) { } + } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java index e16494b61e..3815467129 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2017 the original author or authors. + * Copyright 2002-2018 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. @@ -17,7 +17,6 @@ package org.springframework.web.servlet.support; import java.util.EnumSet; - import javax.servlet.DispatcherType; import javax.servlet.Filter; import javax.servlet.FilterRegistration; @@ -40,7 +39,7 @@ import org.springframework.web.servlet.FrameworkServlet; * Base class for {@link org.springframework.web.WebApplicationInitializer} * implementations that register a {@link DispatcherServlet} in the servlet context. * - *
Most applications should consider extending the Spring Java config, sub-class + *
Most applications should consider extending the Spring Java config subclass * {@link AbstractAnnotationConfigDispatcherServletInitializer}. * * @author Arjen Poutsma @@ -77,20 +76,20 @@ public abstract class AbstractDispatcherServletInitializer extends AbstractConte */ protected void registerDispatcherServlet(ServletContext servletContext) { String servletName = getServletName(); - Assert.hasLength(servletName, "getServletName() must not return empty or null"); + Assert.hasLength(servletName, "getServletName() must not return null or empty"); WebApplicationContext servletAppContext = createServletApplicationContext(); - Assert.notNull(servletAppContext, - "createServletApplicationContext() did not return an application " + - "context for servlet [" + servletName + "]"); + Assert.notNull(servletAppContext, "createServletApplicationContext() must not return null"); FrameworkServlet dispatcherServlet = createDispatcherServlet(servletAppContext); + Assert.notNull(dispatcherServlet, "createDispatcherServlet(WebApplicationContext) must not return null"); dispatcherServlet.setContextInitializers(getServletApplicationContextInitializers()); ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, dispatcherServlet); - Assert.notNull(registration, - "Failed to register servlet with name '" + servletName + "'." + - "Check if there is another servlet registered under the same name."); + if (registration == null) { + throw new IllegalStateException("Failed to register servlet with name '" + servletName + "'. " + + "Check if there is another servlet registered under the same name."); + } registration.setLoadOnStartup(1); registration.addMapping(getServletMappings()); @@ -185,16 +184,19 @@ public abstract class AbstractDispatcherServletInitializer extends AbstractConte protected FilterRegistration.Dynamic registerServletFilter(ServletContext servletContext, Filter filter) { String filterName = Conventions.getVariableName(filter); Dynamic registration = servletContext.addFilter(filterName, filter); + if (registration == null) { - int counter = -1; - while (counter == -1 || registration == null) { - counter++; + int counter = 0; + while (registration == null) { + if (counter == 100) { + throw new IllegalStateException("Failed to register filter with name '" + filterName + "'. " + + "Check if there is another filter registered under the same name."); + } registration = servletContext.addFilter(filterName + "#" + counter, filter); - Assert.isTrue(counter < 100, - "Failed to register filter '" + filter + "'." + - "Could the same Filter instance have been registered already?"); + counter++; } } + registration.setAsyncSupported(isAsyncSupported()); registration.addMappingForServletNames(getDispatcherTypes(), false, getServletName()); return registration;