io.seata.common.util

类 ReflectionUtil

java.lang.Object

io.seata.common.util.ReflectionUtil

public final class ReflectionUtil
extends Object

Reflection tools

字段概要

字段

限定符和类型	字段和说明
static Object[]	EMPTY_ARGS The constant EMPTY_ARGS
static Class<?>[]	EMPTY_CLASS_ARRAY The constant EMPTY_CLASS_ARRAY
static Field[]	EMPTY_FIELD_ARRAY The constant EMPTY_FIELD_ARRAY

方法概要

限定符和类型	方法和说明
static String	annotationToString(Annotation annotation) annotatio to string
static String	classToString(Class<?> clazz) class to string
static String	fieldToString(Class<?> clazz, String fieldName, Class<?> fieldType) field to string
static String	fieldToString(Field field) field to string
static Field[]	getAllFields(Class<?> targetClazz) Gets all fields, excluding static or synthetic fields
static Map<String,Object>	getAnnotationValues(Annotation annotation) get annotation values
static Class<?>	getClassByName(String className) Gets class by name.
static Field	getField(Class<?> clazz, String fieldName) get Field
static <T> T	getFieldValue(Object target, Field field) get field value
static <T> T	getFieldValue(Object target, String fieldName) get field value
static Set<Class<?>>	getInterfaces(Class<?> clazz) get all interface of the clazz
static Method	getMethod(Class<?> clazz, String methodName) get method.
static Method	getMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes) get method.
static Object	invokeMethod(Object target, Method method) invoke Method
static Object	invokeMethod(Object target, Method method, Object... args) invoke Method
static Object	invokeMethod(Object target, String methodName) invoke Method
static Object	invokeMethod(Object target, String methodName, Class<?>[] parameterTypes, Object... args) invoke Method
static Object	invokeStaticMethod(Class<?> targetClass, String staticMethodName) invoke static Method
static Object	invokeStaticMethod(Class<?> targetClass, String staticMethodName, Class<?>[] parameterTypes, Object... args) invoke static Method
static Object	invokeStaticMethod(Method staticMethod) invoke static Method
static Object	invokeStaticMethod(Method staticMethod, Object... args) invoke static Method
static String	methodToString(Class<?> clazz, String methodName, Class<?>... parameterTypes) method to string
static String	methodToString(Method method) method to string
static void	modifyStaticFinalField(Class<?> targetClass, String staticFieldName, Object newValue) modify `static` or `static final` field value
static void	modifyStaticFinalField(Field staticField, Object newValue) modify `static` or `static final` field value In java17, this method cannot be used for final fields.
static String	parameterTypesToString(Class<?>[] parameterTypes) parameter types to string
static void	setFieldValue(Object target, Field field, Object fieldValue) set field value
static void	setFieldValue(Object target, String fieldName, Object fieldValue) get field value

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

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

字段详细资料

EMPTY_FIELD_ARRAY

public static final Field[] EMPTY_FIELD_ARRAY

The constant EMPTY_FIELD_ARRAY

EMPTY_CLASS_ARRAY

public static final Class<?>[] EMPTY_CLASS_ARRAY

The constant EMPTY_CLASS_ARRAY

EMPTY_ARGS

public static final Object[] EMPTY_ARGS

The constant EMPTY_ARGS

方法详细资料

getClassByName

public static Class<?> getClassByName(String className)
                               throws ClassNotFoundException

Gets class by name.

参数:

className - the class name

返回:

the class by name

抛出:

ClassNotFoundException - the class not found exception

getInterfaces

public static Set<Class<?>> getInterfaces(Class<?> clazz)

get all interface of the clazz

参数:

clazz - the clazz

返回:

set

getAllFields

public static Field[] getAllFields(Class<?> targetClazz)

Gets all fields, excluding static or synthetic fields

参数:

targetClazz - the target class

getField

public static Field getField(Class<?> clazz,
                             String fieldName)
                      throws NoSuchFieldException,
                             SecurityException

get Field

参数:

clazz - the class

fieldName - the field name

返回:

