Invoke lifecycle methods in AOT mode in the same order as standard JVM mode

[sbrannen]

Overview

The difference in invocation order between standard JVM mode and AOT mode can be viewed in the following tests. See also: #30724 (comment).

Tests

JVM mode:

spring-framework/spring-context/src/test/java/org/springframework/context/annotation/InitDestroyMethodLifecycleTests.java

Lines 123 to 143 in 2ccf4ca

	@Test
	void jakartaAnnotationsCustomPrivateInitDestroyMethodsWithTheSameMethodNames() {
	Class<?> beanClass = CustomAnnotatedPrivateSameNameInitDestroyBean.class;
	DefaultListableBeanFactory beanFactory = createBeanFactoryAndRegisterBean(beanClass, "customInit", "customDestroy");
	CustomAnnotatedPrivateSameNameInitDestroyBean bean = beanFactory.getBean(CustomAnnotatedPrivateSameNameInitDestroyBean.class);
	assertThat(bean.initMethods).as("init-methods").containsExactly(
	"@PostConstruct.privateCustomInit1",
	"@PostConstruct.sameNameCustomInit1",
	"afterPropertiesSet",
	"customInit"
	);
	beanFactory.destroySingletons();
	assertThat(bean.destroyMethods).as("destroy-methods").containsExactly(
	"@PreDestroy.sameNameCustomDestroy1",
	"@PreDestroy.privateCustomDestroy1",
	"destroy",
	"customDestroy"
	);
	}

AOT mode:

spring-framework/spring-context/src/test/java/org/springframework/context/annotation/InitDestroyMethodLifecycleTests.java

Lines 170 to 203 in 2ccf4ca

	@Test
	@CompileWithForkedClassLoader
	void jakartaAnnotationsWithCustomSameMethodNamesWithAotProcessingAndAotRuntime() {
	Class<CustomAnnotatedPrivateSameNameInitDestroyBean> beanClass = CustomAnnotatedPrivateSameNameInitDestroyBean.class;
	GenericApplicationContext applicationContext = new GenericApplicationContext();
	DefaultListableBeanFactory beanFactory = applicationContext.getDefaultListableBeanFactory();
	AnnotationConfigUtils.registerAnnotationConfigProcessors(beanFactory);
	RootBeanDefinition beanDefinition = new RootBeanDefinition(beanClass);
	beanDefinition.setInitMethodName("customInit");
	beanDefinition.setDestroyMethodName("customDestroy");
	beanFactory.registerBeanDefinition("lifecycleTestBean", beanDefinition);
	testCompiledResult(applicationContext, (initializer, compiled) -> {
	GenericApplicationContext aotApplicationContext = createApplicationContext(initializer);
	CustomAnnotatedPrivateSameNameInitDestroyBean bean = aotApplicationContext.getBean("lifecycleTestBean", beanClass);
	assertThat(bean.initMethods).as("init-methods").containsExactly(
	"afterPropertiesSet",
	"@PostConstruct.privateCustomInit1",
	"@PostConstruct.sameNameCustomInit1",
	"customInit"
	);
	aotApplicationContext.close();
	assertThat(bean.destroyMethods).as("destroy-methods").containsExactly(
	"destroy",
	"@PreDestroy.sameNameCustomDestroy1",
	"@PreDestroy.privateCustomDestroy1",
	"customDestroy"
	);
	});
	}

Known Issues

• InitDestroyAnnotationBeanPostProcessor.processAheadOfTime(RegisteredBean) gets invoked twice in the same AOT processing phase: once via CommonAnnotationBeanPostProcessor and once via InitDestroyAnnotationBeanPostProcessor.
• InitializingBean and DisposableBean are treated specially even in AOT mode.

[sbrannen]

Note: the expected order is documented in the Combining Lifecycle Mechanisms section of the reference manual.