Spring Context作成
スプリングフレームワークを使用する場合、web.xmlのプロファイルには、次のコメントが追加されます.
上記のプロファイルから分かるようにspringコンテナのロードと作成はorg.springframework.web.context.ContextLoaderListenerが開始しました.
ContextLoaderListenerはサーブレットContextListenerインタフェースを実現しており、サーブレットContextListenerはサーブレットのリスナーであり、サーブレットEventを傍受していることはよく知られています.
Webをロードします.xmlの場合、まずListenerがロードされ、ContextLoaderListenerはサーブレットContextListenerの抽象的なメソッドを実現しますcontextInitialized()、contextDestroyed()
Springコンテナの作成はメソッドcontextInitialized()で行い、contextInitialized()のコードは次のとおりです.
createContextLoader()メソッドは破棄されnullが返されるので、実際の作成はinitWebApplicationContextメソッドで完了します.
initWebApplicationContextメソッドの実装:
まずメソッドに入ります:c r e a t e w ebApplicationContext()
現在のメソッドはdetermineContextClass()メソッドに入ります.
WebでxmlではcontextClassという構成項目を構成することはめったにありませんので、コードは分岐します2、defaultStrategiesの内容は何ですか?
ContextLoaderには次のコードがあります.
DEFAULT_STRATEGIES_PATHはContextLoader.properties、すなわちorg.springframework.web.ContextLoader.properties
ContextLoader.propertiesの内容は次のとおりです.
したがって、determineContextClass()メソッドの戻り値はXmlWebApplicationContext.classです.
したがって、メソッドcreateWebApplicationContext()では、XmlWebApplicationContext.classに基づいてXmlWebApplicationContextオブジェクトを作成します.
メソッドに戻ります
次にcontextに親contextを設定し、contextを構成してリフレッシュし、メソッドconfigureAndRefreshWebApplicationContext()に進みます.
方法configureAndRefreshWebApplicationContext
customizeContext(sc, wac);とwac.refresh();何をしましたか.
CustomizeContext(sc,wac)コードは次のとおりです.
まず、コードはメソッドd e t e r m i n e ContextInitializerClasses(servletContext)に入ります.determineContextInitializerClassesメソッドコードは次のとおりです.
上記のように、まずwebから.xmlのプロファイルで名前がCONTEXT_を検索INITIALIZER_CLASSES_PARAM(contextInitializerClasses)のコンフィギュレーションアイテムは、一般的にはコンフィギュレーションアイテムをコンフィギュレーションしませんので、classNamesはnullなので、上記の方法では空のlistを返し、メソッドcustomizeContext()に戻り、listは空なので、メソッドcustomizeContext()の戻り値は空です.
では、最後の方法に入ります.wac.refresh();コード:
上記のコードから分かるように、contextのロード構成項目、初期化、beanFactoryの作成はこの方法で完了します.
<!-- spring -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring/spring.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
上記のプロファイルから分かるようにspringコンテナのロードと作成はorg.springframework.web.context.ContextLoaderListenerが開始しました.
public class ContextLoaderListener extends ContextLoader implements ServletContextListener
ContextLoaderListenerはサーブレットContextListenerインタフェースを実現しており、サーブレットContextListenerはサーブレットのリスナーであり、サーブレットEventを傍受していることはよく知られています.
Webをロードします.xmlの場合、まずListenerがロードされ、ContextLoaderListenerはサーブレットContextListenerの抽象的なメソッドを実現しますcontextInitialized()、contextDestroyed()
Springコンテナの作成はメソッドcontextInitialized()で行い、contextInitialized()のコードは次のとおりです.
public void contextInitialized(ServletContextEvent event) {
this.contextLoader = createContextLoader();
if (this.contextLoader == null) {
this.contextLoader = this;
}
this.contextLoader.initWebApplicationContext(event.getServletContext());
}
createContextLoader()メソッドは破棄されnullが返されるので、実際の作成はinitWebApplicationContextメソッドで完了します.
initWebApplicationContextメソッドの実装:
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
throw new IllegalStateException(
"Cannot initialize context because there is already a root application context present - " +
"check whether you have multiple ContextLoader* definitions in your web.xml!");
}
Log logger = LogFactory.getLog(ContextLoader.class);
servletContext.log("Initializing Spring root WebApplicationContext");
if (logger.isInfoEnabled()) {
logger.info("Root WebApplicationContext: initialization started");
}
long startTime = System.currentTimeMillis();
try {
// Store context in local instance variable, to guarantee that
// it is available on ServletContext shutdown.
// WebApplicationContext
if (this.context == null) {
this.context = createWebApplicationContext(servletContext);
}
if (this.context instanceof ConfigurableWebApplicationContext) {// context
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
if (!cwac.isActive()) {
// The context has not yet been refreshed -> provide services such as
// setting the parent context, setting the application context id, etc
if (cwac.getParent() == null) {
// The context instance was injected without an explicit parent ->
// determine parent for root web application context, if any.
ApplicationContext parent = loadParentContext(servletContext);// context
cwac.setParent(parent);
}
// context
configureAndRefreshWebApplicationContext(cwac, servletContext);
}
}
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
ClassLoader ccl = Thread.currentThread().getContextClassLoader();
if (ccl == ContextLoader.class.getClassLoader()) {
currentContext = this.context;
}
else if (ccl != null) {
currentContextPerThread.put(ccl, this.context);
}
if (logger.isDebugEnabled()) {
logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +
WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
}
if (logger.isInfoEnabled()) {
long elapsedTime = System.currentTimeMillis() - startTime;
logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
}
return this.context;
}
catch (RuntimeException ex) {
logger.error("Context initialization failed", ex);
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
throw ex;
}
catch (Error err) {
logger.error("Context initialization failed", err);
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
throw err;
}
}
まずメソッドに入ります:c r e a t e w ebApplicationContext()
protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
// context
Class<?> contextClass = determineContextClass(sc);
if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
throw new ApplicationContextException("Custom context class [" + contextClass.getName() +
"] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
}
return (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
}
現在のメソッドはdetermineContextClass()メソッドに入ります.
protected Class<?> determineContextClass(ServletContext servletContext) {
// web.xml CONTEXT_CLASS_PARAM “contextClass”
String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
if (contextClassName != null) {// 1
try {
return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
}
catch (ClassNotFoundException ex) {
throw new ApplicationContextException(
"Failed to load custom context class [" + contextClassName + "]", ex);
}
}
else {// 2
contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());
try {
return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
}
catch (ClassNotFoundException ex) {
throw new ApplicationContextException(
"Failed to load default context class [" + contextClassName + "]", ex);
}
}
}
WebでxmlではcontextClassという構成項目を構成することはめったにありませんので、コードは分岐します2、defaultStrategiesの内容は何ですか?
ContextLoaderには次のコードがあります.
private static final Properties defaultStrategies;
static {
// Load default strategy implementations from properties file.
// This is currently strictly internal and not meant to be customized
// by application developers.
try {
// DEFAULT_STRATEGIES_PATH ,
ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, ContextLoader.class);
defaultStrategies = PropertiesLoaderUtils.loadProperties(resource);
}
catch (IOException ex) {
throw new IllegalStateException("Could not load 'ContextLoader.properties': " + ex.getMessage());
}
}
DEFAULT_STRATEGIES_PATHはContextLoader.properties、すなわちorg.springframework.web.ContextLoader.properties
ContextLoader.propertiesの内容は次のとおりです.
# Default WebApplicationContext implementation class for ContextLoader.
# Used as fallback when no explicit context implementation has been specified as context-param.
# Not meant to be customized by application developers.
org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext
したがって、determineContextClass()メソッドの戻り値はXmlWebApplicationContext.classです.
したがって、メソッドcreateWebApplicationContext()では、XmlWebApplicationContext.classに基づいてXmlWebApplicationContextオブジェクトを作成します.
メソッドに戻ります
次にcontextに親contextを設定し、contextを構成してリフレッシュし、メソッドconfigureAndRefreshWebApplicationContext()に進みます.
方法configureAndRefreshWebApplicationContext
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
// The application context id is still set to its original default value
// -> assign a more useful id based on available information
String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
// id
if (idParam != null) {
wac.setId(idParam);
}
else {
// Generate default id...
if (sc.getMajorVersion() == 2 && sc.getMinorVersion() < 5) {
// Servlet <= 2.4: resort to name specified in web.xml, if any.
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
ObjectUtils.getDisplayString(sc.getServletContextName()));
}
else {
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
ObjectUtils.getDisplayString(sc.getContextPath()));
}
}
}
wac.setServletContext(sc);
//CONFIG_LOCATION_PARAM :“contextConfigLocation” web.xml contextConfigLocation, spring
String initParameter = sc.getInitParameter(CONFIG_LOCATION_PARAM);
if (initParameter != null) {
wac.setConfigLocation(initParameter);
}
customizeContext(sc, wac);
wac.refresh();
}
customizeContext(sc, wac);とwac.refresh();何をしましたか.
CustomizeContext(sc,wac)コードは次のとおりです.
protected void customizeContext(ServletContext servletContext, ConfigurableWebApplicationContext applicationContext) {
List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> initializerClasses =
determineContextInitializerClasses(servletContext);
if (initializerClasses.size() == 0) {
// no ApplicationContextInitializers have been declared -> nothing to do
return;
}
Class<?> contextClass = applicationContext.getClass();
ArrayList<ApplicationContextInitializer<ConfigurableApplicationContext>> initializerInstances =
new ArrayList<ApplicationContextInitializer<ConfigurableApplicationContext>>();
for (Class<ApplicationContextInitializer<ConfigurableApplicationContext>> initializerClass : initializerClasses) {
Class<?> initializerContextClass =
GenericTypeResolver.resolveTypeArgument(initializerClass, ApplicationContextInitializer.class);
if (initializerContextClass != null) {
Assert.isAssignable(initializerContextClass, contextClass, String.format(
"Could not add context initializer [%s] as its generic parameter [%s] " +
"is not assignable from the type of application context used by this " +
"context loader [%s]: ", initializerClass.getName(), initializerContextClass.getName(),
contextClass.getName()));
}
initializerInstances.add(BeanUtils.instantiateClass(initializerClass));
}
ConfigurableEnvironment env = applicationContext.getEnvironment();
if (env instanceof ConfigurableWebEnvironment) {
((ConfigurableWebEnvironment)env).initPropertySources(servletContext, null);
}
Collections.sort(initializerInstances, new AnnotationAwareOrderComparator());
for (ApplicationContextInitializer<ConfigurableApplicationContext> initializer : initializerInstances) {
initializer.initialize(applicationContext);
}
}
まず、コードはメソッドd e t e r m i n e ContextInitializerClasses(servletContext)に入ります.determineContextInitializerClassesメソッドコードは次のとおりです.
protected List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>
determineContextInitializerClasses(ServletContext servletContext) {
String classNames = servletContext.getInitParameter(CONTEXT_INITIALIZER_CLASSES_PARAM);
List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> classes =
new ArrayList<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>();
if (classNames != null) {
for (String className : StringUtils.tokenizeToStringArray(classNames, ",")) {
try {
Class<?> clazz = ClassUtils.forName(className, ClassUtils.getDefaultClassLoader());
Assert.isAssignable(ApplicationContextInitializer.class, clazz,
"class [" + className + "] must implement ApplicationContextInitializer");
classes.add((Class<ApplicationContextInitializer<ConfigurableApplicationContext>>)clazz);
}
catch (ClassNotFoundException ex) {
throw new ApplicationContextException(
"Failed to load context initializer class [" + className + "]", ex);
}
}
}
return classes;
}
上記のように、まずwebから.xmlのプロファイルで名前がCONTEXT_を検索INITIALIZER_CLASSES_PARAM(contextInitializerClasses)のコンフィギュレーションアイテムは、一般的にはコンフィギュレーションアイテムをコンフィギュレーションしませんので、classNamesはnullなので、上記の方法では空のlistを返し、メソッドcustomizeContext()に戻り、listは空なので、メソッドcustomizeContext()の戻り値は空です.
では、最後の方法に入ります.wac.refresh();コード:
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// Prepare this context for refreshing.
prepareRefresh();
// Tell the subclass to refresh the internal bean factory.
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.
prepareBeanFactory(beanFactory);
try {
// Allows post-processing of the bean factory in context subclasses.
postProcessBeanFactory(beanFactory);
// Invoke factory processors registered as beans in the context.
invokeBeanFactoryPostProcessors(beanFactory);
// Register bean processors that intercept bean creation.
registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.
initMessageSource();
// Initialize event multicaster for this context.
initApplicationEventMulticaster();
// Initialize other special beans in specific context subclasses.
onRefresh();
// Check for listener beans and register them.
registerListeners();
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.
finishRefresh();
}
catch (BeansException ex) {
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
}
}
上記のコードから分かるように、contextのロード構成項目、初期化、beanFactoryの作成はこの方法で完了します.