the field

抛出:

NoSuchFieldException - if the field named fieldName does not exist

SecurityException - the security exception

getFieldValue

public static <T> T getFieldValue(Object target,
                                  Field field)
                           throws IllegalArgumentException,
                                  SecurityException

get field value

类型参数:

T - the field type

参数:

target - the target

field - the field of the target

返回:

field value

抛出:

IllegalArgumentException - if target is null

SecurityException - the security exception

ClassCastException - if the type of the variable receiving the field value is not equals to the field type

getFieldValue

public static <T> T getFieldValue(Object target,
                                  String fieldName)
                           throws IllegalArgumentException,
                                  NoSuchFieldException,
                                  SecurityException

get field value

类型参数:

T - the field type

参数:

target - the target

fieldName - the field name

返回:

field value

抛出:

IllegalArgumentException - if target is null

NoSuchFieldException - if the field named fieldName does not exist

SecurityException - the security exception

ClassCastException - if the type of the variable receiving the field value is not equals to the field type

setFieldValue

public static void setFieldValue(Object target,
                                 Field field,
                                 Object fieldValue)
                          throws IllegalArgumentException,
                                 SecurityException

set field value

参数:

target - the target

field - the field of the target

fieldValue - the field value

抛出:

IllegalArgumentException - if target is null

SecurityException - the security exception

setFieldValue

public static void setFieldValue(Object target,
                                 String fieldName,
                                 Object fieldValue)
                          throws IllegalArgumentException,
                                 NoSuchFieldException,
                                 SecurityException

get field value

参数:

target - the target

fieldName - the field name

fieldValue - the field value

抛出:

IllegalArgumentException - if target is null

NoSuchFieldException - if the field named fieldName does not exist

SecurityException - the security exception

modifyStaticFinalField

public static void modifyStaticFinalField(Field staticField,
                                          Object newValue)
                                   throws NoSuchFieldException,
                                          IllegalAccessException

modify `static` or `static final` field value

In java17, this method cannot be used for final fields.

参数:

staticField - the static field

newValue - the new value

抛出:

IllegalArgumentException - if staticField is null or not a static field

NoSuchFieldException - if the class of the staticField has no `modifiers` field

IllegalAccessException - the illegal access exception

modifyStaticFinalField

public static void modifyStaticFinalField(Class<?> targetClass,
                                          String staticFieldName,
                                          Object newValue)
                                   throws NoSuchFieldException,
                                          IllegalAccessException

modify `static` or `static final` field value

参数:

targetClass - the target class

staticFieldName - the static field name

newValue - the new value

抛出:

IllegalArgumentException - if targetClass is null

NullPointerException - if staticFieldName is null

NoSuchFieldException - if the field named modifyFieldName does not exist

IllegalAccessException - the illegal access exception

getMethod

public static Method getMethod(Class<?> clazz,
                               String methodName,
                               Class<?>... parameterTypes)
                        throws NoSuchMethodException,
                               SecurityException

get method. If you want to get the public method, please use Class.getMethod(String, Class[]).

参数:

clazz - the class

methodName - the method name

parameterTypes - the parameter types

返回:

the method

抛出:

IllegalArgumentException - if clazz is null

NullPointerException - if methodName is null

NoSuchMethodException - if the method named methodName does not exist

SecurityException - the security exception

getMethod

public static Method getMethod(Class<?> clazz,
                               String methodName)
                        throws NoSuchMethodException,
                               SecurityException

get method. If you want to get the public method, please use Class.getMethod(String, Class[]).

参数:

clazz - the class

methodName - the method name

返回:

the method

抛出:

IllegalArgumentException - if clazz is null

NullPointerException - if methodName is null

NoSuchMethodException - if the method named methodName does not exist

SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  Method method,
                                  Object... args)
                           throws InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

参数:

target - the target

method - the method

args - the args

返回:

the result of the underlying method

抛出:

InvocationTargetException - if the underlying method throws an exception.

IllegalArgumentException - the illegal argument exception

SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  Method method)
                           throws InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

参数:

target - the target

