cn.tom.kit.clazz

类 ReflectUtil

java.lang.Object

cn.tom.kit.clazz.ReflectUtil

public abstract class ReflectUtil
extends Object

反射工具类

作者:

Service Platform Architecture Team (spat@58.com)

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	ReflectUtil.FieldCallback Callback interface invoked on each field in the hierarchy.
static interface	ReflectUtil.FieldFilter Callback optionally used to filter fields to be operated on by a field callback.
static interface	ReflectUtil.MethodCallback Action to take on each method.
static interface	ReflectUtil.MethodFilter Callback optionally used to method fields to be operated on by a method callback.

字段概要

字段

限定符和类型	字段和说明
static ReflectUtil.FieldFilter	COPYABLE_FIELDS Pre-built FieldFilter that matches all non-static, non-final fields.
static ReflectUtil.MethodFilter	NON_BRIDGED_METHODS Pre-built MethodFilter that matches all non-bridge methods.
static ReflectUtil.MethodFilter	USER_DECLARED_METHODS Pre-built MethodFilter that matches all non-bridge methods which are not declared on java.lang.Object.

构造器概要

构造器

构造器和说明
ReflectUtil()

方法概要

方法

限定符和类型	方法和说明
static Map<String,Object>	beanToMap(Object bean) bean 转 map
static Object[]	convert(Method method, Object... params) 转换方法的所有参数类型
static Object	covert(Class<?> _class, Object param) 根据method形参转换参数,支持常用参数类型
static boolean	declaresException(Method method, Class<?> exceptionType) Determine whether the given method explicitly declares the given exception or one of its superclasses, which means that an exception of that type can be propagated as-is within a reflective invocation.
static void	doWithFields(Class<?> clazz, ReflectUtil.FieldCallback fc) Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.
static void	doWithFields(Class<?> clazz, ReflectUtil.FieldCallback fc, ReflectUtil.FieldFilter ff) Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.
static void	doWithMethods(Class<?> clazz, ReflectUtil.MethodCallback mc) Perform the given callback operation on all matching methods of the given class and superclasses.
static void	doWithMethods(Class<?> clazz, ReflectUtil.MethodCallback mc, ReflectUtil.MethodFilter mf) Perform the given callback operation on all matching methods of the given class and superclasses (or given interface and super-interfaces).
static void	doWithMethodsWithNoRecursion(Class<?> clazz, ReflectUtil.MethodCallback mc, ReflectUtil.MethodFilter mf) Perform the given callback operation on all matching methods of the given class and superclasses (or given interface and super-interfaces).
static Field	findField(Class<?> clazz, String name) Attempt to find a field on the supplied Class with the supplied name.
static Field	findField(Class<?> clazz, String name, Class<?> type) Attempt to find a field on the supplied Class with the supplied name and/or type.
static Method	findMethod(Class<?> clazz, String name) Attempt to find a Method on the supplied class with the supplied name and no parameters.
static Method	findMethod(Class<?> clazz, String name, Class<?>... paramTypes) Attempt to find a Method on the supplied class with the supplied name and parameter types.
static Method[]	getAllDeclaredMethods(Class<?> leafClass) Get all declared methods on the leaf class and all superclasses.
static Class<?>[]	getAllInterfacesForClass(Class<?> clazz) Return all interfaces that the given class implements as array, including ones implemented by superclasses.
static Class<?>[]	getAllInterfacesForClass(Class<?> clazz, ClassLoader classLoader) Return all interfaces that the given class implements as array, including ones implemented by superclasses.
static Set<Class>	getAllInterfacesForClassAsSet(Class clazz, ClassLoader classLoader) Return all interfaces that the given class implements as Set, including ones implemented by superclasses.
static Method	getDeclaredMethod(Class<?> _class, String methodName) 根据方法名获取方法
static Method	getDeclaredMethod(Object object, String methodName, Class<?>[] parameterTypes) 持续向上查找,直到找到某个方法
static Object	getField(Field field, Object target) Get the field represented by the supplied field object on the specified target object.
static Class<?>	getSuperClassGenricType(Class<?> clazz, int index) 查找泛型类的泛型
static void	handleInvocationTargetException(InvocationTargetException ex) Handle the given invocation target exception.
static void	handleReflectionException(Exception ex) Handle the given reflection exception.
static Object	invokeJdbcMethod(Method method, Object target) Invoke the specified JDBC API Method against the supplied target object with no arguments.
static Object	invokeJdbcMethod(Method method, Object target, Object... args) Invoke the specified JDBC API Method against the supplied target object with the supplied arguments.
static Object	invokeMethod(Method method, Object target) Invoke the specified Method against the supplied target object with no arguments.
static Object	invokeMethod(Method method, Object target, Object... args) Invoke the specified Method against the supplied target object with the supplied arguments.
static Object	invokeMethod(Object object, Method method, Object... params)
static Object	invokeMethodByConvert(Object object, Method method, Object... params) method.setAccessible(true); 执行方法 method.invoke(obj, params...)
static boolean	isEqualsMethod(Method method) Determine whether the given method is an "equals" method.
static boolean	isHashCodeMethod(Method method) Determine whether the given method is a "hashCode" method.
static boolean	isPublicStaticFinal(Field field) Determine whether the given field is a "public static final" constant.
static boolean	isToStringMethod(Method method) Determine whether the given method is a "toString" method.
static boolean	isVisible(Class<?> clazz, ClassLoader classLoader) Check whether the given class is visible in the given ClassLoader.
static void	makeAccessible(Constructor<?> ctor) Make the given constructor accessible, explicitly setting it accessible if necessary.
static void	makeAccessible(Field field) Make the given field accessible, explicitly setting it accessible if necessary.
static void	makeAccessible(Method method) Make the given method accessible, explicitly setting it accessible if necessary.
static <T> T	mapToBean(Map<String,?> map, Class<T> _class) map 转 bean
static void	populate(Object obj, Properties prop) 将prop 注入到 obj(CoC name --> setName 注入)
static void	rethrowException(Throwable ex) Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
static void	rethrowRuntimeException(Throwable ex) Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
static void	setField(Field field, Object target, Object value) Set the field represented by the supplied field object on the specified target object to the specified value.
static void	shallowCopyFieldState(Object src, Object dest) Given the source object and the destination, which must be the same class or a subclass, copy all fields, including inherited fields.
static String	toGetMethod(String name)
static String	toSetMethod(String name)
static String	toTitleCase(String name)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

