AnnotationUtil (hutool 5.8.32 API)

java.lang.Object
- cn.hutool.core.annotation.AnnotationUtil

```
public class AnnotationUtil
extends Object
```
注解工具类
快速获取注解对象、注解值等工具封装

Since:

4.0.9

Author:

looly

Constructor Summary

Constructors
Constructor and Description

AnnotationUtil()

Constructors
Constructor and Description
`AnnotationUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SynthesizedAggregateAnnotation`	`aggregatingFromAnnotation(Annotation... annotations)` 对指定注解对象进行聚合
`static SynthesizedAggregateAnnotation`	`aggregatingFromAnnotationWithMeta(Annotation... annotations)` 对指定注解对象及其元注解进行聚合
`static <T extends Annotation> List<T>`	`getAllSynthesizedAnnotations(AnnotatedElement annotatedEle, Class<T> annotationType)` 获取元素上所有指定注解若元素是类，则递归解析全部父类和全部父接口上的注解; 若元素是方法、属性或注解，则只解析其直接声明的注解; 注解合成规则如下：若`AnnotatedEle`按顺序从上到下声明了A，B，C三个注解，且三注解存在元注解如下： A -> M1 -> M2 B -> M3 -> M1 -> M2 C -> M2 此时入参`annotationType`类型为`M1`，则最终将返回基于根注解A与根注解B合成的合成注解。
`static <A extends Annotation> A`	`getAnnotation(AnnotatedElement annotationEle, Class<A> annotationType)` 获取指定注解
`static <T extends Annotation> T`	`getAnnotationAlias(AnnotatedElement annotationEle, Class<T> annotationType)` 获取别名支持后的注解
`static Annotation[]`	`getAnnotations(AnnotatedElement annotationEle, boolean isToCombination)` 获取指定注解
`static <T> T[]`	`getAnnotations(AnnotatedElement annotationEle, boolean isToCombination, Class<T> annotationType)` 获取指定注解
`static Annotation[]`	`getAnnotations(AnnotatedElement annotationEle, boolean isToCombination, Predicate<Annotation> predicate)` 获取指定注解
`static <T> T`	`getAnnotationValue(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType)` 获取指定注解默认值如果无指定的属性方法返回null
`static <T> T`	`getAnnotationValue(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType, String propertyName)` 获取指定注解属性的值如果无指定的属性方法返回null
`static <A extends Annotation,R> R`	`getAnnotationValue(AnnotatedElement annotationEle, Func1<A,R> propertyName)` 获取指定注解属性的值如果无指定的属性方法返回null
`static Map<String,Object>`	`getAnnotationValueMap(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType)` 获取指定注解中所有属性值如果无指定的属性方法返回null
`static <T> T[]`	`getCombinationAnnotations(AnnotatedElement annotationEle, Class<T> annotationType)` 获取组合注解
`static RetentionPolicy`	`getRetentionPolicy(Class<? extends Annotation> annotationType)` 获取注解类的保留时间，可选值 SOURCE（源码时），CLASS（编译时），RUNTIME（运行时），默认为 CLASS
`static <T extends Annotation> T`	`getSynthesizedAnnotation(AnnotatedElement annotatedEle, Class<T> annotationType)` 获取元素上距离指定元素最接近的合成注解若元素是类，则递归解析全部父类和全部父接口上的注解; 若元素是方法、属性或注解，则只解析其直接声明的注解; 注解合成规则如下：若`AnnotatedEle`按顺序从上到下声明了A，B，C三个注解，且三注解存在元注解如下： A -> M3 B -> M1 -> M2 -> M3 C -> M2 -> M3 此时入参`annotationType`类型为`M2`，则最终将优先返回基于根注解B合成的合成注解
`static <T extends Annotation> T`	`getSynthesizedAnnotation(Class<T> annotationType, Annotation... annotations)` 将指定注解实例与其元注解转为合成注解
`static ElementType[]`	`getTargetType(Class<? extends Annotation> annotationType)` 获取注解类可以用来修饰哪些程序元素，如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等
`static boolean`	`hasAnnotation(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType)` 检查是否包含指定注解指定注解
`static boolean`	`isDocumented(Class<? extends Annotation> annotationType)` 是否会保存到 Javadoc 文档中
`static boolean`	`isInherited(Class<? extends Annotation> annotationType)` 是否可以被继承，默认为 false
`static boolean`	`isJdkMetaAnnotation(Class<? extends Annotation> annotationType)` 是否为Jdk自带的元注解。
`static boolean`	`isNotJdkMateAnnotation(Class<? extends Annotation> annotationType)` 是否不为Jdk自带的元注解。
`static boolean`	`isSynthesizedAnnotation(Annotation annotation)` 该注解对象是否为通过代理类生成的合成注解
`static List<Annotation>`	`scanClass(Class<?> targetClass)` 扫描类以及类的`Class`层级结构中的注解，将返回除了`META_ANNOTATIONS`中指定的JDK默认元注解外, 全部类/接口的`Class.getAnnotations()`方法返回的注解对象。
`static List<Annotation>`	`scanMetaAnnotation(Class<? extends Annotation> annotationType)` 扫描注解类，以及注解类的`Class`层级结构中的注解，将返回除了`META_ANNOTATIONS`中指定的JDK默认注解外，按元注解对象与`annotationType`的距离和`Class.getAnnotations()`顺序排序的注解对象集合比如：若`annotationType`为 A，且A存在元注解B，B又存在元注解C和D，则有： \|-> C.class [@a, @b] A.class -> B.class [@a] -\| \|-> D.class [@a, @c] 扫描A，则该方法最终将返回 `[@a, @a, @b, @a, @c]`
`static List<Annotation>`	`scanMethod(Method method)` 扫描方法，以及该方法所在类的`Class`层级结构中的具有相同方法签名的方法，将返回除了`META_ANNOTATIONS`中指定的JDK默认元注解外, 全部匹配方法上`AccessibleObject.getAnnotations()`方法返回的注解对象。
`static void`	`setValue(Annotation annotation, String annotationField, Object value)` 设置新的注解的属性（字段）值
`static CombinationAnnotationElement`	`toCombination(AnnotatedElement annotationEle)` 将指定的被注解的元素转换为组合注解元素

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AnnotationUtil
```
public AnnotationUtil()
```
- Method Detail
  - isJdkMetaAnnotation
