Skip to content

Commit 85d4a79

Browse files
snicollsnicoll
committed
Improve location of generated bean definitions of FactoryBeans
This commit improves the location of generated bean definitions for FactoryBean implementations by checking the type that the factory bean generates, rather than the factory bean implementation itself. Closes gh-28812
1 parent c0bea37 commit 85d4a79

File tree

2 files changed

+170
-4
lines changed

2 files changed

+170
-4
lines changed

‎spring-beans/src/main/java/org/springframework/beans/factory/aot/DefaultBeanRegistrationCodeFragments.java

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@
1616

1717
package org.springframework.beans.factory.aot;
1818

19+
import java.lang.reflect.Constructor;
1920
import java.lang.reflect.Executable;
2021
import java.util.List;
2122
import java.util.function.Predicate;
2223

2324
import org.springframework.aot.generate.GenerationContext;
2425
import org.springframework.aot.generate.MethodReference;
26+
import org.springframework.beans.factory.FactoryBean;
2527
import org.springframework.beans.factory.config.BeanDefinition;
2628
import org.springframework.beans.factory.config.BeanDefinitionHolder;
2729
import org.springframework.beans.factory.support.InstanceSupplier;
@@ -69,14 +71,21 @@ class DefaultBeanRegistrationCodeFragments extends BeanRegistrationCodeFragments
6971
public Class<?> getTarget(RegisteredBean registeredBean,
7072
Executable constructorOrFactoryMethod) {
7173

72-
Class<?> target = ClassUtils
73-
.getUserClass(constructorOrFactoryMethod.getDeclaringClass());
74+
Class<?> target = extractDeclaringClass(constructorOrFactoryMethod);
7475
while (target.getName().startsWith("java.") && registeredBean.isInnerBean()) {
7576
target = registeredBean.getParent().getBeanClass();
7677
}
7778
return target;
7879
}
7980

81+
private Class<?> extractDeclaringClass(Executable executable) {
82+
Class<?> declaringClass = ClassUtils.getUserClass(executable.getDeclaringClass());
83+
if (executable instanceof Constructor<?> && FactoryBean.class.isAssignableFrom(declaringClass)) {
84+
return ResolvableType.forType(declaringClass).as(FactoryBean.class).getGeneric(0).toClass();
85+
}
86+
return executable.getDeclaringClass();
87+
}
88+
8089
@Override
8190
public CodeBlock generateNewBeanDefinitionCode(GenerationContext generationContext,
8291
ResolvableType beanType, BeanRegistrationCode beanRegistrationCode) {
@@ -107,7 +116,7 @@ public CodeBlock generateSetBeanDefinitionPropertiesCode(
107116
generationContext.getRuntimeHints(), attributeFilter,
108117
beanRegistrationCode.getMethods(),
109118
(name, value) -> generateValueCode(generationContext, name, value))
110-
.generateCode(beanDefinition);
119+
.generateCode(beanDefinition);
111120
}
112121

113122
@Nullable
@@ -171,7 +180,7 @@ public CodeBlock generateInstanceSupplierCode(GenerationContext generationContex
171180
return new InstanceSupplierCodeGenerator(generationContext,
172181
beanRegistrationCode.getClassName(),
173182
beanRegistrationCode.getMethods(), allowDirectSupplierShortcut)
174-
.generateCode(this.registeredBean, constructorOrFactoryMethod);
183+
.generateCode(this.registeredBean, constructorOrFactoryMethod);
175184
}
176185

177186
@Override

