程序包 cn.taketoday.test.context.web

类 AbstractGenericWebContextLoader

java.lang.Object

cn.taketoday.test.context.support.AbstractContextLoader

cn.taketoday.test.context.web.AbstractGenericWebContextLoader

所有已实现的接口:

AotContextLoader, ContextLoader, SmartContextLoader

直接已知子类:

AnnotationConfigWebContextLoader, GenericXmlWebContextLoader

public abstract class AbstractGenericWebContextLoader
extends AbstractContextLoader
implements AotContextLoader

Abstract, generic extension of AbstractContextLoader that loads a GenericWebApplicationContext.

If instances of concrete subclasses are invoked via the SmartContextLoader SPI, the context will be loaded from the MergedContextConfiguration provided to loadContext(MergedContextConfiguration). In such cases, a SmartContextLoader will decide whether to load the context from locations or annotated classes. Note that AbstractGenericWebContextLoader does not support the loadContext(String... locations) method from the legacy ContextLoader SPI.

Concrete subclasses must provide an appropriate implementation of loadBeanDefinitions(cn.taketoday.web.servlet.support.GenericWebApplicationContext, cn.taketoday.test.context.web.WebMergedContextConfiguration).

从以下版本开始:

4.0

作者:

Sam Brannen, Phillip Webb, Harry Yang

另请参阅:

• loadContext(MergedContextConfiguration)
• loadContext(String...)

字段概要

字段

修饰符和类型	字段	说明
protected static final cn.taketoday.logging.Logger	logger

构造器概要

构造器

构造器	说明
AbstractGenericWebContextLoader()

方法概要

修饰符和类型	方法	说明
protected void	configureWebResources(cn.taketoday.web.servlet.support.GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig)	Configures web resources for the supplied web application context (WAC).
protected cn.taketoday.web.servlet.support.GenericWebApplicationContext	createContext()	Factory method for creating the GenericWebApplicationContext used by this ContextLoader.
protected void	customizeBeanFactory(cn.taketoday.beans.factory.support.StandardBeanFactory beanFactory, WebMergedContextConfiguration webMergedConfig)	Customize the internal bean factory of the WebApplicationContext created by this context loader.
protected void	customizeContext(cn.taketoday.web.servlet.support.GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig)	Customize the GenericWebApplicationContext created by this context loader after bean definitions have been loaded into the context but before the context is refreshed.
protected abstract void	loadBeanDefinitions(cn.taketoday.web.servlet.support.GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig)	Load bean definitions into the supplied context from the locations or classes in the supplied WebMergedContextConfiguration.
final cn.taketoday.context.ApplicationContext	loadContext(MergedContextConfiguration mergedConfig)	Load a GenericWebApplicationContext for the supplied MergedContextConfiguration.
private final cn.taketoday.web.servlet.support.GenericWebApplicationContext	loadContext(MergedContextConfiguration mergedConfig, boolean forAotProcessing)	Load a GenericWebApplicationContext for the supplied MergedContextConfiguration.
final cn.taketoday.context.ApplicationContext	loadContext(String... locations)	AbstractGenericWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader.
final cn.taketoday.web.servlet.support.GenericWebApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig)	Load a GenericWebApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration.
final cn.taketoday.web.servlet.support.GenericWebApplicationContext	loadContextForAotRuntime(MergedContextConfiguration mergedConfig, cn.taketoday.context.ApplicationContextInitializer initializer)	Load a GenericWebApplicationContext for AOT run-time execution based on the supplied MergedContextConfiguration and ApplicationContextInitializer.
protected void	validateMergedContextConfiguration(WebMergedContextConfiguration mergedConfig)	Validate the supplied WebMergedContextConfiguration with respect to what this context loader supports.

从类继承的方法 cn.taketoday.test.context.support.AbstractContextLoader

customizeContext, generateDefaultLocations, getResourceSuffix, getResourceSuffixes, isGenerateDefaultLocations, modifyLocations, prepareContext, processContextConfiguration, processLocations

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cn.taketoday.test.context.SmartContextLoader

processContextConfiguration, processLocations

字段详细资料

logger

protected static final cn.taketoday.logging.Logger logger

构造器详细资料

AbstractGenericWebContextLoader

public AbstractGenericWebContextLoader()

方法详细资料

loadContext