```
public static boolean isJdkMetaAnnotation(Class<? extends Annotation> annotationType)
```
    是否为Jdk自带的元注解。
    包括：
    Parameters:
    
    annotationType - 注解类型
    
    Returns:
    
    是否为Jdk自带的元注解
  - isNotJdkMateAnnotation
```
public static boolean isNotJdkMateAnnotation(Class<? extends Annotation> annotationType)
```
    是否不为Jdk自带的元注解。
    包括：
    Parameters:
    
    annotationType - 注解类型
    
    Returns:
    
    是否为Jdk自带的元注解
  - toCombination
```
public static CombinationAnnotationElement toCombination(AnnotatedElement annotationEle)
```
    将指定的被注解的元素转换为组合注解元素
    
    Parameters:
    
    annotationEle - 注解元素
    
    Returns:
    
    组合注解元素
  - getAnnotations
```
public static Annotation[] getAnnotations(AnnotatedElement annotationEle,
                                          boolean isToCombination)
```
    获取指定注解
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    isToCombination - 是否为转换为组合注解，组合注解可以递归获取注解的注解
    
    Returns:
    
    注解对象
  - getCombinationAnnotations
```
public static <T> T[] getCombinationAnnotations(AnnotatedElement annotationEle,
                                                Class<T> annotationType)
```
    获取组合注解
    
    Type Parameters:
    
    T - 注解类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 限定的
    
    Returns:
    
    注解对象数组
    
    Since:
    
    5.8.0
  - getAnnotations
```
public static <T> T[] getAnnotations(AnnotatedElement annotationEle,
                                     boolean isToCombination,
                                     Class<T> annotationType)
```
    获取指定注解
    
    Type Parameters:
    
    T - 注解类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    isToCombination - 是否为转换为组合注解，组合注解可以递归获取注解的注解
    
    annotationType - 限定的
    
    Returns:
    
    注解对象数组
    
    Since:
    
    5.8.0
  - getAnnotations
