-
-
Notifications
You must be signed in to change notification settings - Fork 468
/
MethodParameterPojoExtractor.java
270 lines (242 loc) · 7.82 KB
/
MethodParameterPojoExtractor.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
/*
*
* *
* * *
* * * *
* * * * * Copyright 2019-2022 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
* * * * *
* * * * * https://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.springdoc.core.extractor;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.nio.charset.Charset;
import java.time.Duration;
import java.time.LocalTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.Predicate;
import java.util.stream.Stream;
import io.swagger.v3.core.util.PrimitiveType;
import io.swagger.v3.oas.annotations.Parameter;
import org.springdoc.core.parsers.ReturnTypeParser;
import org.springframework.core.MethodParameter;
import static org.springdoc.core.utils.Constants.DOT;
/**
* The type Method parameter pojo extractor.
* @author bnasslahsen
*/
public class MethodParameterPojoExtractor {
/**
* Instantiates a new Method parameter pojo extractor.
*/
private MethodParameterPojoExtractor() {
}
/**
* The constant SIMPLE_TYPE_PREDICATES.
*/
private static final List<Predicate<Class<?>>> SIMPLE_TYPE_PREDICATES = new ArrayList<>();
/**
* The constant SIMPLE_TYPES.
*/
private static final Set<Class<?>> SIMPLE_TYPES = new HashSet<>();
static {
SIMPLE_TYPES.add(CharSequence.class);
SIMPLE_TYPES.add(Optional.class);
SIMPLE_TYPES.add(OptionalInt.class);
SIMPLE_TYPES.add(OptionalLong.class);
SIMPLE_TYPES.add(OptionalDouble.class);
SIMPLE_TYPES.add(AtomicLong.class);
SIMPLE_TYPES.add(AtomicInteger.class);
SIMPLE_TYPES.add(Charset.class);
SIMPLE_TYPES.add(Map.class);
SIMPLE_TYPES.add(Iterable.class);
SIMPLE_TYPES.add(Duration.class);
SIMPLE_TYPES.add(LocalTime.class);
SIMPLE_TYPE_PREDICATES.add(Class::isPrimitive);
SIMPLE_TYPE_PREDICATES.add(Class::isEnum);
SIMPLE_TYPE_PREDICATES.add(Class::isArray);
SIMPLE_TYPE_PREDICATES.add(MethodParameterPojoExtractor::isSwaggerPrimitiveType);
}
/**
* Extract from stream.
*
* @param clazz the clazz
* @return the stream
*/
static Stream<MethodParameter> extractFrom(Class<?> clazz) {
return extractFrom(clazz, "");
}
/**
* Extract from stream.
*
* @param clazz the clazz
* @param fieldNamePrefix the field name prefix
* @return the stream
*/
private static Stream<MethodParameter> extractFrom(Class<?> clazz, String fieldNamePrefix) {
return allFieldsOf(clazz).stream()
.filter(field -> !field.getType().equals(clazz))
.flatMap(f -> fromGetterOfField(clazz, f, fieldNamePrefix))
.filter(Objects::nonNull);
}
/**
* From getter of field stream.
*
* @param paramClass the param class
* @param field the field
* @param fieldNamePrefix the field name prefix
* @return the stream
*/
private static Stream<MethodParameter> fromGetterOfField(Class<?> paramClass, Field field, String fieldNamePrefix) {
Class<?> type = extractType(paramClass, field);
if (Objects.isNull(type))
return Stream.empty();
if (isSimpleType(type))
return fromSimpleClass(paramClass, field, fieldNamePrefix);
else {
String prefix = fieldNamePrefix + field.getName() + DOT;
return extractFrom(type, prefix);
}
}
/**
* Extract the type
* @param paramClass
* @param field
* @return The revoled type or null if it was not a reifiable type
*/
private static Class<?> extractType(Class<?> paramClass, Field field) {
Class<?> type = field.getType();
if (field.getGenericType() instanceof TypeVariable<?>) {
Type fieldType = ReturnTypeParser.resolveType(field.getGenericType(), paramClass);
if (fieldType instanceof Class<?>)
type = (Class<?>) fieldType;
else // This is the case for not reifiable types
type = null;
}
return type;
}
/**
* From simple class stream.
*
* @param paramClass the param class
* @param field the field
* @param fieldNamePrefix the field name prefix
* @return the stream
*/
private static Stream<MethodParameter> fromSimpleClass(Class<?> paramClass, Field field, String fieldNamePrefix) {
Annotation[] fieldAnnotations = field.getDeclaredAnnotations();
try {
Parameter parameter = field.getAnnotation(Parameter.class);
boolean isNotRequired = parameter == null || !parameter.required();
Annotation[] finalFieldAnnotations = fieldAnnotations;
if (paramClass.isRecord()) {
return Stream.of(paramClass.getRecordComponents())
.filter(d -> d.getName().equals(field.getName()))
.map(recordComponent -> recordComponent.getAccessor())
.map(method -> new MethodParameter(method, -1))
.map(methodParameter -> DelegatingMethodParameter.changeContainingClass(methodParameter, paramClass))
.map(param -> new DelegatingMethodParameter(param, fieldNamePrefix + field.getName(), finalFieldAnnotations, true, isNotRequired));
}
else
return Stream.of(Introspector.getBeanInfo(paramClass).getPropertyDescriptors())
.filter(d -> d.getName().equals(field.getName()))
.map(PropertyDescriptor::getReadMethod)
.filter(Objects::nonNull)
.map(method -> new MethodParameter(method, -1))
.map(methodParameter -> DelegatingMethodParameter.changeContainingClass(methodParameter, paramClass))
.map(param -> new DelegatingMethodParameter(param, fieldNamePrefix + field.getName(), finalFieldAnnotations, true, isNotRequired));
}
catch (IntrospectionException e) {
return Stream.of();
}
}
/**
* All fields of list.
*
* @param clazz the clazz
* @return the list
*/
private static List<Field> allFieldsOf(Class<?> clazz) {
List<Field> fields = new ArrayList<>();
do {
fields.addAll(Arrays.asList(clazz.getDeclaredFields()));
clazz = clazz.getSuperclass();
} while (clazz != null);
return fields;
}
/**
* Is simple type boolean.
*
* @param clazz the clazz
* @return the boolean
*/
static boolean isSimpleType(Class<?> clazz) {
return SIMPLE_TYPE_PREDICATES.stream().anyMatch(p -> p.test(clazz)) ||
SIMPLE_TYPES.stream().anyMatch(c -> c.isAssignableFrom(clazz));
}
/**
* Is swagger primitive type boolean.
*
* @param clazz the clazz
* @return the boolean
*/
public static boolean isSwaggerPrimitiveType(Class<?> clazz) {
PrimitiveType primitiveType = PrimitiveType.fromType(clazz);
return primitiveType != null;
}
/**
* Add simple type predicate.
*
* @param predicate the predicate
*/
public static void addSimpleTypePredicate(Predicate<Class<?>> predicate) {
SIMPLE_TYPE_PREDICATES.add(predicate);
}
/**
* Add simple types.
*
* @param classes the classes
*/
public static void addSimpleTypes(Class<?>... classes) {
SIMPLE_TYPES.addAll(Arrays.asList(classes));
}
/**
* Remove simple types.
*
* @param classes the classes
*/
public static void removeSimpleTypes(Class<?>... classes) {
SIMPLE_TYPES.removeAll(Arrays.asList(classes));
}
}