COPYABLE_FIELDS

public static ReflectUtil.FieldFilter COPYABLE_FIELDS

Pre-built FieldFilter that matches all non-static, non-final fields.

NON_BRIDGED_METHODS

public static ReflectUtil.MethodFilter NON_BRIDGED_METHODS

Pre-built MethodFilter that matches all non-bridge methods.

USER_DECLARED_METHODS

public static ReflectUtil.MethodFilter USER_DECLARED_METHODS

Pre-built MethodFilter that matches all non-bridge methods which are not declared on java.lang.Object.

构造器详细资料

ReflectUtil

public ReflectUtil()

方法详细资料

toTitleCase

public static String toTitleCase(String name)

toSetMethod

public static String toSetMethod(String name)

toGetMethod

public static String toGetMethod(String name)

invokeMethodByConvert

public static Object invokeMethodByConvert(Object object,
                           Method method,
                           Object... params)

method.setAccessible(true); 执行方法 method.invoke(obj, params...) 返回方法的执行结果, void 返回null, obj为实例[静态方法可为NULL], params 为参数,无参可为0[NULL]

invokeMethod

public static Object invokeMethod(Object object,
                  Method method,
                  Object... params)

convert

public static Object[] convert(Method method,
               Object... params)

转换方法的所有参数类型

参数:

method -

params -

返回:

covert

public static Object covert(Class<?> _class,
            Object param)

根据method形参转换参数,支持常用参数类型

参数:

_class -

param -

返回:

getDeclaredMethod

public static Method getDeclaredMethod(Object object,
                       String methodName,
                       Class<?>[] parameterTypes)