```
public static Annotation[] getAnnotations(AnnotatedElement annotationEle,
                                          boolean isToCombination,
                                          Predicate<Annotation> predicate)
```
    获取指定注解
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    isToCombination - 是否为转换为组合注解，组合注解可以递归获取注解的注解
    
    predicate - 过滤器，Predicate.test(Object)返回true保留，否则不保留
    
    Returns:
    
    注解对象，如果提供的AnnotatedElement为null，返回null
    
    Since:
    
    5.8.0
  - getAnnotation
```
public static <A extends Annotation> A getAnnotation(AnnotatedElement annotationEle,
                                                     Class<A> annotationType)
```
    获取指定注解
    
    Type Parameters:
    
    A - 注解类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    Returns:
    
    注解对象
  - hasAnnotation
```
public static boolean hasAnnotation(AnnotatedElement annotationEle,
                                    Class<? extends Annotation> annotationType)
```
    检查是否包含指定注解指定注解
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    Returns:
    
    是否包含指定注解
    
    Since:
    
    5.4.2
  - getAnnotationValue
```
public static <T> T getAnnotationValue(AnnotatedElement annotationEle,
                                       Class<? extends Annotation> annotationType)
                                throws UtilException
```
    获取指定注解默认值
    如果无指定的属性方法返回null
    
    Type Parameters:
    
    T - 注解值类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    Returns:
    
    注解对象
    
    Throws:
    
    UtilException - 调用注解中的方法时执行异常
  - getAnnotationValue
```
public static <T> T getAnnotationValue(AnnotatedElement annotationEle,
                                       Class<? extends Annotation> annotationType,
                                       String propertyName)
                                throws UtilException
```
    获取指定注解属性的值
    如果无指定的属性方法返回null
    
    Type Parameters:
    
    T - 注解值类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    propertyName - 属性名，例如注解中定义了name()方法，则此处传入name
    
    Returns:
    
    注解对象
    
    Throws:
    
    UtilException - 调用注解中的方法时执行异常
  - getAnnotationValue
```
public static <A extends Annotation,R> R getAnnotationValue(AnnotatedElement annotationEle,
                                                            Func1<A,R> propertyName)
```
    获取指定注解属性的值
    如果无指定的属性方法返回null
    
    Type Parameters:
    
    A - 注解类型
    
    R - 注解类型值
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    propertyName - 属性名，例如注解中定义了name()方法，则此处传入name
    
    Returns:
    
    注解对象
    
    Throws:
    
    UtilException - 调用注解中的方法时执行异常
    
    Since:
    
    5.8.9
  - getAnnotationValueMap
```
public static Map<String,Object> getAnnotationValueMap(AnnotatedElement annotationEle,
                                                       Class<? extends Annotation> annotationType)
                                                throws UtilException
```
    获取指定注解中所有属性值
    如果无指定的属性方法返回null
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    Returns:
    
    注解对象
    
    Throws:
    
    UtilException - 调用注解中的方法时执行异常
  - getRetentionPolicy
```
public static RetentionPolicy getRetentionPolicy(Class<? extends Annotation> annotationType)
```
    获取注解类的保留时间，可选值 SOURCE（源码时），CLASS（编译时），RUNTIME（运行时），默认为 CLASS
    
    Parameters:
    
    annotationType - 注解类
    
    Returns:
    
    保留时间枚举
  - getTargetType
```
public static ElementType[] getTargetType(Class<? extends Annotation> annotationType)
```
    获取注解类可以用来修饰哪些程序元素，如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等
    
    Parameters:
    
    annotationType - 注解类
    
    Returns:
    
    注解修饰的程序元素数组
  - isDocumented
```
public static boolean isDocumented(Class<? extends Annotation> annotationType)
```
    是否会保存到 Javadoc 文档中
    
    Parameters:
    
    annotationType - 注解类
    
    Returns:
    
    是否会保存到 Javadoc 文档中
  - isInherited
