Skip to content

Commit 06192a5

Browse files
OlgaMaciaszekOlgaMaciaszek
authored
Register method params for reflection (#849)
1 parent 85c4151 commit 06192a5

File tree

2 files changed

+237
-7
lines changed

2 files changed

+237
-7
lines changed

‎spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/aot/FeignClientBeanFactoryInitializationAotProcessor.java‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022-2022 the original author or authors.
2+
* Copyright 2022-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,6 +16,8 @@
1616

1717
package org.springframework.cloud.openfeign.aot;
1818

19+
import java.lang.reflect.Method;
20+
import java.lang.reflect.Parameter;
1921
import java.util.Map;
2022
import java.util.Objects;
2123
import java.util.Set;
@@ -25,7 +27,9 @@
2527

2628
import org.springframework.aot.generate.GenerationContext;
2729
import org.springframework.aot.generate.MethodReference;
28-
import org.springframework.aot.hint.ProxyHints;
30+
import org.springframework.aot.hint.BindingReflectionHintsRegistrar;
31+
import org.springframework.aot.hint.ReflectionHints;
32+
import org.springframework.aot.hint.RuntimeHints;
2933
import org.springframework.beans.MutablePropertyValues;
3034
import org.springframework.beans.factory.BeanFactory;
3135
import org.springframework.beans.factory.FactoryBean;
@@ -47,14 +51,15 @@
4751
import org.springframework.cloud.openfeign.FeignClientFactoryBean;
4852
import org.springframework.cloud.openfeign.FeignClientSpecification;
4953
import org.springframework.context.support.GenericApplicationContext;
54+
import org.springframework.core.MethodParameter;
5055
import org.springframework.javapoet.MethodSpec;
5156
import org.springframework.util.Assert;
5257
import org.springframework.util.ClassUtils;
5358

5459
/**
5560
* A {@link BeanFactoryInitializationAotProcessor} that creates an
5661
* {@link BeanFactoryInitializationAotContribution} that registers bean definitions and
57-
* proxy hints for Feign client beans.
62+
* proxy and reflection hints for Feign client beans.
5863
*
5964
* @author Olga Maciaszek-Sharma
6065
* @since 4.0.0
@@ -66,6 +71,8 @@ public class FeignClientBeanFactoryInitializationAotProcessor
6671

6772
private final Map<String, BeanDefinition> feignClientBeanDefinitions;
6873

74+
private final BindingReflectionHintsRegistrar bindingRegistrar = new BindingReflectionHintsRegistrar();
75+
6976
public FeignClientBeanFactoryInitializationAotProcessor(GenericApplicationContext context,
7077
FeignClientFactory feignClientFactory) {
7178
this.context = context;
@@ -86,6 +93,7 @@ private Map<String, BeanDefinition> getFeignClientBeanDefinitions(FeignClientFac
8693
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
8794
}
8895

96+
@SuppressWarnings("NullableProblems")
8997
@Override
9098
public BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableListableBeanFactory beanFactory) {
9199
BeanFactory applicationBeanFactory = context.getBeanFactory();
@@ -95,7 +103,26 @@ public BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableL
95103
return new AotContribution(feignClientBeanDefinitions);
96104
}
97105

98-
private static final class AotContribution implements BeanFactoryInitializationAotContribution {
106+
private void registerMethodHints(ReflectionHints hints, Class<?> clazz) {
107+
for (Method method : clazz.getDeclaredMethods()) {
108+
registerMethodHints(hints, method);
109+
}
110+
}
111+
112+
private void registerMethodHints(ReflectionHints hints, Method method) {
113+
for (Parameter parameter : method.getParameters()) {
114+
bindingRegistrar.registerReflectionHints(hints,
115+
MethodParameter.forParameter(parameter).getGenericParameterType());
116+
}
117+
MethodParameter returnTypeParameter = MethodParameter.forExecutable(method, -1);
118+
if (!void.class.equals(returnTypeParameter.getParameterType())) {
119+
bindingRegistrar.registerReflectionHints(hints, returnTypeParameter.getGenericParameterType());
120+
}
121+
122+
}
123+
124+
// Visible for tests
125+
final class AotContribution implements BeanFactoryInitializationAotContribution {
99126

100127
private final Map<String, BeanDefinition> feignClientBeanDefinitions;
101128

@@ -106,7 +133,7 @@ private AotContribution(Map<String, BeanDefinition> feignClientBeanDefinitions)
106133
@Override
107134
public void applyTo(GenerationContext generationContext,
108135
BeanFactoryInitializationCode beanFactoryInitializationCode) {
109-
ProxyHints proxyHints = generationContext.getRuntimeHints().proxies();
136+
RuntimeHints hints = generationContext.getRuntimeHints();
110137
Set<String> feignClientRegistrationMethods = feignClientBeanDefinitions.values().stream()
111138
.map(beanDefinition -> {
112139
Assert.notNull(beanDefinition, "beanDefinition cannot be null");
@@ -115,8 +142,9 @@ public void applyTo(GenerationContext generationContext,
115142
MutablePropertyValues feignClientProperties = registeredBeanDefinition.getPropertyValues();
116143
String className = (String) feignClientProperties.get("type");
117144
Assert.notNull(className, "className cannot be null");
118-
Class clazz = ClassUtils.resolveClassName(className, null);
119-
proxyHints.registerJdkProxy(clazz);
145+
Class<?> clazz = ClassUtils.resolveClassName(className, null);
146+
hints.proxies().registerJdkProxy(clazz);
147+
registerMethodHints(hints.reflection(), clazz);
120148
return beanFactoryInitializationCode.getMethods()
121149
.add(buildMethodName(className), method -> generateFeignClientRegistrationMethod(method,
122150
feignClientProperties, registeredBeanDefinition))
@@ -177,6 +205,11 @@ private void generateFeignClientRegistrationMethod(MethodSpec.Builder method,
177205
.addStatement("$T.registerBeanDefinition(holder, registry) ", BeanDefinitionReaderUtils.class);
178206
}
179207

208+
// Visible for tests
209+
Map<String, BeanDefinition> getFeignClientBeanDefinitions() {
210+
return feignClientBeanDefinitions;
211+
}
212+
180213
}
181214

182215
}

‎spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/aot/FeignClientBeanFactoryInitializationAotProcessorTests.java‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
/*
2+
* Copyright 2022-2023 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.cloud.openfeign.aot;
18+
19+
import java.util.ArrayList;
20+
import java.util.List;
21+
import java.util.Map;
22+
import java.util.function.Consumer;
23+
24+
import org.junit.jupiter.api.BeforeEach;
25+
import org.junit.jupiter.api.Test;
26+
27+
import org.springframework.aot.generate.GeneratedClass;
28+
import org.springframework.aot.generate.GeneratedMethods;
29+
import org.springframework.aot.generate.GenerationContext;
30+
import org.springframework.aot.generate.MethodReference;
31+
import org.springframework.aot.hint.RuntimeHints;
32+
import org.springframework.aot.test.generate.TestGenerationContext;
33+
import org.springframework.beans.MutablePropertyValues;
34+
import org.springframework.beans.PropertyValue;
35+
import org.springframework.beans.PropertyValues;
36+
import org.springframework.beans.factory.aot.BeanFactoryInitializationAotContribution;
37+
import org.springframework.beans.factory.aot.BeanFactoryInitializationCode;
38+
import org.springframework.beans.factory.config.BeanDefinition;
39+
import org.springframework.beans.factory.config.ConstructorArgumentValues;
40+
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
41+
import org.springframework.beans.factory.support.GenericBeanDefinition;
42+
import org.springframework.beans.factory.support.RootBeanDefinition;
43+
import org.springframework.cloud.openfeign.FeignClient;
44+
import org.springframework.cloud.openfeign.FeignClientFactory;
45+
import org.springframework.cloud.openfeign.FeignClientSpecification;
46+
import org.springframework.context.support.GenericApplicationContext;
47+
import org.springframework.javapoet.TypeSpec;
48+
import org.springframework.web.bind.annotation.PostMapping;
49+
50+
import static org.assertj.core.api.Assertions.assertThat;
51+
import static org.mockito.Mockito.mock;
52+
import static org.mockito.Mockito.when;
53+
import static org.springframework.aot.hint.predicate.RuntimeHintsPredicates.proxies;
54+
import static org.springframework.aot.hint.predicate.RuntimeHintsPredicates.reflection;
55+
56+
/**
57+
* Tests for {@link FeignClientBeanFactoryInitializationAotProcessor}.
58+
*
59+
* @author Olga Maciaszek-Sharma
60+
*/
61+
class FeignClientBeanFactoryInitializationAotProcessorTests {
62+
63+
private static final String BEAN_DEFINITION_CLASS_NAME = "org.springframework.cloud.openfeign.aot.FeignClientBeanFactoryInitializationAotProcessorTests$TestClient";
64+
65+
private final TestGenerationContext generationContext = new TestGenerationContext();
66+
67+
private final FeignClientFactory feignClientFactory = mock(FeignClientFactory.class);
68+
69+
private final BeanFactoryInitializationCode beanFactoryInitializationCode = new MockBeanFactoryInitializationCode(
70+
generationContext);
71+
72+
@BeforeEach
73+
void setUp() {
74+
Map<String, FeignClientSpecification> configurations = Map.of("test",
75+
new FeignClientSpecification("test", TestClient.class.getCanonicalName(), new Class<?>[] {}));
76+
when(feignClientFactory.getConfigurations()).thenReturn(configurations);
77+
78+
}
79+
80+
@Test
81+
void shouldGenerateBeanInitializationCodeAndRegisterHints() {
82+
DefaultListableBeanFactory beanFactory = beanFactory();
83+
GenericApplicationContext context = new GenericApplicationContext(beanFactory);
84+
FeignClientBeanFactoryInitializationAotProcessor processor = new FeignClientBeanFactoryInitializationAotProcessor(
85+
context, feignClientFactory);
86+
87+
BeanFactoryInitializationAotContribution contribution = processor.processAheadOfTime(beanFactory);
88+
assertThat(contribution).isNotNull();
89+
90+
verifyContribution((FeignClientBeanFactoryInitializationAotProcessor.AotContribution) contribution);
91+
contribution.applyTo(generationContext, beanFactoryInitializationCode);
92+
93+
RuntimeHints hints = generationContext.getRuntimeHints();
94+
assertThat(reflection().onType(TestReturnType.class)).accepts(hints);
95+
assertThat(reflection().onType(TestArgType.class)).accepts(hints);
96+
assertThat(proxies().forInterfaces(TestClient.class)).accepts(hints);
97+
}
98+
99+
private static void verifyContribution(
100+
FeignClientBeanFactoryInitializationAotProcessor.AotContribution contribution) {
101+
BeanDefinition contributionBeanDefinition = contribution.getFeignClientBeanDefinitions()
102+
.get(TestClient.class.getCanonicalName());
103+
assertThat(contributionBeanDefinition.getBeanClassName()).isEqualTo(BEAN_DEFINITION_CLASS_NAME);
104+
PropertyValues propertyValues = contributionBeanDefinition.getPropertyValues();
105+
assertThat(propertyValues).isNotEmpty();
106+
assertThat(((String[]) propertyValues.getPropertyValue("qualifiers").getValue())).containsExactly("test");
107+
assertThat(propertyValues.getPropertyValue("type").getValue()).isEqualTo(TestClient.class.getCanonicalName());
108+
assertThat(propertyValues.getPropertyValue("fallback").getValue()).isEqualTo(String.class);
109+
}
110+
111+
private DefaultListableBeanFactory beanFactory() {
112+
GenericBeanDefinition beanDefinition = new GenericBeanDefinition(new RootBeanDefinition(TestClient.class,
113+
new ConstructorArgumentValues(),
114+
new MutablePropertyValues(List.of(new PropertyValue("type", TestClient.class.getCanonicalName()),
115+
new PropertyValue("qualifiers", new String[] { "test" }),
116+
new PropertyValue("fallback", String.class),
117+
new PropertyValue("fallbackFactory", Void.class)))));
118+
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
119+
beanFactory.registerBeanDefinition(TestClient.class.getCanonicalName(), beanDefinition);
120+
return beanFactory;
121+
}
122+
123+
@FeignClient
124+
interface TestClient {
125+
126+
@PostMapping("/test")
127+
TestReturnType test(TestArgType arg);
128+
129+
}
130+
131+
@SuppressWarnings("NullableProblems")
132+
static class MockBeanFactoryInitializationCode implements BeanFactoryInitializationCode {
133+
134+
private static final Consumer<TypeSpec.Builder> emptyTypeCustomizer = type -> {
135+
};
136+
137+
private final GeneratedClass generatedClass;
138+
139+
MockBeanFactoryInitializationCode(GenerationContext generationContext) {
140+
generatedClass = generationContext.getGeneratedClasses().addForFeature("Test", emptyTypeCustomizer);
141+
}
142+
143+
@Override
144+
public GeneratedMethods getMethods() {
145+
return generatedClass.getMethods();
146+
}
147+
148+
@Override
149+
public void addInitializer(MethodReference methodReference) {
150+
new ArrayList<>();
151+
}
152+
153+
}
154+
155+
static class TestReturnType {
156+
157+
private String test;
158+
159+
TestReturnType(String test) {
160+
this.test = test;
161+
}
162+
163+
TestReturnType() {
164+
}
165+
166+
String getTest() {
167+
return test;
168+
}
169+
170+
void setTest(String test) {
171+
this.test = test;
172+
}
173+
174+
}
175+
176+
static class TestArgType {
177+
178+
private String test;
179+
180+
TestArgType(String test) {
181+
this.test = test;
182+
}
183+
184+
TestArgType() {
185+
}
186+
187+
String getTest() {
188+
return test;
189+
}
190+
191+
void setTest(String test) {
192+
this.test = test;
193+
}
194+
195+
}
196+
197+
}

0 commit comments

Comments
 (0)