To be used for the initialization of newly created {@link View} instances, + * applying lifecycle callbacks and providing access to the containing environment. + * @see #setViewClass + * @see #createView + * @see #applyLifecycleMethods + */ + @Override + public void setApplicationContext(ApplicationContext applicationContext) { + this.applicationContext = applicationContext; + } + + /** + * Return the containing {@code ApplicationContext}, if any. + * @see #setApplicationContext + */ + @Nullable + public ApplicationContext getApplicationContext() { + return this.applicationContext; + } + @Override public void afterPropertiesSet() throws Exception { @@ -207,7 +234,7 @@ public class UrlBasedViewResolver extends ViewResolverSupport implements ViewRes urlBasedView = this.redirectViewProvider.apply(redirectUrl); } else { - urlBasedView = createUrlBasedView(viewName); + urlBasedView = createView(viewName); } View view = applyLifecycleMethods(viewName, urlBasedView); @@ -220,10 +247,9 @@ public class UrlBasedViewResolver extends ViewResolverSupport implements ViewRes } /** - * Indicates whether or not this {@link ViewResolver} can handle the - * supplied view name. If not, an empty result is returned. The default - * implementation checks against the configured {@link #setViewNames - * view names}. + * Indicates whether or not this {@link ViewResolver} can handle the supplied + * view name. If not, an empty result is returned. The default implementation + * checks against the configured {@link #setViewNames view names}. * @param viewName the name of the view to retrieve * @param locale the Locale to retrieve the view for * @return whether this resolver applies to the specified view @@ -238,15 +264,14 @@ public class UrlBasedViewResolver extends ViewResolverSupport implements ViewRes * Creates a new View instance of the specified view class and configures it. * Does not perform any lookup for pre-defined View instances. *
Spring lifecycle methods as defined by the bean container do not have to - * be called here; those will be applied by the {@code loadView} method - * after this method returns. - *
Subclasses will typically call {@code super.buildView(viewName)} - * first, before setting further properties themselves. {@code loadView} - * will then apply Spring lifecycle methods at the end of this process. + * be called here: They will be automatically applied afterwards, provided + * that an {@link #setApplicationContext ApplicationContext} is available. * @param viewName the name of the view to build * @return the View instance + * @see #getViewClass() + * @see #applyLifecycleMethods */ - protected AbstractUrlBasedView createUrlBasedView(String viewName) { + protected AbstractUrlBasedView createView(String viewName) { Class viewClass = getViewClass(); Assert.state(viewClass != null, "No view class"); @@ -259,7 +284,19 @@ public class UrlBasedViewResolver extends ViewResolverSupport implements ViewRes return view; } - private View applyLifecycleMethods(String viewName, AbstractView view) { + /** + * Apply the containing {@link ApplicationContext}'s lifecycle methods + * to the given {@link View} instance, if such a context is available. + * @param viewName the name of the view + * @param view the freshly created View instance, pre-configured with + * {@link AbstractUrlBasedView}'s properties + * @return the {@link View} instance to use (either the original one + * or a decorated variant) + * @see #getApplicationContext() + * @see ApplicationContext#getAutowireCapableBeanFactory() + * @see org.springframework.beans.factory.config.AutowireCapableBeanFactory#initializeBean + */ + protected View applyLifecycleMethods(String viewName, AbstractUrlBasedView view) { ApplicationContext context = getApplicationContext(); if (context != null) { Object initialized = context.getAutowireCapableBeanFactory().initializeBean(view, viewName); diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/ViewResolverSupport.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/ViewResolverSupport.java index 3436848d7f..e8ed8636a1 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/ViewResolverSupport.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/ViewResolverSupport.java @@ -21,8 +21,6 @@ import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; -import org.springframework.context.ApplicationContext; -import org.springframework.context.ApplicationContextAware; import org.springframework.core.Ordered; import org.springframework.http.MediaType; import org.springframework.lang.Nullable; @@ -32,9 +30,10 @@ import org.springframework.util.Assert; * Base class for {@code ViewResolver} implementations with shared properties. * * @author Rossen Stoyanchev + * @author Juergen Hoeller * @since 5.0 */ -public abstract class ViewResolverSupport implements ApplicationContextAware, Ordered { +public abstract class ViewResolverSupport implements Ordered { public static final MediaType DEFAULT_CONTENT_TYPE = MediaType.parseMediaType("text/html;charset=UTF-8"); @@ -43,8 +42,6 @@ public abstract class ViewResolverSupport implements ApplicationContextAware, Or private Charset defaultCharset = StandardCharsets.UTF_8; - private ApplicationContext applicationContext; - private int order = Integer.MAX_VALUE; @@ -91,19 +88,8 @@ public abstract class ViewResolverSupport implements ApplicationContextAware, Or } - @Override - public void setApplicationContext(ApplicationContext applicationContext) { - this.applicationContext = applicationContext; - } - - @Nullable - public ApplicationContext getApplicationContext() { - return this.applicationContext; - } - /** - * Set the order in which this {@link ViewResolver} - * is evaluated. + * Set the order in which this {@link ViewResolver} is evaluated. */ public void setOrder(int order) { this.order = order; diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/UrlBasedViewResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/UrlBasedViewResolver.java index 4566c11837..4b683bcd4d 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/UrlBasedViewResolver.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/UrlBasedViewResolver.java @@ -516,17 +516,6 @@ public class UrlBasedViewResolver extends AbstractCachingViewResolver implements return (view.checkResource(locale) ? result : null); } - private View applyLifecycleMethods(String viewName, AbstractView view) { - ApplicationContext context = getApplicationContext(); - if (context != null) { - Object initialized = context.getAutowireCapableBeanFactory().initializeBean(view, viewName); - if (initialized instanceof View) { - return (View) initialized; - } - } - return view; - } - /** * Creates a new View instance of the specified view class and configures it. * Does not perform any lookup for pre-defined View instances. @@ -572,4 +561,28 @@ public class UrlBasedViewResolver extends AbstractCachingViewResolver implements return view; } + /** + * Apply the containing {@link ApplicationContext}'s lifecycle methods + * to the given {@link View} instance, if such a context is available. + * @param viewName the name of the view + * @param view the freshly created View instance, pre-configured with + * {@link AbstractUrlBasedView}'s properties + * @return the {@link View} instance to use (either the original one + * or a decorated variant) + * @since 5.0 + * @see #getApplicationContext() + * @see ApplicationContext#getAutowireCapableBeanFactory() + * @see org.springframework.beans.factory.config.AutowireCapableBeanFactory#initializeBean + */ + protected View applyLifecycleMethods(String viewName, AbstractUrlBasedView view) { + ApplicationContext context = getApplicationContext(); + if (context != null) { + Object initialized = context.getAutowireCapableBeanFactory().initializeBean(view, viewName); + if (initialized instanceof View) { + return (View) initialized; + } + } + return view; + } + }