```
public static boolean isInherited(Class<? extends Annotation> annotationType)
```
    是否可以被继承，默认为 false
    
    Parameters:
    
    annotationType - 注解类
    
    Returns:
    
    是否会保存到 Javadoc 文档中
  - scanMetaAnnotation
```
public static List<Annotation> scanMetaAnnotation(Class<? extends Annotation> annotationType)
```
    扫描注解类，以及注解类的Class层级结构中的注解，将返回除了META_ANNOTATIONS中指定的JDK默认注解外，按元注解对象与annotationType的距离和Class.getAnnotations()顺序排序的注解对象集合
    比如：
    若annotationType为 A，且A存在元注解B，B又存在元注解C和D，则有：
```
                              |-> C.class [@a, @b]
     A.class -> B.class [@a] -|
                              |-> D.class [@a, @c]
 
```
    扫描A，则该方法最终将返回 [@a, @a, @b, @a, @c]
    Parameters:
    
    annotationType - 注解类
    
    Returns:
    
    注解对象集合
    
    See Also:
    
    MetaAnnotationScanner
  - scanClass
```
public static List<Annotation> scanClass(Class<?> targetClass)
```
    扫描类以及类的Class层级结构中的注解，将返回除了META_ANNOTATIONS中指定的JDK默认元注解外, 全部类/接口的Class.getAnnotations()方法返回的注解对象。
    层级结构将按广度优先递归，遵循规则如下：
    - 同一层级中，优先处理父类，然后再处理父接口；
    - 同一个接口在不同层级出现，优先选择层级距离targetClass更近的接口；
    - 同一个接口在相同层级出现，优先选择其子类/子接口被先解析的那个；
    注解根据其声明类/接口被扫描的顺序排序，若注解都在同一个Class中被声明，则还会遵循Class.getAnnotations()的顺序。
    比如：
    若targetClass为A.class，且A.class存在父类B.class、父接口C.class，三个类的注解声明情况如下：
```
                   |-> B.class [@a, @b]
     A.class [@a] -|
                   |-> C.class [@a, @c]
 
```
    则该方法最终将返回 [@a, @a, @b, @a, @c]
    Parameters:
    
    targetClass - 类
    
    Returns:
    
    注解对象集合
    
    See Also:
    
    TypeAnnotationScanner
  - scanMethod
```
public static List<Annotation> scanMethod(Method method)
```
    扫描方法，以及该方法所在类的Class层级结构中的具有相同方法签名的方法，将返回除了META_ANNOTATIONS中指定的JDK默认元注解外, 全部匹配方法上AccessibleObject.getAnnotations()方法返回的注解对象。
    方法所在类的层级结构将按广度优先递归，遵循规则如下：
    - 同一层级中，优先处理父类，然后再处理父接口；
    - 同一个接口在不同层级出现，优先选择层级距离targetClass更近的接口；
    - 同一个接口在相同层级出现，优先选择其子类/子接口被先解析的那个；
    方法上的注解根据方法的声明类/接口被扫描的顺序排序，若注解都在同一个类的同一个方法中被声明，则还会遵循AccessibleObject.getAnnotations()的顺序。
    比如：
    若方法X声明于A.class，且重载/重写自父类B.class，并且父类中的方法X由重写至其实现的接口C.class，三个类的注解声明情况如下：
```
     A#X()[@a] -> B#X()[@b] -> C#X()[@c]
 
```
    则该方法最终将返回 [@a, @b, @c]
    Parameters:
    
    method - 方法
    
    Returns:
    
    注解对象集合
    
    See Also:
    
    MethodAnnotationScanner
  - setValue
```
public static void setValue(Annotation annotation,
                            String annotationField,
                            Object value)
```
    设置新的注解的属性（字段）值
    
    Parameters:
    
    annotation - 注解对象
    
    annotationField - 注解属性（字段）名称
    
    value - 要更新的属性值
    
    Since:
    
    5.5.2
  - isSynthesizedAnnotation
```
public static boolean isSynthesizedAnnotation(Annotation annotation)
```
    该注解对象是否为通过代理类生成的合成注解
    
    Parameters:
    
    annotation - 注解对象
    
    Returns:
    
    是否
    
    See Also:
    
    SynthesizedAnnotationProxy.isProxyAnnotation(Class)
  - getAnnotationAlias