持续向上查找,直到找到某个方法

getDeclaredMethod

public static Method getDeclaredMethod(Class<?> _class,
                       String methodName)

根据方法名获取方法

getSuperClassGenricType

public static Class<?> getSuperClassGenricType(Class<?> clazz,
                               int index)

查找泛型类的泛型

mapToBean

public static <T> T mapToBean(Map<String,?> map,
              Class<T> _class)

map 转 bean

类型参数:

T -

参数:

map -

_class -

返回:

beanToMap

public static Map<String,Object> beanToMap(Object bean)

bean 转 map

参数:

bean -

返回:

isVisible

public static boolean isVisible(Class<?> clazz,
                ClassLoader classLoader)

Check whether the given class is visible in the given ClassLoader.

参数:

clazz - the class to check (typically an interface)

classLoader - the ClassLoader to check against (may be null, in which case this method will always return true)

getAllInterfacesForClass

public static Class<?>[] getAllInterfacesForClass(Class<?> clazz)

Return all interfaces that the given class implements as array, including ones implemented by superclasses.

If the class itself is an interface, it gets returned as sole interface.

参数:

clazz - the class to analyze for interfaces

返回:

all interfaces that the given object implements as array

getAllInterfacesForClass

public static Class<?>[] getAllInterfacesForClass(Class<?> clazz,
                                  ClassLoader classLoader)

Return all interfaces that the given class implements as array, including ones implemented by superclasses.

If the class itself is an interface, it gets returned as sole interface.

参数:

clazz - the class to analyze for interfaces

classLoader - the ClassLoader that the interfaces need to be visible in (may be null when accepting all declared interfaces)

返回:

all interfaces that the given object implements as array

getAllInterfacesForClassAsSet

public static Set<Class> getAllInterfacesForClassAsSet(Class clazz,
                                       ClassLoader classLoader)

Return all interfaces that the given class implements as Set, including ones implemented by superclasses.

If the class itself is an interface, it gets returned as sole interface.

参数:

clazz - the class to analyze for interfaces

classLoader - the ClassLoader that the interfaces need to be visible in (may be null when accepting all declared interfaces)

返回:

all interfaces that the given object implements as Set

populate

public static void populate(Object obj,
            Properties prop)

将prop 注入到 obj(CoC name --> setName 注入)

抛出:

SecurityException

NoSuchMethodException

findField

public static Field findField(Class<?> clazz,
              String name)

Attempt to find a field on the supplied Class with the supplied name. Searches all superclasses up to Object.

参数:

clazz - the class to introspect

name - the name of the field

返回:

the corresponding Field object, or null if not found

findField

public static Field findField(Class<?> clazz,
              String name,
              Class<?> type)

Attempt to find a field on the supplied Class with the supplied name and/or type. Searches all superclasses up to Object.

参数:

clazz - the class to introspect

name - the name of the field (may be null if type is specified)

type - the type of the field (may be null if name is specified)

返回:

the corresponding Field object, or null if not found

setField

public static void setField(Field field,
            Object target,
            Object value)

Set the field represented by the supplied field object on the specified target object to the specified value. In accordance with Field.set(Object, Object) semantics, the new value is automatically unwrapped if the underlying field has a primitive type.

Thrown exceptions are handled via a call to handleReflectionException(Exception).

参数:

field - the field to set

target - the target object on which to set the field

value - the value to set; may be null

getField

public static Object getField(Field field,
              Object target)

Get the field represented by the supplied field object on the specified target object. In accordance with Field.get(Object) semantics, the returned value is automatically wrapped if the underlying field has a primitive type.

Thrown exceptions are handled via a call to handleReflectionException(Exception).

参数:

field - the field to get

target - the target object from which to get the field

返回:

the field's current value

findMethod

public static Method findMethod(Class<?> clazz,
                String name)

Attempt to find a Method on the supplied class with the supplied name and no parameters. Searches all superclasses up to Object.

Returns null if no Method can be found.

参数:

clazz - the class to introspect

