AnnotationUtil (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.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 void`	`clearCaches()` 清空相关缓存
`static <A extends Annotation> A`	`getAnnotation(AnnotatedElement annotationEle, Class<A> annotationType)` 获取指定注解
`static <T extends Annotation> T`	`getAnnotationAlias(AnnotatedElement annotationEle, Class<T> annotationType)` 获取别名支持后的注解
`static Method[]`	`getAnnotationAttributes(Class<? extends Annotation> 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, SerFunction<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 Annotation[]`	`getDeclaredAnnotations(AnnotatedElement element)` 获取直接声明的注解，若已有缓存则从缓存中获取
`static RetentionPolicy`	`getRetentionPolicy(Class<? extends Annotation> annotationType)` 获取注解类的保留时间，可选值 SOURCE（源码时），CLASS（编译时），RUNTIME（运行时），默认为 CLASS
`static ElementType[]`	`getTargetType(Class<? extends Annotation> annotationType)` 获取注解类可以用来修饰哪些程序元素，如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等
`static boolean`	`hasAnnotation(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType)` 检查是否包含指定注解
`static boolean`	`isAnnotationAttribute(Method attribute)` 该方法是否是注解属性，需要满足下述条件：不是`Object.equals(Object)`；不是`Object.hashCode()`；不是`Object.toString()`；不是桥接方法；不是合成方法；不是静态方法；是公共方法；方法必须没有参数；方法必须有返回值（返回值类型不为`Void`）；
`static boolean`	`isDocumented(Class<? extends Annotation> annotationType)` 是否会保存到 Javadoc 文档中
`static boolean`	`isInherited(Class<? extends Annotation> annotationType)` 是否可以被继承，默认为 false
`static void`	`setValue(Annotation annotation, String annotationField, Object value)` 设置新的注解的属性（字段）值注意此方法在jdk9+中抛出异常，须添加`--add-opens=java.base/java.lang=ALL-UNNAMED`启动参数
`static CombinationAnnotatedElement`	`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
  - getDeclaredAnnotations
```
public static Annotation[] getDeclaredAnnotations(AnnotatedElement element)
```
    获取直接声明的注解，若已有缓存则从缓存中获取
    
    Parameters:
    
    element - AnnotatedElement
    
    Returns:
    
    注解
    
    Since:
    
    6.0.0
  - toCombination
```
public static CombinationAnnotatedElement 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:
    
    注解对象
    
    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 HutoolException
```
    获取指定注解默认值
    如果无指定的属性方法返回null
    
    Type Parameters:
    
    T - 注解值类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    Returns:
    
    注解对象
    
    Throws:
    
    HutoolException - 调用注解中的方法时执行异常
  - getAnnotationValue
```
public static <A extends Annotation,R> R getAnnotationValue(AnnotatedElement annotationEle,
                                                            SerFunction<A,R> propertyName)
```
    获取指定注解属性的值
    如果无指定的属性方法返回null
    
    Type Parameters:
    
    A - 注解类型
    
    R - 注解类型值
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    propertyName - 属性名，例如注解中定义了name()方法，则此处传入name
    
    Returns:
    
    注解对象
    
    Throws:
    
    HutoolException - 调用注解中的方法时执行异常
  - getAnnotationValue
```
public static <T> T getAnnotationValue(AnnotatedElement annotationEle,
                                       Class<? extends Annotation> annotationType,
                                       String propertyName)
                                throws HutoolException
```
    获取指定注解属性的值
    如果无指定的属性方法返回null
    
    Type Parameters:
    
    T - 注解值类型
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    propertyName - 属性名，例如注解中定义了name()方法，则此处传入name
    
    Returns:
    
    注解对象
    
    Throws:
    
    HutoolException - 调用注解中的方法时执行异常
  - getAnnotationValueMap
```
public static Map<String,Object> getAnnotationValueMap(AnnotatedElement annotationEle,
                                                       Class<? extends Annotation> annotationType)
                                                throws HutoolException
```
    获取指定注解中所有属性值
    如果无指定的属性方法返回null
    
    Parameters:
    
    annotationEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission
    
    annotationType - 注解类型
    
    Returns:
    
    注解对象
    
    Throws:
    
    HutoolException - 调用注解中的方法时执行异常
  - 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 文档中
  - setValue
```
public static void setValue(Annotation annotation,
                            String annotationField,
                            Object value)
```
    设置新的注解的属性（字段）值
    注意此方法在jdk9+中抛出异常，须添加`--add-opens=java.base/java.lang=ALL-UNNAMED`启动参数
    
    Parameters:
    
    annotation - 注解对象
    
    annotationField - 注解属性（字段）名称
    
    value - 要更新的属性值
    
    Since:
    
    5.5.2
  - 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
  - getAnnotationAttributes
```
public static Method[] getAnnotationAttributes(Class<? extends Annotation> annotationType)
```
    获取注解属性，若已有缓存则从缓存中获取
    
    Parameters:
    
    annotationType - 注解类型
    
    Returns:
    
    注解属性
    
    Since:
    
    6.0.0
  - isAnnotationAttribute
```
public static boolean isAnnotationAttribute(Method attribute)
```
    该方法是否是注解属性，需要满足下述条件：
    - 不是Object.equals(Object)；
    - 不是Object.hashCode()；
    - 不是Object.toString()；
    - 不是桥接方法；
    - 不是合成方法；
    - 不是静态方法；
    - 是公共方法；
    - 方法必须没有参数；
    - 方法必须有返回值（返回值类型不为Void）；
    Parameters:
    
    attribute - 方法对象
    
    Returns:
    
    是否
    
    Since:
    
    6.0.0
  - clearCaches
```
public static void clearCaches()
```
    清空相关缓存

Class AnnotationUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotationUtil

Method Detail

getDeclaredAnnotations

toCombination

getAnnotations

getCombinationAnnotations

getAnnotations

getAnnotations

getAnnotation

hasAnnotation

getAnnotationValue

getAnnotationValue

getAnnotationValue

getAnnotationValueMap

getRetentionPolicy

getTargetType

isDocumented

isInherited

setValue

getAnnotationAlias

getAnnotationAttributes

isAnnotationAttribute

clearCaches