```
public static <T extends Annotation> T getAnnotationAlias(AnnotatedElement annotationEle,
                                                          Class<T> annotationType)
```
    获取别名支持后的注解
    
    Type Parameters:
    
    T - 注解类型
    
    Parameters:
    
    annotationEle - 被注解的类
    
    annotationType - 注解类型Class
    
    Returns:
    
    别名支持后的注解
    
    Since:
    
    5.7.23
  - getSynthesizedAnnotation
```
public static <T extends Annotation> T getSynthesizedAnnotation(Class<T> annotationType,
                                                                Annotation... annotations)
```
    将指定注解实例与其元注解转为合成注解
    
    Type Parameters:
    
    T - 注解类型
    
    Parameters:
    
    annotationType - 注解类
    
    annotations - 注解对象
    
    Returns:
    
    合成注解
    
    See Also:
    
    SynthesizedAggregateAnnotation
  - getSynthesizedAnnotation
```
public static <T extends Annotation> T getSynthesizedAnnotation(AnnotatedElement annotatedEle,
                                                                Class<T> annotationType)
```
    获取元素上距离指定元素最接近的合成注解
    - 若元素是类，则递归解析全部父类和全部父接口上的注解;
    - 若元素是方法、属性或注解，则只解析其直接声明的注解;
    注解合成规则如下：若AnnotatedEle按顺序从上到下声明了A，B，C三个注解，且三注解存在元注解如下：
```
    A -> M3
    B -> M1 -> M2 -> M3
    C -> M2 -> M3
 
```
    此时入参annotationType类型为M2，则最终将优先返回基于根注解B合成的合成注解
    Type Parameters:
    
    T - 注解类型
    
    Parameters:
    
    annotatedEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类
    
    Returns:
    
    合成注解
    
    See Also:
    
    SynthesizedAggregateAnnotation
  - getAllSynthesizedAnnotations
```
public static <T extends Annotation> List<T> getAllSynthesizedAnnotations(AnnotatedElement annotatedEle,
                                                                          Class<T> annotationType)
```
    获取元素上所有指定注解
    - 若元素是类，则递归解析全部父类和全部父接口上的注解;
    - 若元素是方法、属性或注解，则只解析其直接声明的注解;
    注解合成规则如下：若AnnotatedEle按顺序从上到下声明了A，B，C三个注解，且三注解存在元注解如下：
```
    A -> M1 -> M2
    B -> M3 -> M1 -> M2
    C -> M2
 
```
    此时入参annotationType类型为M1，则最终将返回基于根注解A与根注解B合成的合成注解。
    Type Parameters:
    
    T - 注解类型
    
    Parameters:
    
    annotatedEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类
    
    Returns:
    
    合成注解
    
    See Also:
    
    SynthesizedAggregateAnnotation
  - aggregatingFromAnnotation
```
public static SynthesizedAggregateAnnotation aggregatingFromAnnotation(Annotation... annotations)
```
    对指定注解对象进行聚合
    
    Parameters:
    
    annotations - 注解对象
    
    Returns:
    
    聚合注解
  - aggregatingFromAnnotationWithMeta
```
public static SynthesizedAggregateAnnotation aggregatingFromAnnotationWithMeta(Annotation... annotations)
```
    对指定注解对象及其元注解进行聚合
    
    Parameters:
    
    annotations - 注解对象
    
    Returns:
    
    聚合注解

Class AnnotationUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotationUtil

Method Detail

isJdkMetaAnnotation

isNotJdkMateAnnotation

toCombination

getAnnotations

getCombinationAnnotations

getAnnotations

getAnnotations

getAnnotation

hasAnnotation

getAnnotationValue

getAnnotationValue

getAnnotationValue

getAnnotationValueMap

getRetentionPolicy

getTargetType

isDocumented

isInherited

scanMetaAnnotation

scanClass

scanMethod

setValue

isSynthesizedAnnotation

getAnnotationAlias

getSynthesizedAnnotation

getSynthesizedAnnotation

getAllSynthesizedAnnotations

aggregatingFromAnnotation

aggregatingFromAnnotationWithMeta