public final cn.taketoday.context.ApplicationContext loadContext(MergedContextConfiguration mergedConfig)
                                                          throws Exception

Load a GenericWebApplicationContext for the supplied MergedContextConfiguration.

Implementation details:

• Calls validateMergedContextConfiguration(WebMergedContextConfiguration) to allow subclasses to validate the supplied configuration before proceeding.
• Creates a GenericWebApplicationContext instance.
• If the supplied MergedContextConfiguration references a parent configuration, the corresponding ApplicationContext will be retrieved and set as the parent for the context created by this method.
• Delegates to configureWebResources(cn.taketoday.web.servlet.support.GenericWebApplicationContext, cn.taketoday.test.context.web.WebMergedContextConfiguration) to create the MockServletContext and set it in the WebApplicationContext.
• Calls AbstractContextLoader.prepareContext(cn.taketoday.context.ConfigurableApplicationContext, cn.taketoday.test.context.MergedContextConfiguration) to allow for customizing the context before bean definitions are loaded.
• Calls customizeBeanFactory(cn.taketoday.beans.factory.support.StandardBeanFactory, cn.taketoday.test.context.web.WebMergedContextConfiguration) to allow for customizing the context's StandardBeanFactory.
• Delegates to loadBeanDefinitions(cn.taketoday.web.servlet.support.GenericWebApplicationContext, cn.taketoday.test.context.web.WebMergedContextConfiguration) to populate the context from the locations or classes in the supplied MergedContextConfiguration.
• Delegates to AnnotationConfigUtils for registering annotation configuration processors.
• Calls customizeContext(cn.taketoday.web.servlet.support.GenericWebApplicationContext, cn.taketoday.test.context.web.WebMergedContextConfiguration) to allow for customizing the context before it is refreshed.
• Refreshes the context and registers a JVM shutdown hook for it.

指定者:

loadContext 在接口中 SmartContextLoader

参数:

mergedConfig - the merged context configuration to use to load the application context

返回:

a new web application context

抛出:

ContextLoadException - if context loading failed

Exception

另请参阅:

• SmartContextLoader.loadContext(MergedContextConfiguration)

loadContextForAotProcessing

public final cn.taketoday.web.servlet.support.GenericWebApplicationContext loadContextForAotProcessing(MergedContextConfiguration mergedConfig)
                                                                                                throws Exception

Load a GenericWebApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration.

In contrast to loadContext(MergedContextConfiguration), this method does not refresh the ApplicationContext or register a JVM shutdown hook for it. Otherwise, this method implements behavior identical to loadContext(MergedContextConfiguration).

指定者:

loadContextForAotProcessing 在接口中 AotContextLoader

参数:

mergedConfig - the merged context configuration to use to load the application context

返回:

a new web application context

抛出:

Exception - if context loading failed

另请参阅:

• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration)

loadContextForAotRuntime

public final cn.taketoday.web.servlet.support.GenericWebApplicationContext loadContextForAotRuntime(MergedContextConfiguration mergedConfig,
 cn.taketoday.context.ApplicationContextInitializer initializer)
                                                                                             throws Exception

Load a GenericWebApplicationContext for AOT run-time execution based on the supplied MergedContextConfiguration and ApplicationContextInitializer.

指定者:

loadContextForAotRuntime 在接口中 AotContextLoader

参数:

mergedConfig - the merged context configuration to use to load the application context

initializer - the ApplicationContextInitializer that should be applied to the context in order to recreate bean definitions

返回:

a new web application context

抛出:

Exception - if context loading failed

另请参阅:

• AotContextLoader.loadContextForAotRuntime(MergedContextConfiguration, ApplicationContextInitializer)

loadContext

private final cn.taketoday.web.servlet.support.GenericWebApplicationContext loadContext(MergedContextConfiguration mergedConfig,
 boolean forAotProcessing)
                                                                                 throws Exception

Load a GenericWebApplicationContext for the supplied MergedContextConfiguration.

参数:

mergedConfig - the merged context configuration to use to load the application context

forAotProcessing - true if the context is being loaded for AOT processing, meaning not to refresh the ApplicationContext or register a JVM shutdown hook for it

返回:

a new web application context

抛出:

Exception

另请参阅:

• SmartContextLoader.loadContext(MergedContextConfiguration)
• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration)

validateMergedContextConfiguration