method - the method

返回:

the result of the underlying method

抛出:

InvocationTargetException - if the underlying method throws an exception.

IllegalArgumentException - the illegal argument exception

SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName,
                                  Class<?>[] parameterTypes,
                                  Object... args)
                           throws NoSuchMethodException,
                                  InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

参数:

target - the target

methodName - the method name

parameterTypes - the parameter types

args - the args

返回:

the result of the underlying method

抛出:

IllegalArgumentException - if target is null

NullPointerException - if methodName is null

NoSuchMethodException - if the method named methodName does not exist

InvocationTargetException - if the underlying method throws an exception.

SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName)
                           throws NoSuchMethodException,
                                  InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

参数:

target - the target

methodName - the method name

返回:

the result of the underlying method

抛出:

NoSuchMethodException - the no such method exception

InvocationTargetException - if the underlying method throws an exception.

IllegalArgumentException - the illegal argument exception

SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Method staticMethod,
                                        Object... args)
                                 throws IllegalArgumentException,
                                        InvocationTargetException,
                                        SecurityException

invoke static Method

参数:

staticMethod - the static method

args - the args

返回:

the result of the static method

抛出:

IllegalArgumentException - if staticMethod is null or not a static method

InvocationTargetException - if the underlying method throws an exception.

SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Method staticMethod)
                                 throws InvocationTargetException,
                                        IllegalArgumentException,
                                        SecurityException

invoke static Method

参数:

staticMethod - the static method

返回:

the result of the static method

抛出:

InvocationTargetException - if the underlying method throws an exception.

IllegalArgumentException - the illegal argument exception

SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Class<?> targetClass,
                                        String staticMethodName,
                                        Class<?>[] parameterTypes,
                                        Object... args)
                                 throws IllegalArgumentException,
                                        NoSuchMethodException,
                                        InvocationTargetException,
                                        SecurityException

invoke static Method

参数:

targetClass - the target class

staticMethodName - the static method name

parameterTypes - the parameter types

args - the args

返回:

the result of the static method

抛出:

IllegalArgumentException - if targetClass is null

NullPointerException - if methodName is null

NoSuchMethodException - the no such method exception

InvocationTargetException - if the underlying method throws an exception.

SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Class<?> targetClass,
                                        String staticMethodName)
                                 throws IllegalArgumentException,
                                        NoSuchMethodException,
                                        SecurityException,
                                        InvocationTargetException

invoke static Method

参数:

targetClass - the target class

staticMethodName - the static method name

返回:

the result of the static method

抛出:

IllegalArgumentException - if targetClass is null

NullPointerException - if methodName is null

NoSuchMethodException - the no such method exception

InvocationTargetException - if the underlying method throws an exception.

SecurityException - the security exception

getAnnotationValues

public static Map<String,Object> getAnnotationValues(Annotation annotation)
                                              throws NoSuchFieldException

get annotation values

参数:

annotation - the annotation

抛出:

NoSuchFieldException - the no such field exception

classToString

public static String classToString(Class<?> clazz)

class to string

参数:

clazz - the class

返回:

the string

fieldToString

public static String fieldToString(Class<?> clazz,
                                   String fieldName,
                                   Class<?> fieldType)

field to string

参数:

clazz - the clazz

fieldName - the field name

fieldType - the field type

返回:

the string

fieldToString

public static String fieldToString(Field field)

field to string

参数:

field - the field

返回:

the string

methodToString

public static String methodToString(Class<?> clazz,
                                    String methodName,
                                    Class<?>... parameterTypes)

method to string

参数:

clazz - the clazz

methodName - the method name

parameterTypes - the parameter types

返回:

the string

methodToString

public static String methodToString(Method method)

method to string

参数:

method - the method

返回:

the string

annotationToString

public static String annotationToString(Annotation annotation)

annotatio to string

参数:

annotation - the annotation

返回:

the string

parameterTypesToString

public static String parameterTypesToString(Class<?>[] parameterTypes)

parameter types to string

参数:

parameterTypes - the parameter types

返回:

the string