name - the name of the method

返回:

the Method object, or null if none found

findMethod

public static Method findMethod(Class<?> clazz,
                String name,
                Class<?>... paramTypes)

Attempt to find a Method on the supplied class with the supplied name and parameter types. Searches all superclasses up to Object.

Returns null if no Method can be found.

参数:

clazz - the class to introspect

name - the name of the method

paramTypes - the parameter types of the method (may be null to indicate any signature)

返回:

the Method object, or null if none found

invokeMethod

public static Object invokeMethod(Method method,
                  Object target)

Invoke the specified Method against the supplied target object with no arguments. The target object can be null when invoking a static Method.

Thrown exceptions are handled via a call to handleReflectionException(java.lang.Exception).

参数:

method - the method to invoke

target - the target object to invoke the method on

返回:

the invocation result, if any

另请参阅:

invokeMethod(java.lang.reflect.Method, Object, Object[])

invokeMethod

public static Object invokeMethod(Method method,
                  Object target,
                  Object... args)

Invoke the specified Method against the supplied target object with the supplied arguments. The target object can be null when invoking a static Method.

Thrown exceptions are handled via a call to handleReflectionException(java.lang.Exception).

参数:

method - the method to invoke

target - the target object to invoke the method on

args - the invocation arguments (may be null)

返回:

the invocation result, if any

invokeJdbcMethod

public static Object invokeJdbcMethod(Method method,
                      Object target)
                               throws SQLException

Invoke the specified JDBC API Method against the supplied target object with no arguments.

参数:

method - the method to invoke

target - the target object to invoke the method on

返回:

the invocation result, if any

抛出:

SQLException - the JDBC API SQLException to rethrow (if any)

另请参阅:

invokeJdbcMethod(java.lang.reflect.Method, Object, Object[])

invokeJdbcMethod

public static Object invokeJdbcMethod(Method method,
                      Object target,
                      Object... args)

Invoke the specified JDBC API Method against the supplied target object with the supplied arguments.

参数:

method - the method to invoke

target - the target object to invoke the method on

args - the invocation arguments (may be null)

返回:

the invocation result, if any

抛出:

SQLException - the JDBC API SQLException to rethrow (if any)

另请参阅:

invokeMethod(java.lang.reflect.Method, Object, Object[])

handleReflectionException

public static void handleReflectionException(Exception ex)

Handle the given reflection exception. Should only be called if no checked exception is expected to be thrown by the target method.

Throws the underlying RuntimeException or Error in case of an InvocationTargetException with such a root cause. Throws an IllegalStateException with an appropriate message else.

参数:

ex - the reflection exception to handle

handleInvocationTargetException

public static void handleInvocationTargetException(InvocationTargetException ex)

Handle the given invocation target exception. Should only be called if no checked exception is expected to be thrown by the target method.

Throws the underlying RuntimeException or Error in case of such a root cause. Throws an IllegalStateException else.

参数:

ex - the invocation target exception to handle

rethrowRuntimeException

public static void rethrowRuntimeException(Throwable ex)

Rethrow the given exception, which is presumably the target exception of an InvocationTargetException. Should only be called if no checked exception is expected to be thrown by the target method.

Rethrows the underlying exception cast to an RuntimeException or Error if appropriate; otherwise, throws an IllegalStateException.

参数:

ex - the exception to rethrow

抛出:

RuntimeException - the rethrown exception

rethrowException

public static void rethrowException(Throwable ex)
                             throws Exception

Rethrow the given exception, which is presumably the target exception of an InvocationTargetException. Should only be called if no checked exception is expected to be thrown by the target method.

Rethrows the underlying exception cast to an Exception or Error if appropriate; otherwise, throws an IllegalStateException.

参数:

ex - the exception to rethrow

抛出:

Exception - the rethrown exception (in case of a checked exception)

declaresException

public static boolean declaresException(Method method,
                        Class<?> exceptionType)

Determine whether the given method explicitly declares the given exception or one of its superclasses, which means that an exception of that type can be propagated as-is within a reflective invocation.