‎spring-beans/src/test/java/org/springframework/beans/factory/aot/DefaultBeanRegistrationCodeFragmentsTests.java

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
/*
2+
* Copyright 2002-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.beans.factory.aot;
18+
19+
import java.lang.reflect.Method;
20+
21+
import org.junit.jupiter.api.Test;
22+
23+
import org.springframework.beans.factory.FactoryBean;
24+
import org.springframework.beans.factory.annotation.InjectAnnotationBeanPostProcessorTests.StringFactoryBean;
25+
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
26+
import org.springframework.beans.factory.support.RegisteredBean;
27+
import org.springframework.beans.factory.support.RootBeanDefinition;
28+
import org.springframework.beans.testfixture.beans.factory.DummyFactory;
29+
import org.springframework.beans.testfixture.beans.factory.aot.MockBeanRegistrationsCode;
30+
import org.springframework.core.testfixture.aot.generate.TestGenerationContext;
31+
import org.springframework.util.ReflectionUtils;
32+
33+
import static org.assertj.core.api.Assertions.assertThat;
34+
35+
/**
36+
* Tests for {@link DefaultBeanRegistrationCodeFragments}.
37+
*
38+
* @author Stephane Nicoll
39+
*/
40+
class DefaultBeanRegistrationCodeFragmentsTests {
41+
42+
private final BeanRegistrationsCode beanRegistrationsCode = new MockBeanRegistrationsCode(new TestGenerationContext());
43+
44+
private final DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
45+
46+
@Test
47+
void getTargetOnConstructor() {
48+
RegisteredBean registeredBean = registerTestBean(TestBean.class);
49+
assertThat(createInstance(registeredBean).getTarget(registeredBean,
50+
TestBean.class.getDeclaredConstructors()[0])).isEqualTo(TestBean.class);
51+
}
52+
53+
@Test
54+
void getTargetOnConstructorToFactoryBean() {
55+
RegisteredBean registeredBean = registerTestBean(TestBean.class);
56+
assertThat(createInstance(registeredBean).getTarget(registeredBean,
57+
TestBeanFactoryBean.class.getDeclaredConstructors()[0])).isEqualTo(TestBean.class);
58+
}
59+
60+
@Test
61+
void getTargetOnMethod() {
62+
RegisteredBean registeredBean = registerTestBean(TestBean.class);
63+
Method method = ReflectionUtils.findMethod(TestBeanFactoryBean.class, "getObject");
64+
assertThat(method).isNotNull();
65+
assertThat(createInstance(registeredBean).getTarget(registeredBean,
66+
method)).isEqualTo(TestBeanFactoryBean.class);
67+
}
68+
69+
@Test
70+
void getTargetOnMethodWithInnerBeanInJavaPackage() {
71+
RegisteredBean registeredBean = registerTestBean(TestBean.class);
72+
RegisteredBean innerBean = RegisteredBean.ofInnerBean(registeredBean, "innerTestBean", new RootBeanDefinition(String.class));
73+
Method method = ReflectionUtils.findMethod(getClass(), "createString");
74+
assertThat(method).isNotNull();
75+
assertThat(createInstance(innerBean).getTarget(innerBean,
76+
method)).isEqualTo(getClass());
77+
}
78+
79+
@Test
80+
void getTargetOnConstructorWithInnerBeanInJavaPackage() {
81+
RegisteredBean registeredBean = registerTestBean(TestBean.class);
82+
RegisteredBean innerBean = RegisteredBean.ofInnerBean(registeredBean, "innerTestBean", new RootBeanDefinition(String.class));
83+
assertThat(createInstance(innerBean).getTarget(innerBean,
84+
String.class.getDeclaredConstructors()[0])).isEqualTo(TestBean.class);
85+
}
86+
87+
@Test
88+
void getTargetOnConstructorWithInnerBeanOnTypeInJavaPackage() {
89+
RegisteredBean registeredBean = registerTestBean(TestBean.class);
90+
RegisteredBean innerBean = RegisteredBean.ofInnerBean(registeredBean, "innerTestBean",
91+
new RootBeanDefinition(StringFactoryBean.class));
92+
assertThat(createInstance(innerBean).getTarget(innerBean,
93+
StringFactoryBean.class.getDeclaredConstructors()[0])).isEqualTo(TestBean.class);
94+
}
95+
96+
@Test
97+
void getTargetOnMethodWithInnerBeanInRegularPackage() {
98+
RegisteredBean registeredBean = registerTestBean(DummyFactory.class);
99+
RegisteredBean innerBean = RegisteredBean.ofInnerBean(registeredBean, "innerTestBean", new RootBeanDefinition(TestBean.class));
100+
Method method = ReflectionUtils.findMethod(TestBeanFactoryBean.class, "getObject");
101+
assertThat(method).isNotNull();
102+
assertThat(createInstance(innerBean).getTarget(innerBean, method)).isEqualTo(TestBeanFactoryBean.class);
103+
}
104+
105+
@Test
106+
void getTargetOnConstructorWithInnerBeanInRegularPackage() {
107+
RegisteredBean registeredBean = registerTestBean(DummyFactory.class);
108+
RegisteredBean innerBean = RegisteredBean.ofInnerBean(registeredBean, "innerTestBean", new RootBeanDefinition(TestBean.class));
109+
assertThat(createInstance(innerBean).getTarget(innerBean,
110+
TestBean.class.getDeclaredConstructors()[0])).isEqualTo(TestBean.class);
111+
}
112+
113+
@Test
114+
void getTargetOnConstructorWithInnerBeanOnFactoryBeanOnTypeInRegularPackage() {
115+
RegisteredBean registeredBean = registerTestBean(DummyFactory.class);
116+
RegisteredBean innerBean = RegisteredBean.ofInnerBean(registeredBean, "innerTestBean",
117+
new RootBeanDefinition(TestBean.class));
118+
assertThat(createInstance(innerBean).getTarget(innerBean,
119+
TestBeanFactoryBean.class.getDeclaredConstructors()[0])).isEqualTo(TestBean.class);
120+
}
121+
122+
123+
private RegisteredBean registerTestBean(Class<?> beanType) {
124+
this.beanFactory.registerBeanDefinition("testBean",
125+
new RootBeanDefinition(beanType));
126+
return RegisteredBean.of(this.beanFactory, "testBean");
127+
}
128+
129+
private BeanRegistrationCodeFragments createInstance(RegisteredBean registeredBean) {
130+
return new DefaultBeanRegistrationCodeFragments(this.beanRegistrationsCode, registeredBean, new BeanDefinitionMethodGeneratorFactory(this.beanFactory));
131+
}
132+
133+
@SuppressWarnings("unused")
134+
static String createString() {
135+
return "Test";
136+
}
137+
138+
@SuppressWarnings("unused")
139+
static class TestBean {
140+
141+
}
142+
143+
144+
static class TestBeanFactoryBean implements FactoryBean<TestBean> {
145+
146+
@Override
147+
public TestBean getObject() throws Exception {
148+
return new TestBean();
149+
}
150+
151+
@Override
152+
public Class<?> getObjectType() {
153+
return TestBean.class;
154+
}
155+
}
156+
157+
}

0 commit comments

Comments
 (0)