MBeanExporter implements newly introduced SmartInitializingSingleton callback interface
Issue: SPR-8045
This commit is contained in:
parent
29f6f3d7e7
commit
2bd6e24b65
|
@ -0,0 +1,58 @@
|
||||||
|
/*
|
||||||
|
* 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.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package org.springframework.beans.factory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Callback interface triggered at the end of the singleton pre-instantiation phase
|
||||||
|
* during {@link BeanFactory} bootstrap. This interface can be implemented by
|
||||||
|
* singleton beans in order to perform some initialization after the regular
|
||||||
|
* singleton instantiation algorithm, avoiding side effects with accidental early
|
||||||
|
* initialization (e.g. from {@link ListableBeanFactory#getBeansOfType} calls).
|
||||||
|
* In that sense, it is an alternative to {@link InitializingBean} which gets
|
||||||
|
* triggered right at the end of a bean's local construction phase.
|
||||||
|
*
|
||||||
|
* <p>This callback variant is somewhat similar to
|
||||||
|
* {@link org.springframework.context.event.ContextRefreshedEvent} but doesn't
|
||||||
|
* require an implementation of {@link org.springframework.context.ApplicationListener},
|
||||||
|
* with no need to filter context references across a context hierarchy etc.
|
||||||
|
* It also implies a more minimal dependency on just the {@code beans} package
|
||||||
|
* and is being honored by standalone {@link ListableBeanFactory} implementations,
|
||||||
|
* not just in an {@link org.springframework.context.ApplicationContext} environment.
|
||||||
|
*
|
||||||
|
* <p><b>NOTE:</b> If you intend to start/manage asynchronous tasks, preferably
|
||||||
|
* implement {@link org.springframework.context.Lifecycle} instead which offers
|
||||||
|
* a richer model for runtime management and allows for phased startup/shutdown.
|
||||||
|
*
|
||||||
|
* @author Juergen Hoeller
|
||||||
|
* @since 4.1
|
||||||
|
* @see org.springframework.beans.factory.config.ConfigurableListableBeanFactory#preInstantiateSingletons()
|
||||||
|
*/
|
||||||
|
public interface SmartInitializingSingleton {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invoked right at the end of the singleton pre-instantiation phase,
|
||||||
|
* with a guarantee that all regular singleton beans have been created
|
||||||
|
* already. {@link ListableBeanFactory#getBeansOfType} calls within
|
||||||
|
* this method won't trigger accidental side effects during bootstrap.
|
||||||
|
* <p><b>NOTE:</b> This callback won't be triggered for singleton beans
|
||||||
|
* lazily initialized on demand after {@link BeanFactory} bootstrap,
|
||||||
|
* and not for any other bean scope either. Carefully use it for beans
|
||||||
|
* with the intended bootstrap semantics only.
|
||||||
|
*/
|
||||||
|
void afterSingletonsInstantiated();
|
||||||
|
|
||||||
|
}
|
|
@ -56,6 +56,7 @@ import org.springframework.beans.factory.NoSuchBeanDefinitionException;
|
||||||
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
|
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
|
||||||
import org.springframework.beans.factory.ObjectFactory;
|
import org.springframework.beans.factory.ObjectFactory;
|
||||||
import org.springframework.beans.factory.SmartFactoryBean;
|
import org.springframework.beans.factory.SmartFactoryBean;
|
||||||
|
import org.springframework.beans.factory.SmartInitializingSingleton;
|
||||||
import org.springframework.beans.factory.config.BeanDefinition;
|
import org.springframework.beans.factory.config.BeanDefinition;
|
||||||
import org.springframework.beans.factory.config.BeanDefinitionHolder;
|
import org.springframework.beans.factory.config.BeanDefinitionHolder;
|
||||||
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
|
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
|
||||||
|
@ -684,12 +685,15 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||||
if (this.logger.isDebugEnabled()) {
|
if (this.logger.isDebugEnabled()) {
|
||||||
this.logger.debug("Pre-instantiating singletons in " + this);
|
this.logger.debug("Pre-instantiating singletons in " + this);
|
||||||
}
|
}
|
||||||
|
|
||||||
List<String> beanNames;
|
List<String> beanNames;
|
||||||
synchronized (this.beanDefinitionMap) {
|
synchronized (this.beanDefinitionMap) {
|
||||||
// Iterate over a copy to allow for init methods which in turn register new bean definitions.
|
// Iterate over a copy to allow for init methods which in turn register new bean definitions.
|
||||||
// While this may not be part of the regular factory bootstrap, it does otherwise work fine.
|
// While this may not be part of the regular factory bootstrap, it does otherwise work fine.
|
||||||
beanNames = new ArrayList<String>(this.beanDefinitionNames);
|
beanNames = new ArrayList<String>(this.beanDefinitionNames);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Trigger initialization of all non-lazy singleton beans...
|
||||||
for (String beanName : beanNames) {
|
for (String beanName : beanNames) {
|
||||||
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
|
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
|
||||||
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
|
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
|
||||||
|
@ -717,6 +721,26 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Trigger post-initialization callback for all applicable beans...
|
||||||
|
for (String beanName : beanNames) {
|
||||||
|
Object singletonInstance = getSingleton(beanName);
|
||||||
|
if (singletonInstance instanceof SmartInitializingSingleton) {
|
||||||
|
final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
|
||||||
|
if (System.getSecurityManager() != null) {
|
||||||
|
AccessController.doPrivileged(new PrivilegedAction<Object>() {
|
||||||
|
@Override
|
||||||
|
public Object run() {
|
||||||
|
smartSingleton.afterSingletonsInstantiated();
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}, getAccessControlContext());
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
smartSingleton.afterSingletonsInstantiated();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -48,6 +48,7 @@ import org.springframework.beans.factory.CannotLoadBeanClassException;
|
||||||
import org.springframework.beans.factory.DisposableBean;
|
import org.springframework.beans.factory.DisposableBean;
|
||||||
import org.springframework.beans.factory.InitializingBean;
|
import org.springframework.beans.factory.InitializingBean;
|
||||||
import org.springframework.beans.factory.ListableBeanFactory;
|
import org.springframework.beans.factory.ListableBeanFactory;
|
||||||
|
import org.springframework.beans.factory.SmartInitializingSingleton;
|
||||||
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
|
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
|
||||||
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
|
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
|
||||||
import org.springframework.core.Constants;
|
import org.springframework.core.Constants;
|
||||||
|
@ -87,7 +88,6 @@ import org.springframework.util.ObjectUtils;
|
||||||
* @author Juergen Hoeller
|
* @author Juergen Hoeller
|
||||||
* @author Rick Evans
|
* @author Rick Evans
|
||||||
* @author Mark Fisher
|
* @author Mark Fisher
|
||||||
* @author Marten Deinum
|
|
||||||
* @author Stephane Nicoll
|
* @author Stephane Nicoll
|
||||||
* @since 1.2
|
* @since 1.2
|
||||||
* @see #setBeans
|
* @see #setBeans
|
||||||
|
@ -98,7 +98,7 @@ import org.springframework.util.ObjectUtils;
|
||||||
* @see MBeanExporterListener
|
* @see MBeanExporterListener
|
||||||
*/
|
*/
|
||||||
public class MBeanExporter extends MBeanRegistrationSupport implements MBeanExportOperations,
|
public class MBeanExporter extends MBeanRegistrationSupport implements MBeanExportOperations,
|
||||||
BeanClassLoaderAware, BeanFactoryAware, InitializingBean, DisposableBean {
|
BeanClassLoaderAware, BeanFactoryAware, InitializingBean, SmartInitializingSingleton, DisposableBean {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Autodetection mode indicating that no autodetection should be used.
|
* Autodetection mode indicating that no autodetection should be used.
|
||||||
|
@ -407,16 +407,14 @@ public class MBeanExporter extends MBeanRegistrationSupport implements MBeanExpo
|
||||||
if (this.server == null) {
|
if (this.server == null) {
|
||||||
this.server = JmxUtils.locateMBeanServer();
|
this.server = JmxUtils.locateMBeanServer();
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: to be replaced with some ContextRefreshedEvent-like callback
|
|
||||||
register();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Kick off bean registration automatically when deployed in an {@code ApplicationContext}.
|
* Kick off bean registration automatically when deployed in an {@code ApplicationContext}.
|
||||||
* @see #registerBeans()
|
* @see #registerBeans()
|
||||||
*/
|
*/
|
||||||
public void register() {
|
@Override
|
||||||
|
public void afterSingletonsInstantiated() {
|
||||||
try {
|
try {
|
||||||
logger.info("Registering beans for JMX exposure on startup");
|
logger.info("Registering beans for JMX exposure on startup");
|
||||||
registerBeans();
|
registerBeans();
|
||||||
|
|
|
@ -48,6 +48,7 @@ import static org.junit.Assert.*;
|
||||||
* @author Juergen Hoeller
|
* @author Juergen Hoeller
|
||||||
* @author Sam Brannen
|
* @author Sam Brannen
|
||||||
* @author Chris Beams
|
* @author Chris Beams
|
||||||
|
* @author Stephane Nicoll
|
||||||
*/
|
*/
|
||||||
public abstract class AbstractMBeanServerTests {
|
public abstract class AbstractMBeanServerTests {
|
||||||
|
|
||||||
|
@ -100,7 +101,7 @@ public abstract class AbstractMBeanServerTests {
|
||||||
*/
|
*/
|
||||||
protected void start(MBeanExporter exporter) {
|
protected void start(MBeanExporter exporter) {
|
||||||
exporter.afterPropertiesSet();
|
exporter.afterPropertiesSet();
|
||||||
// exporter.register();
|
exporter.afterSingletonsInstantiated();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected void assertIsRegistered(String message, ObjectName objectName) {
|
protected void assertIsRegistered(String message, ObjectName objectName) {
|
||||||
|
|
Loading…
Reference in New Issue