• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

mybatis / mybatis-3 / #3690

15 Jul 2024 12:32AM CUT coverage: 87.175% (-0.009%) from 87.184%
#3690

Pull #3200

github

web-flow
Merge 0f7011852 into 6d537648a
Pull Request #3200: [ci] Update copyright dates

3540 of 4289 branches covered (82.54%)

9394 of 10776 relevant lines covered (87.18%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.02
/src/main/java/org/apache/ibatis/reflection/Reflector.java
1
/*
2
 *    Copyright 2009-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
package org.apache.ibatis.reflection;
17

18
import java.lang.invoke.MethodHandle;
19
import java.lang.invoke.MethodHandles;
20
import java.lang.invoke.MethodType;
21
import java.lang.reflect.Array;
22
import java.lang.reflect.Constructor;
23
import java.lang.reflect.Field;
24
import java.lang.reflect.GenericArrayType;
25
import java.lang.reflect.Method;
26
import java.lang.reflect.Modifier;
27
import java.lang.reflect.ParameterizedType;
28
import java.lang.reflect.ReflectPermission;
29
import java.lang.reflect.Type;
30
import java.text.MessageFormat;
31
import java.util.ArrayList;
32
import java.util.Arrays;
33
import java.util.Collection;
34
import java.util.HashMap;
35
import java.util.List;
36
import java.util.Locale;
37
import java.util.Map;
38
import java.util.Map.Entry;
39

40
import org.apache.ibatis.reflection.invoker.AmbiguousMethodInvoker;
41
import org.apache.ibatis.reflection.invoker.GetFieldInvoker;
42
import org.apache.ibatis.reflection.invoker.Invoker;
43
import org.apache.ibatis.reflection.invoker.MethodInvoker;
44
import org.apache.ibatis.reflection.invoker.SetFieldInvoker;
45
import org.apache.ibatis.reflection.property.PropertyNamer;
46
import org.apache.ibatis.util.MapUtil;
47

48
/**
49
 * This class represents a cached set of class definition information that allows for easy mapping between property
50
 * names and getter/setter methods.
51
 *
52
 * @author Clinton Begin
53
 */
54
public class Reflector {
55

56
  private static final MethodHandle isRecordMethodHandle = getIsRecordMethodHandle();
1✔
57
  private final Class<?> type;
58
  private final String[] readablePropertyNames;
59
  private final String[] writablePropertyNames;
60
  private final Map<String, Invoker> setMethods = new HashMap<>();
1✔
61
  private final Map<String, Invoker> getMethods = new HashMap<>();
1✔
62
  private final Map<String, Class<?>> setTypes = new HashMap<>();
1✔
63
  private final Map<String, Class<?>> getTypes = new HashMap<>();
1✔
64
  private Constructor<?> defaultConstructor;
65

66
  private final Map<String, String> caseInsensitivePropertyMap = new HashMap<>();
1✔
67

68
  public Reflector(Class<?> clazz) {
1✔
69
    type = clazz;
1✔
70
    addDefaultConstructor(clazz);
1✔
71
    Method[] classMethods = getClassMethods(clazz);
1✔
72
    if (isRecord(type)) {
1✔
73
      addRecordGetMethods(classMethods);
1✔
74
    } else {
75
      addGetMethods(classMethods);
1✔
76
      addSetMethods(classMethods);
1✔
77
      addFields(clazz);
1✔
78
    }
79
    readablePropertyNames = getMethods.keySet().toArray(new String[0]);
1✔
80
    writablePropertyNames = setMethods.keySet().toArray(new String[0]);
1✔
81
    for (String propName : readablePropertyNames) {
1✔
82
      caseInsensitivePropertyMap.put(propName.toUpperCase(Locale.ENGLISH), propName);
1✔
83
    }
84
    for (String propName : writablePropertyNames) {
1✔
85
      caseInsensitivePropertyMap.put(propName.toUpperCase(Locale.ENGLISH), propName);
1✔
86
    }
87
  }
1✔
88

89
  private void addRecordGetMethods(Method[] methods) {
90
    Arrays.stream(methods).filter(m -> m.getParameterTypes().length == 0)
1✔
91
        .forEach(m -> addGetMethod(m.getName(), m, false));
1✔
92
  }
1✔
93

94
  private void addDefaultConstructor(Class<?> clazz) {
95
    Constructor<?>[] constructors = clazz.getDeclaredConstructors();
1✔
96
    Arrays.stream(constructors).filter(constructor -> constructor.getParameterTypes().length == 0).findAny()
1✔
97
        .ifPresent(constructor -> this.defaultConstructor = constructor);
1✔
98
  }
1✔
99

100
  private void addGetMethods(Method[] methods) {
101
    Map<String, List<Method>> conflictingGetters = new HashMap<>();
1✔
102
    Arrays.stream(methods).filter(m -> m.getParameterTypes().length == 0 && PropertyNamer.isGetter(m.getName()))
1✔
103
        .forEach(m -> addMethodConflict(conflictingGetters, PropertyNamer.methodToProperty(m.getName()), m));
1✔
104
    resolveGetterConflicts(conflictingGetters);
1✔
105
  }
1✔
106

107
  private void resolveGetterConflicts(Map<String, List<Method>> conflictingGetters) {
108
    for (Entry<String, List<Method>> entry : conflictingGetters.entrySet()) {
1✔
109
      Method winner = null;
1✔
110
      String propName = entry.getKey();
1✔
111
      boolean isAmbiguous = false;
1✔
112
      for (Method candidate : entry.getValue()) {
1✔
113
        if (winner == null) {
1✔
114
          winner = candidate;
1✔
115
          continue;
1✔
116
        }
117
        Class<?> winnerType = winner.getReturnType();
1✔
118
        Class<?> candidateType = candidate.getReturnType();
1✔
119
        if (candidateType.equals(winnerType)) {
1✔
120
          if (!boolean.class.equals(candidateType)) {
1✔
121
            isAmbiguous = true;
1✔
122
            break;
1✔
123
          }
124
          if (candidate.getName().startsWith("is")) {
1!
125
            winner = candidate;
×
126
          }
127
        } else if (candidateType.isAssignableFrom(winnerType)) {
1✔
128
          // OK getter type is descendant
129
        } else if (winnerType.isAssignableFrom(candidateType)) {
1✔
130
          winner = candidate;
1✔
131
        } else {
132
          isAmbiguous = true;
1✔
133
          break;
1✔
134
        }
135
      }
1✔
136
      addGetMethod(propName, winner, isAmbiguous);
1✔
137
    }
1✔
138
  }
1✔
139

140
  private void addGetMethod(String name, Method method, boolean isAmbiguous) {
141
    MethodInvoker invoker = isAmbiguous ? new AmbiguousMethodInvoker(method, MessageFormat.format(
1✔
142
        "Illegal overloaded getter method with ambiguous type for property ''{0}'' in class ''{1}''. This breaks the JavaBeans specification and can cause unpredictable results.",
143
        name, method.getDeclaringClass().getName())) : new MethodInvoker(method);
1✔
144
    getMethods.put(name, invoker);
1✔
145
    Type returnType = TypeParameterResolver.resolveReturnType(method, type);
1✔
146
    getTypes.put(name, typeToClass(returnType));
1✔
147
  }
1✔
148

149
  private void addSetMethods(Method[] methods) {
150
    Map<String, List<Method>> conflictingSetters = new HashMap<>();
1✔
151
    Arrays.stream(methods).filter(m -> m.getParameterTypes().length == 1 && PropertyNamer.isSetter(m.getName()))
1✔
152
        .forEach(m -> addMethodConflict(conflictingSetters, PropertyNamer.methodToProperty(m.getName()), m));
1✔
153
    resolveSetterConflicts(conflictingSetters);
1✔
154
  }
1✔
155

156
  private void addMethodConflict(Map<String, List<Method>> conflictingMethods, String name, Method method) {
157
    if (isValidPropertyName(name)) {
1!
158
      List<Method> list = MapUtil.computeIfAbsent(conflictingMethods, name, k -> new ArrayList<>());
1✔
159
      list.add(method);
1✔
160
    }
161
  }
1✔
162

163
  private void resolveSetterConflicts(Map<String, List<Method>> conflictingSetters) {
164
    for (Entry<String, List<Method>> entry : conflictingSetters.entrySet()) {
1✔
165
      String propName = entry.getKey();
1✔
166
      List<Method> setters = entry.getValue();
1✔
167
      Class<?> getterType = getTypes.get(propName);
1✔
168
      boolean isGetterAmbiguous = getMethods.get(propName) instanceof AmbiguousMethodInvoker;
1✔
169
      boolean isSetterAmbiguous = false;
1✔
170
      Method match = null;
1✔
171
      for (Method setter : setters) {
1✔
172
        if (!isGetterAmbiguous && setter.getParameterTypes()[0].equals(getterType)) {
1✔
173
          // should be the best match
174
          match = setter;
1✔
175
          break;
1✔
176
        }
177
        if (!isSetterAmbiguous) {
1✔
178
          match = pickBetterSetter(match, setter, propName);
1✔
179
          isSetterAmbiguous = match == null;
1✔
180
        }
181
      }
1✔
182
      if (match != null) {
1✔
183
        addSetMethod(propName, match);
1✔
184
      }
185
    }
1✔
186
  }
1✔
187

188
  private Method pickBetterSetter(Method setter1, Method setter2, String property) {
189
    if (setter1 == null) {
1✔
190
      return setter2;
1✔
191
    }
192
    Class<?> paramType1 = setter1.getParameterTypes()[0];
1✔
193
    Class<?> paramType2 = setter2.getParameterTypes()[0];
1✔
194
    if (paramType1.isAssignableFrom(paramType2)) {
1!
195
      return setter2;
×
196
    }
197
    if (paramType2.isAssignableFrom(paramType1)) {
1✔
198
      return setter1;
1✔
199
    }
200
    MethodInvoker invoker = new AmbiguousMethodInvoker(setter1,
1✔
201
        MessageFormat.format(
1✔
202
            "Ambiguous setters defined for property ''{0}'' in class ''{1}'' with types ''{2}'' and ''{3}''.", property,
203
            setter2.getDeclaringClass().getName(), paramType1.getName(), paramType2.getName()));
1✔
204
    setMethods.put(property, invoker);
1✔
205
    Type[] paramTypes = TypeParameterResolver.resolveParamTypes(setter1, type);
1✔
206
    setTypes.put(property, typeToClass(paramTypes[0]));
1✔
207
    return null;
1✔
208
  }
209

210
  private void addSetMethod(String name, Method method) {
211
    MethodInvoker invoker = new MethodInvoker(method);
1✔
212
    setMethods.put(name, invoker);
1✔
213
    Type[] paramTypes = TypeParameterResolver.resolveParamTypes(method, type);
1✔
214
    setTypes.put(name, typeToClass(paramTypes[0]));
1✔
215
  }
1✔
216

217
  private Class<?> typeToClass(Type src) {
218
    Class<?> result = null;
1✔
219
    if (src instanceof Class) {
1✔
220
      result = (Class<?>) src;
1✔
221
    } else if (src instanceof ParameterizedType) {
1✔
222
      result = (Class<?>) ((ParameterizedType) src).getRawType();
1✔
223
    } else if (src instanceof GenericArrayType) {
1!
224
      Type componentType = ((GenericArrayType) src).getGenericComponentType();
1✔
225
      if (componentType instanceof Class) {
1!
226
        result = Array.newInstance((Class<?>) componentType, 0).getClass();
×
227
      } else {
228
        Class<?> componentClass = typeToClass(componentType);
1✔
229
        result = Array.newInstance(componentClass, 0).getClass();
1✔
230
      }
231
    }
232
    if (result == null) {
1!
233
      result = Object.class;
×
234
    }
235
    return result;
1✔
236
  }
237

238
  private void addFields(Class<?> clazz) {
239
    Field[] fields = clazz.getDeclaredFields();
1✔
240
    for (Field field : fields) {
1✔
241
      if (!setMethods.containsKey(field.getName())) {
1✔
242
        // issue #379 - removed the check for final because JDK 1.5 allows
243
        // modification of final fields through reflection (JSR-133). (JGB)
244
        // pr #16 - final static can only be set by the classloader
245
        int modifiers = field.getModifiers();
1✔
246
        if ((!Modifier.isFinal(modifiers) || !Modifier.isStatic(modifiers))) {
1✔
247
          addSetField(field);
1✔
248
        }
249
      }
250
      if (!getMethods.containsKey(field.getName())) {
1✔
251
        addGetField(field);
1✔
252
      }
253
    }
254
    if (clazz.getSuperclass() != null) {
1✔
255
      addFields(clazz.getSuperclass());
1✔
256
    }
257
  }
1✔
258

259
  private void addSetField(Field field) {
260
    if (isValidPropertyName(field.getName())) {
1!
261
      setMethods.put(field.getName(), new SetFieldInvoker(field));
1✔
262
      Type fieldType = TypeParameterResolver.resolveFieldType(field, type);
1✔
263
      setTypes.put(field.getName(), typeToClass(fieldType));
1✔
264
    }
265
  }
1✔
266

267
  private void addGetField(Field field) {
268
    if (isValidPropertyName(field.getName())) {
1✔
269
      getMethods.put(field.getName(), new GetFieldInvoker(field));
1✔
270
      Type fieldType = TypeParameterResolver.resolveFieldType(field, type);
1✔
271
      getTypes.put(field.getName(), typeToClass(fieldType));
1✔
272
    }
273
  }
1✔
274

275
  private boolean isValidPropertyName(String name) {
276
    return (!name.startsWith("$") && !"serialVersionUID".equals(name) && !"class".equals(name));
1!
277
  }
278

279
  /**
280
   * This method returns an array containing all methods declared in this class and any superclass. We use this method,
281
   * instead of the simpler <code>Class.getMethods()</code>, because we want to look for private methods as well.
282
   *
283
   * @param clazz
284
   *          The class
285
   *
286
   * @return An array containing all methods in this class
287
   */
288
  private Method[] getClassMethods(Class<?> clazz) {
289
    Map<String, Method> uniqueMethods = new HashMap<>();
1✔
290
    Class<?> currentClass = clazz;
1✔
291
    while (currentClass != null && currentClass != Object.class) {
1✔
292
      addUniqueMethods(uniqueMethods, currentClass.getDeclaredMethods());
1✔
293

294
      // we also need to look for interface methods -
295
      // because the class may be abstract
296
      Class<?>[] interfaces = currentClass.getInterfaces();
1✔
297
      for (Class<?> anInterface : interfaces) {
1✔
298
        addUniqueMethods(uniqueMethods, anInterface.getMethods());
1✔
299
      }
300

301
      currentClass = currentClass.getSuperclass();
1✔
302
    }
1✔
303

304
    Collection<Method> methods = uniqueMethods.values();
1✔
305

306
    return methods.toArray(new Method[0]);
1✔
307
  }
308

309
  private void addUniqueMethods(Map<String, Method> uniqueMethods, Method[] methods) {
310
    for (Method currentMethod : methods) {
1✔
311
      if (!currentMethod.isBridge()) {
1✔
312
        String signature = getSignature(currentMethod);
1✔
313
        // check to see if the method is already known
314
        // if it is known, then an extended class must have
315
        // overridden a method
316
        if (!uniqueMethods.containsKey(signature)) {
1✔
317
          uniqueMethods.put(signature, currentMethod);
1✔
318
        }
319
      }
320
    }
321
  }
1✔
322

323
  private String getSignature(Method method) {
324
    StringBuilder sb = new StringBuilder();
1✔
325
    Class<?> returnType = method.getReturnType();
1✔
326
    sb.append(returnType.getName()).append('#');
1✔
327
    sb.append(method.getName());
1✔
328
    Class<?>[] parameters = method.getParameterTypes();
1✔
329
    for (int i = 0; i < parameters.length; i++) {
1✔
330
      sb.append(i == 0 ? ':' : ',').append(parameters[i].getName());
1✔
331
    }
332
    return sb.toString();
1✔
333
  }
334

335
  /**
336
   * Checks whether can control member accessible.
337
   *
338
   * @return If can control member accessible, it return {@literal true}
339
   *
340
   * @since 3.5.0
341
   */
342
  public static boolean canControlMemberAccessible() {
343
    try {
344
      SecurityManager securityManager = System.getSecurityManager();
1✔
345
      if (null != securityManager) {
1!
346
        securityManager.checkPermission(new ReflectPermission("suppressAccessChecks"));
×
347
      }
348
    } catch (SecurityException e) {
×
349
      return false;
×
350
    }
1✔
351
    return true;
1✔
352
  }
353

354
  /**
355
   * Gets the name of the class the instance provides information for.
356
   *
357
   * @return The class name
358
   */
359
  public Class<?> getType() {
360
    return type;
1✔
361
  }
362

363
  public Constructor<?> getDefaultConstructor() {
364
    if (defaultConstructor != null) {
×
365
      return defaultConstructor;
×
366
    }
367
    throw new ReflectionException("There is no default constructor for " + type);
×
368
  }
369

370
  public boolean hasDefaultConstructor() {
371
    return defaultConstructor != null;
1✔
372
  }
373

374
  public Invoker getSetInvoker(String propertyName) {
375
    Invoker method = setMethods.get(propertyName);
1✔
376
    if (method == null) {
1!
377
      throw new ReflectionException("There is no setter for property named '" + propertyName + "' in '" + type + "'");
×
378
    }
379
    return method;
1✔
380
  }
381

382
  public Invoker getGetInvoker(String propertyName) {
383
    Invoker method = getMethods.get(propertyName);
1✔
384
    if (method == null) {
1✔
385
      throw new ReflectionException("There is no getter for property named '" + propertyName + "' in '" + type + "'");
1✔
386
    }
387
    return method;
1✔
388
  }
389

390
  /**
391
   * Gets the type for a property setter.
392
   *
393
   * @param propertyName
394
   *          - the name of the property
395
   *
396
   * @return The Class of the property setter
397
   */
398
  public Class<?> getSetterType(String propertyName) {
399
    Class<?> clazz = setTypes.get(propertyName);
1✔
400
    if (clazz == null) {
1✔
401
      throw new ReflectionException("There is no setter for property named '" + propertyName + "' in '" + type + "'");
1✔
402
    }
403
    return clazz;
1✔
404
  }
405

406
  /**
407
   * Gets the type for a property getter.
408
   *
409
   * @param propertyName
410
   *          - the name of the property
411
   *
412
   * @return The Class of the property getter
413
   */
414
  public Class<?> getGetterType(String propertyName) {
415
    Class<?> clazz = getTypes.get(propertyName);
1✔
416
    if (clazz == null) {
1✔
417
      throw new ReflectionException("There is no getter for property named '" + propertyName + "' in '" + type + "'");
1✔
418
    }
419
    return clazz;
1✔
420
  }
421

422
  /**
423
   * Gets an array of the readable properties for an object.
424
   *
425
   * @return The array
426
   */
427
  public String[] getGetablePropertyNames() {
428
    return readablePropertyNames;
1✔
429
  }
430

431
  /**
432
   * Gets an array of the writable properties for an object.
433
   *
434
   * @return The array
435
   */
436
  public String[] getSetablePropertyNames() {
437
    return writablePropertyNames;
1✔
438
  }
439

440
  /**
441
   * Check to see if a class has a writable property by name.
442
   *
443
   * @param propertyName
444
   *          - the name of the property to check
445
   *
446
   * @return True if the object has a writable property by the name
447
   */
448
  public boolean hasSetter(String propertyName) {
449
    return setMethods.containsKey(propertyName);
1✔
450
  }
451

452
  /**
453
   * Check to see if a class has a readable property by name.
454
   *
455
   * @param propertyName
456
   *          - the name of the property to check
457
   *
458
   * @return True if the object has a readable property by the name
459
   */
460
  public boolean hasGetter(String propertyName) {
461
    return getMethods.containsKey(propertyName);
1✔
462
  }
463

464
  public String findPropertyName(String name) {
465
    return caseInsensitivePropertyMap.get(name.toUpperCase(Locale.ENGLISH));
1✔
466
  }
467

468
  /**
469
   * Class.isRecord() alternative for Java 15 and older.
470
   */
471
  private static boolean isRecord(Class<?> clazz) {
472
    try {
473
      return isRecordMethodHandle != null && (boolean) isRecordMethodHandle.invokeExact(clazz);
1!
474
    } catch (Throwable e) {
×
475
      throw new ReflectionException("Failed to invoke 'Class.isRecord()'.", e);
×
476
    }
477
  }
478

479
  private static MethodHandle getIsRecordMethodHandle() {
480
    MethodHandles.Lookup lookup = MethodHandles.lookup();
1✔
481
    MethodType mt = MethodType.methodType(boolean.class);
1✔
482
    try {
483
      return lookup.findVirtual(Class.class, "isRecord", mt);
1✔
484
    } catch (NoSuchMethodException | IllegalAccessException e) {
×
485
      return null;
×
486
    }
487
  }
488
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc