MethodScanner (hutool-core 6.0.0-M6 API)

java.lang.Object
- org.dromara.hutool.core.reflect.method.MethodScanner

```
public class MethodScanner
extends Object
```
方法查找工具类，用于从指定的类或类层级结构中，根据特定规则搜索方法。
查找方式与查找范围
支持四种语义的查找：
- get: 获取首个符合条件的方法；
- getWithMetadata: 获取首个带有指定元数据的方法与该元数据；
- find: 获得所有符合条件的方法；
- findWithMetadata: 获取所有带有指定元数据的方法与这些元数据；
基于上述四种语义的查找，提供四种查找范围：
- xxxFromSpecificMethods：在用户给定的方法列表中查找匹配的方法；
- xxxFromMethods：在Class.getMethods()的范围中查找匹配的方法；
- xxxFromDeclaredMethods：在Class.getDeclaredMethods()的范围中查找匹配的方法；
- xxxFromAllMethods：在类的层级结构中的所有类的所有方法的范围中查找匹配的方法；
比如，我们希望获取Class.getMethods()中所有匹配条件的方法，则应当调用findFromMethods(java.lang.Class<?>, org.dromara.hutool.core.reflect.method.MethodMetadataLookup<?>)，若我们希望获得类所有方法范围中首个匹配的方法，则应当调用getFromAllMethods(java.lang.Class<?>, org.dromara.hutool.core.reflect.method.MethodMetadataLookup<?>)。
匹配规则
方法查找的规则由MethodMetadataLookup实现。
规定，当MethodMetadataLookup.inspect(Method)方法返回元数据不为null时，则认为方法与其匹配，返回结果时将同时返回匹配的方法与元数据。
因此，我们可以通过实现MethodMetadataLookup接口来同时实现方法的查找与元数据的获取：
比如，我们希望查找所有方法上带有Annotation注解的方法，则可以实现如下：
```
 		Map<Method, Annotation> methods = MethodScanner.findFromAllMethods(Foo.class, method -> method.getAnnotation(Annotation.class));
 
```
此外，对于一些无需获取元数据的查找，我们可以使用MethodMatcherUtil提供的一些内置实现：
```
 		// 查找所有静态公开方法
 		Set<Method> methods = MethodScanner.findFromAllMethods(Foo.class, MethodMatcherUtils.isPublicStatic());
 		// 按照方法名与参数类型查找方法
 		Method method = MethodScanner.getFromAllMethods(Foo.class, MethodMatcherUtils.forNameAndParameterTypes("foo", String.class));
 
```
缓存
对于getDeclaredMethods(java.lang.Class<?>)与getMethods(java.lang.Class<?>)方法与基于这两个方法实现的，所有xxxFromMethods与xxxFromDeclaredMethods方法，都提供了缓存基于WeakConcurrentMap的缓存支持。
getAllMethods(java.lang.Class<?>)与所有xxxFromAllMethods方法都基于getDeclaredMethods(java.lang.Class<?>)实现，但是每次全量查找，都需要重新遍历类层级结构，因此会带来一定的额外的性能损耗。
缓存在GC时会被回收，但是也可以通过clearCaches()手动清除缓存。
作者:

huangchengxing

从以下版本开始:

6.0.0

另请参阅:

MethodMetadataLookup, MethodMatcher, MethodMatcherUtil

构造器概要

构造器
构造器和说明

MethodScanner()

构造器
构造器和说明
`MethodScanner()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`clearCaches()` 清空缓存
`static Set<Method>`	`findFromAllMethods(Class<?> type, MethodMetadataLookup<?> lookup)` 获取方法上带有指定元数据的方法
`static Set<Method>`	`findFromDeclaredMethods(Class<?> type, MethodMetadataLookup<?> lookup)` 获取方法上带有指定元数据的方法
`static Set<Method>`	`findFromMethods(Class<?> type, MethodMetadataLookup<?> lookup)` 获取方法上带有指定元数据的方法
`static Set<Method>`	`findFromSpecificMethods(Method[] methods, MethodMetadataLookup<?> lookup)` 从指定方法列表中筛选所有方法上带有指定元数据方法的方法
`static <T> Map<Method,T>`	`findWithMetadataFromAllMethods(Class<?> type, MethodMetadataLookup<T> lookup)` 获取方法上带有指定元数据的方法与对应元数据
`static <T> Map<Method,T>`	`findWithMetadataFromDeclaredMethods(Class<?> type, MethodMetadataLookup<T> lookup)` 获取方法上带有指定元数据的方法与对应元数据
`static <T> Map<Method,T>`	`findWithMetadataFromMethods(Class<?> type, MethodMetadataLookup<T> lookup)` 获取方法上带有指定元数据的方法与对应元数据
`static <T> Map<Method,T>`	`findWithMetadataFromSpecificMethods(Method[] methods, MethodMetadataLookup<T> lookup)` 从指定方法列表中筛选所有方法上带有指定元数据方法的方法与对应元数据
`static Method[]`	`getAllMethods(Class<?> type)` 获取当前类层级结构中的所有方法。
`static Method[]`	`getDeclaredMethods(Class<?> type)` 获取当前类直接声明的所有方法，等同于`Class.getDeclaredMethods()`
`static Method`	`getFromAllMethods(Class<?> type, MethodMetadataLookup<?> lookup)` 获取首个方法上带有指定元数据的方法及元数据
`static Method`	`getFromDeclaredMethods(Class<?> type, MethodMetadataLookup<?> lookup)` 获取首个方法上带有指定元数据的方法及元数据
`static Method`	`getFromMethods(Class<?> type, MethodMetadataLookup<?> lookup)` 获取首个方法上带有指定元数据的方法及元数据
`static Method`	`getFromSpecificMethods(Method[] methods, MethodMetadataLookup<?> lookup)` 从指定方法列表中筛选所有方法上带有指定元数据方法的方法
`static Method[]`	`getMethods(Class<?> type)` 获取当前类及父类的所有公共方法，等同于`Class.getMethods()`
`static <T> Map.Entry<Method,T>`	`getWithMetadataFromAllMethods(Class<?> type, MethodMetadataLookup<T> lookup)` 获取首个方法上带有指定元数据的方法及元数据
`static <T> Map.Entry<Method,T>`	`getWithMetadataFromDeclaredMethods(Class<?> type, MethodMetadataLookup<T> lookup)` 获取首个方法上带有指定元数据的方法及元数据
`static <T> Map.Entry<Method,T>`	`getWithMetadataFromMethods(Class<?> type, MethodMetadataLookup<T> lookup)` 获取首个方法上带有指定元数据的方法及元数据
`static <T> Map.Entry<Method,T>`	`getWithMetadataFromSpecificMethods(Method[] methods, MethodMetadataLookup<T> lookup)` 从指定方法列表中筛选所有方法上带有指定元数据方法的方法与对应元数据

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - MethodScanner
```
public MethodScanner()
```
- 方法详细资料
  - getMethods
```
public static Method[] getMethods(Class<?> type)
```
    获取当前类及父类的所有公共方法，等同于Class.getMethods()
    
    参数:
    
    type - 类
    
    返回:
    
    当前类及父类的所有公共方法
  - getDeclaredMethods
```
public static Method[] getDeclaredMethods(Class<?> type)
```
    获取当前类直接声明的所有方法，等同于Class.getDeclaredMethods()
    
    参数:
    
    type - 类
    
    返回:
    
    当前类及父类的所有公共方法
  - getAllMethods
```
public static Method[] getAllMethods(Class<?> type)
```
    获取当前类层级结构中的所有方法。
    等同于按广度优先遍历类及其所有父类与接口，并依次调用Class.getDeclaredMethods()。
    返回的方法排序规则如下：
    - 离type距离越近，则顺序越靠前；
    - 与type距离相同，则父类优先于接口；
    - 与type距离相同的接口，则顺序遵循接口在Class.getInterfaces()的顺序；
    参数:
    
    type - 类
    
    返回:
    
    当前类及父类的所有公共方法
    
    另请参阅:
    
    ClassUtil.traverseTypeHierarchyWhile(Class, Predicate)
  - clearCaches
```
public static void clearCaches()
```
    清空缓存
  - findWithMetadataFromSpecificMethods
```
public static <T> Map<Method,T> findWithMetadataFromSpecificMethods(Method[] methods,
                                                                    MethodMetadataLookup<T> lookup)
```
    从指定方法列表中筛选所有方法上带有指定元数据方法的方法与对应元数据
    
    类型参数:
    
    T - 结果类型
    
    参数:
    
    methods - 方法列表
    
    lookup - 查找器
    
    返回:
    
    方法与对应的元数据集合
  - findFromSpecificMethods
```
public static Set<Method> findFromSpecificMethods(Method[] methods,
                                                  MethodMetadataLookup<?> lookup)
```
    从指定方法列表中筛选所有方法上带有指定元数据方法的方法
    
    参数:
    
    methods - 方法列表
    
    lookup - 查找器
    
    返回:
    
    方法集合
  - getWithMetadataFromSpecificMethods
```
public static <T> Map.Entry<Method,T> getWithMetadataFromSpecificMethods(Method[] methods,
                                                                         MethodMetadataLookup<T> lookup)
```
    从指定方法列表中筛选所有方法上带有指定元数据方法的方法与对应元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    methods - 方法列表
    
    lookup - 查找器
    
    返回:
    
    方法与对应的元数据
  - getFromSpecificMethods
```
public static Method getFromSpecificMethods(Method[] methods,
                                            MethodMetadataLookup<?> lookup)
```
    从指定方法列表中筛选所有方法上带有指定元数据方法的方法
    
    参数:
    
    methods - 方法列表
    
    lookup - 查找器
    
    返回:
    
    方法
  - findWithMetadataFromMethods
```
public static <T> Map<Method,T> findWithMetadataFromMethods(Class<?> type,
                                                            MethodMetadataLookup<T> lookup)
```
    获取方法上带有指定元数据的方法与对应元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法与对应的元数据集合
  - findFromMethods
```
public static Set<Method> findFromMethods(Class<?> type,
                                          MethodMetadataLookup<?> lookup)
```
    获取方法上带有指定元数据的方法
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法集合
  - getWithMetadataFromMethods
```
public static <T> Map.Entry<Method,T> getWithMetadataFromMethods(Class<?> type,
                                                                 MethodMetadataLookup<T> lookup)
```
    获取首个方法上带有指定元数据的方法及元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法及元数据，若无任何匹配的结果则返回null
  - getFromMethods
```
public static Method getFromMethods(Class<?> type,
                                    MethodMetadataLookup<?> lookup)
```
    获取首个方法上带有指定元数据的方法及元数据
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法，若无任何匹配的结果则返回null
  - findWithMetadataFromDeclaredMethods
```
public static <T> Map<Method,T> findWithMetadataFromDeclaredMethods(Class<?> type,
                                                                    MethodMetadataLookup<T> lookup)
```
    获取方法上带有指定元数据的方法与对应元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法与对应的元数据集合
  - findFromDeclaredMethods
```
public static Set<Method> findFromDeclaredMethods(Class<?> type,
                                                  MethodMetadataLookup<?> lookup)
```
    获取方法上带有指定元数据的方法
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法集合
  - getWithMetadataFromDeclaredMethods
```
public static <T> Map.Entry<Method,T> getWithMetadataFromDeclaredMethods(Class<?> type,
                                                                         MethodMetadataLookup<T> lookup)
```
    获取首个方法上带有指定元数据的方法及元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法及元数据，若无任何匹配的结果则返回null
  - getFromDeclaredMethods
```
public static Method getFromDeclaredMethods(Class<?> type,
                                            MethodMetadataLookup<?> lookup)
```
    获取首个方法上带有指定元数据的方法及元数据
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法，若无任何匹配的结果则返回null
  - findWithMetadataFromAllMethods
```
public static <T> Map<Method,T> findWithMetadataFromAllMethods(Class<?> type,
                                                               MethodMetadataLookup<T> lookup)
```
    获取方法上带有指定元数据的方法与对应元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法与对应的元数据集合
  - findFromAllMethods
```
public static Set<Method> findFromAllMethods(Class<?> type,
                                             MethodMetadataLookup<?> lookup)
```
    获取方法上带有指定元数据的方法
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法集合
  - getWithMetadataFromAllMethods
```
public static <T> Map.Entry<Method,T> getWithMetadataFromAllMethods(Class<?> type,
                                                                    MethodMetadataLookup<T> lookup)
```
    获取首个方法上带有指定元数据的方法及元数据
    
    类型参数:
    
    T - 值类型
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法及元数据，若无任何匹配的结果则返回null
  - getFromAllMethods
```
public static Method getFromAllMethods(Class<?> type,
                                       MethodMetadataLookup<?> lookup)
```
    获取首个方法上带有指定元数据的方法及元数据
    
    参数:
    
    type - 类型
    
    lookup - 查找器
    
    返回:
    
    方法，若无任何匹配的结果则返回null

类 MethodScanner

构造器概要

方法概要

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

构造器详细资料

MethodScanner

方法详细资料

getMethods

getDeclaredMethods

getAllMethods

clearCaches

findWithMetadataFromSpecificMethods

findFromSpecificMethods

getWithMetadataFromSpecificMethods

getFromSpecificMethods

findWithMetadataFromMethods

findFromMethods

getWithMetadataFromMethods

getFromMethods

findWithMetadataFromDeclaredMethods

findFromDeclaredMethods

getWithMetadataFromDeclaredMethods

getFromDeclaredMethods

findWithMetadataFromAllMethods

findFromAllMethods

getWithMetadataFromAllMethods

getFromAllMethods