protected void validateMergedContextConfiguration(WebMergedContextConfiguration mergedConfig)

Validate the supplied WebMergedContextConfiguration with respect to what this context loader supports.

The default implementation is a no-op but can be overridden by subclasses as appropriate.

参数:

mergedConfig - the merged configuration to validate

抛出:

IllegalStateException - if the supplied configuration is not valid for this context loader

createContext

protected cn.taketoday.web.servlet.support.GenericWebApplicationContext createContext()

Factory method for creating the GenericWebApplicationContext used by this ContextLoader.

The default implementation creates a GenericWebApplicationContext using the default constructor. This method may be overridden — for example, to use a custom context subclass or to create a GenericWebApplicationContext with a custom StandardBeanFactory implementation.

返回:

a newly instantiated GenericWebApplicationContext

configureWebResources

protected void configureWebResources(cn.taketoday.web.servlet.support.GenericWebApplicationContext context,
 WebMergedContextConfiguration webMergedConfig)

Configures web resources for the supplied web application context (WAC).

Implementation Details

If the supplied WAC has no parent or its parent is not a WAC, the supplied WAC will be configured as the Root WAC (see "Root WAC Configuration" below).

Otherwise the context hierarchy of the supplied WAC will be traversed to find the top-most WAC (i.e., the root); and the ServletContext of the Root WAC will be set as the ServletContext for the supplied WAC.

Root WAC Configuration

• The resource base path is retrieved from the supplied WebMergedContextConfiguration.
• A ResourceLoader is instantiated for the MockServletContext: if the resource base path is prefixed with "classpath:", a DefaultResourceLoader will be used; otherwise, a FileSystemResourceLoader will be used.
• A MockServletContext will be created using the resource base path and resource loader.
• The supplied GenericWebApplicationContext is then stored in the MockServletContext under the WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE key.
• Finally, the MockServletContext is set in the WebApplicationContext.

参数:

context - the web application context for which to configure the web resources

webMergedConfig - the merged context configuration to use to load the web application context

customizeBeanFactory

protected void customizeBeanFactory(cn.taketoday.beans.factory.support.StandardBeanFactory beanFactory,
 WebMergedContextConfiguration webMergedConfig)

Customize the internal bean factory of the WebApplicationContext created by this context loader.

The default implementation is empty but can be overridden in subclasses to customize StandardBeanFactory's standard settings.

参数:

beanFactory - the bean factory created by this context loader

webMergedConfig - the merged context configuration to use to load the web application context

另请参阅:

• loadContext(MergedContextConfiguration)
• StandardBeanFactory.setAllowBeanDefinitionOverriding(boolean)
• StandardBeanFactory.setAllowEagerClassLoading(boolean)
• AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean)
• AbstractAutowireCapableBeanFactory.setAllowRawInjectionDespiteWrapping(boolean)

loadBeanDefinitions

protected abstract void loadBeanDefinitions(cn.taketoday.web.servlet.support.GenericWebApplicationContext context,
 WebMergedContextConfiguration webMergedConfig)

Load bean definitions into the supplied context from the locations or classes in the supplied WebMergedContextConfiguration.

Concrete subclasses must provide an appropriate implementation.

参数:

context - the context into which the bean definitions should be loaded

webMergedConfig - the merged context configuration to use to load the web application context

另请参阅:

• loadContext(MergedContextConfiguration)

customizeContext

protected void customizeContext(cn.taketoday.web.servlet.support.GenericWebApplicationContext context,
 WebMergedContextConfiguration webMergedConfig)

Customize the GenericWebApplicationContext created by this context loader after bean definitions have been loaded into the context but before the context is refreshed.

The default implementation simply delegates to AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration).

参数:

context - the newly created web application context

webMergedConfig - the merged context configuration to use to load the web application context

另请参阅:

• loadContext(MergedContextConfiguration)
• AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)

loadContext

public final cn.taketoday.context.ApplicationContext loadContext(String... locations)
                                                          throws Exception

AbstractGenericWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader. Consequently, this method is not supported.

指定者:

loadContext 在接口中 ContextLoader

指定者:

loadContext 在接口中 SmartContextLoader

参数:

locations - the resource locations to use to load the application context

返回:

a new application context

抛出:

UnsupportedOperationException - in this implementation

Exception - if context loading failed

另请参阅:

• ContextLoader.loadContext(java.lang.String[])