参数:

method - the declaring method

exceptionType - the exception to throw

返回:

true if the exception can be thrown as-is; false if it needs to be wrapped

isPublicStaticFinal

public static boolean isPublicStaticFinal(Field field)

Determine whether the given field is a "public static final" constant.

参数:

field - the field to check

isEqualsMethod

public static boolean isEqualsMethod(Method method)

Determine whether the given method is an "equals" method.

另请参阅:

Object.equals(Object)

isHashCodeMethod

public static boolean isHashCodeMethod(Method method)

Determine whether the given method is a "hashCode" method.

另请参阅:

Object.hashCode()

isToStringMethod

public static boolean isToStringMethod(Method method)

Determine whether the given method is a "toString" method.

另请参阅:

Object.toString()

makeAccessible

public static void makeAccessible(Field field)

Make the given field accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

field - the field to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

makeAccessible

public static void makeAccessible(Method method)

Make the given method accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

method - the method to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

makeAccessible

public static void makeAccessible(Constructor<?> ctor)

Make the given constructor accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

ctor - the constructor to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

doWithMethods

public static void doWithMethods(Class<?> clazz,
                 ReflectUtil.MethodCallback mc)
                          throws IllegalArgumentException

Perform the given callback operation on all matching methods of the given class and superclasses.

The same named method occurring on subclass and superclass will appear twice, unless excluded by a ReflectUtil.MethodFilter.

参数:

clazz - class to start looking at

mc - the callback to invoke for each method

抛出:

IllegalArgumentException

另请参阅:

doWithMethods(Class, MethodCallback, MethodFilter)

doWithMethods

public static void doWithMethods(Class<?> clazz,
                 ReflectUtil.MethodCallback mc,
                 ReflectUtil.MethodFilter mf)
                          throws IllegalArgumentException

Perform the given callback operation on all matching methods of the given class and superclasses (or given interface and super-interfaces).

The same named method occurring on subclass and superclass will appear twice, unless excluded by the specified ReflectUtil.MethodFilter.

参数:

clazz - class to start looking at

mc - the callback to invoke for each method

mf - the filter that determines the methods to apply the callback to

抛出:

IllegalArgumentException

doWithMethodsWithNoRecursion

public static void doWithMethodsWithNoRecursion(Class<?> clazz,
                                ReflectUtil.MethodCallback mc,
                                ReflectUtil.MethodFilter mf)
                                         throws IllegalArgumentException

Perform the given callback operation on all matching methods of the given class and superclasses (or given interface and super-interfaces).

The same named method occurring on subclass and superclass will appear twice, unless excluded by the specified ReflectUtil.MethodFilter.

参数:

clazz - class to start looking at

mc - the callback to invoke for each method

mf - the filter that determines the methods to apply the callback to

抛出:

IllegalArgumentException

getAllDeclaredMethods

public static Method[] getAllDeclaredMethods(Class<?> leafClass)
                                      throws IllegalArgumentException

Get all declared methods on the leaf class and all superclasses. Leaf class methods are included first.

抛出:

IllegalArgumentException

doWithFields

public static void doWithFields(Class<?> clazz,
                ReflectUtil.FieldCallback fc)
                         throws IllegalArgumentException

Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.

参数:

clazz - the target class to analyze

fc - the callback to invoke for each field

抛出:

IllegalArgumentException

doWithFields

public static void doWithFields(Class<?> clazz,
                ReflectUtil.FieldCallback fc,
                ReflectUtil.FieldFilter ff)
                         throws IllegalArgumentException

Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.

参数:

clazz - the target class to analyze

fc - the callback to invoke for each field

ff - the filter that determines the fields to apply the callback to

抛出:

IllegalArgumentException

shallowCopyFieldState

public static void shallowCopyFieldState(Object src,
                         Object dest)
                                  throws IllegalArgumentException

Given the source object and the destination, which must be the same class or a subclass, copy all fields, including inherited fields. Designed to work on objects with public no-arg constructors.

抛出:

IllegalArgumentException - if the arguments are incompatible