com.alibaba.spring.util

类 AnnotationUtils

java.lang.Object

com.alibaba.spring.util.AnnotationUtils

public abstract class AnnotationUtils
extends Object

Annotation Utilities

从以下版本开始:

2017.01.13

作者:

Mercy

另请参阅:

Annotation

字段概要

字段

限定符和类型	字段和说明
static String	ANNOTATED_ELEMENT_UTILS_CLASS_NAME The class name of AnnotatedElementUtils that is introduced since Spring Framework 4

构造器概要

构造器

构造器和说明
AnnotationUtils()

方法概要

限定符和类型	方法和说明
static <A extends Annotation> Map<ElementType,List<A>>	findAnnotations(Method method, Class<A> annotationClass) Find specified Annotation type maps from Method
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean classValuesAsString, boolean nestedAnnotationsAsMap, boolean ignoreDefaultValue, boolean tryMergedAnnotation, String... ignoreAttributeNames) Get the AnnotationAttributes, if the argument tryMergedAnnotation is true, the AnnotationAttributes will be got from merged annotation first, if failed, and then to get from normal one
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean classValuesAsString, boolean nestedAnnotationsAsMap, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the AnnotationAttributes
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, boolean tryMergedAnnotation, String... ignoreAttributeNames) Get the AnnotationAttributes, if the argument tryMergedAnnotation is true, the AnnotationAttributes will be got from merged annotation first, if failed, and then to get from normal one
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the AnnotationAttributes
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(Annotation annotation, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the AnnotationAttributes
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(Annotation annotation, org.springframework.core.env.PropertyResolver propertyResolver, boolean classValuesAsString, boolean nestedAnnotationsAsMap, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the AnnotationAttributes
static org.springframework.core.annotation.AnnotationAttributes	getAnnotationAttributes(Annotation annotation, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the AnnotationAttributes
static <T> T	getAttribute(Annotation annotation, String attributeName) Get the attribute value
static <T> T	getAttribute(Map<String,Object> attributes, String attributeName) Get the attribute value
static <T> T	getAttribute(Map<String,Object> attributes, String attributeName, boolean required) Get the attribute value the will
static <T> T	getAttribute(Map<String,Object> attributes, String attributeName, T defaultValue) Get the attribute value with default value
static Map<String,Object>	getAttributes(Annotation annotation, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the Annotation attributes
static Map<String,Object>	getAttributes(Annotation annotation, org.springframework.core.env.PropertyResolver propertyResolver, boolean classValuesAsString, boolean nestedAnnotationsAsMap, boolean ignoreDefaultValue, String... ignoreAttributeNames)
static Map<String,Object>	getAttributes(Annotation annotation, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the Annotation attributes
static Map<String,Object>	getAttributes(Map<String,Object> annotationAttributes, org.springframework.core.env.PropertyResolver propertyResolver, String... ignoreAttributeNames) Get the Annotation attributes
static <T> T	getRequiredAttribute(Map<String,Object> attributes, String attributeName) Get the required attribute value
static <A extends Annotation> boolean	isPresent(Method method, Class<A> annotationClass) Is specified Annotation present on Method's declaring class or parameters or itself.
static Annotation	tryGetMergedAnnotation(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType) Try to get the merged annotation
static Annotation	tryGetMergedAnnotation(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Try to get the merged annotation
static org.springframework.core.annotation.AnnotationAttributes	tryGetMergedAnnotationAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean classValuesAsString, boolean nestedAnnotationsAsMap, boolean ignoreDefaultValue, String... ignoreAttributeNames) Try to get the annotation attributes after merging and resolving the placeholders
static org.springframework.core.annotation.AnnotationAttributes	tryGetMergedAnnotationAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, String... ignoreAttributeNames) Try to get the annotation attributes after merging and resolving the placeholders

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

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

字段详细资料

ANNOTATED_ELEMENT_UTILS_CLASS_NAME

public static final String ANNOTATED_ELEMENT_UTILS_CLASS_NAME

The class name of AnnotatedElementUtils that is introduced since Spring Framework 4

另请参阅:

常量字段值

构造器详细资料

AnnotationUtils

public AnnotationUtils()

方法详细资料

isPresent

public static <A extends Annotation> boolean isPresent(Method method,
                                                       Class<A> annotationClass)

Is specified Annotation present on Method's declaring class or parameters or itself.

类型参数:

A - Annotation type

参数:

method - Method

annotationClass - Annotation type

返回:

If present , return true , or false

findAnnotations

public static <A extends Annotation> Map<ElementType,List<A>> findAnnotations(Method method,
                                                                              Class<A> annotationClass)

Find specified Annotation type maps from Method

类型参数:

A - Annotation type

参数:

method - Method

annotationClass - Annotation type

返回:

Annotation type maps , the ElementType as key , the list of Annotation as value. If Annotation was annotated on Method's parametersElementType.PARAMETER , the associated Annotation list may contain multiple elements.

getAttributes

public static Map<String,Object> getAttributes(Annotation annotation,
                                               boolean ignoreDefaultValue,
                                               String... ignoreAttributeNames)

Get the Annotation attributes

参数:

annotation - specified Annotation

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

non-null

从以下版本开始:

1.0.2

getAttributes

public static Map<String,Object> getAttributes(Annotation annotation,
                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                               boolean ignoreDefaultValue,
                                               String... ignoreAttributeNames)

Get the Annotation attributes

参数:

annotation - specified Annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

non-null

从以下版本开始:

1.0.2

getAttributes

public static Map<String,Object> getAttributes(Map<String,Object> annotationAttributes,
                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                               String... ignoreAttributeNames)

Get the Annotation attributes

参数:

annotationAttributes - the attributes of specified Annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

non-null

从以下版本开始:

1.0.4

getAttributes

public static Map<String,Object> getAttributes(Annotation annotation,
                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                               boolean classValuesAsString,
                                               boolean nestedAnnotationsAsMap,
                                               boolean ignoreDefaultValue,
                                               String... ignoreAttributeNames)

参数:

annotation - specified Annotation

propertyResolver - PropertyResolver instance, e.g Environment

classValuesAsString - whether to turn Class references into Strings (for compatibility with AnnotationMetadata or to preserve them as Class references

nestedAnnotationsAsMap - whether to turn nested Annotation instances into AnnotationAttributes maps (for compatibility with AnnotationMetadata or to preserve them as Annotation instances

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

从以下版本开始:

1.0.11

getAttribute

public static <T> T getAttribute(Annotation annotation,
                                 String attributeName)

Get the attribute value

类型参数:

T - the type of attribute value

参数:

annotation - annotation

attributeName - the name of attribute

返回:

the attribute value if found

从以下版本开始:

1.0.3

getAttribute

public static <T> T getAttribute(Map<String,Object> attributes,
                                 String attributeName)

Get the attribute value

类型参数:

T - the type of attribute value

参数:

attributes - the annotation attributes or AnnotationAttributes

attributeName - the name of attribute

返回:

the attribute value if found

从以下版本开始:

1.0.3

getAttribute

public static <T> T getAttribute(Map<String,Object> attributes,
                                 String attributeName,
                                 boolean required)

Get the attribute value the will

类型参数:

T - the type of attribute value

参数:

attributes - the annotation attributes or AnnotationAttributes

attributeName - the name of attribute

required - the required attribute or not

返回:

the attribute value if found

抛出:

IllegalStateException - if attribute value can't be found

从以下版本开始:

1.0.6

getAttribute

public static <T> T getAttribute(Map<String,Object> attributes,
                                 String attributeName,
                                 T defaultValue)

Get the attribute value with default value

类型参数:

T - the type of attribute value

参数:

attributes - the annotation attributes or AnnotationAttributes

attributeName - the name of attribute

defaultValue - the default value of attribute

返回:

the attribute value if found

从以下版本开始:

1.0.6

getRequiredAttribute

public static <T> T getRequiredAttribute(Map<String,Object> attributes,
                                         String attributeName)

Get the required attribute value

类型参数:

T - the type of attribute value

参数:

attributes - the annotation attributes or AnnotationAttributes

attributeName - the name of attribute

返回:

the attribute value if found

抛出:

IllegalStateException - if attribute value can't be found

从以下版本开始:

1.0.6

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(Annotation annotation,
                                                                                               boolean ignoreDefaultValue,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes

参数:

annotation - specified Annotation

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

non-null

从以下版本开始:

1.0.3

另请参阅:

getAnnotationAttributes(Annotation, PropertyResolver, boolean, String...)

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(Annotation annotation,
                                                                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                               boolean classValuesAsString,
                                                                                               boolean nestedAnnotationsAsMap,
                                                                                               boolean ignoreDefaultValue,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes

参数:

annotation - specified Annotation

propertyResolver - PropertyResolver instance, e.g Environment

classValuesAsString - whether to turn Class references into Strings (for compatibility with AnnotationMetadata or to preserve them as Class references

nestedAnnotationsAsMap - whether to turn nested Annotation instances into AnnotationAttributes maps (for compatibility with AnnotationMetadata or to preserve them as Annotation instances

ignoreAttributeNames - the attribute names of annotation should be ignored

ignoreDefaultValue - whether ignore default value or not

返回:

non-null

从以下版本开始:

1.0.11

另请参阅:

getAttributes(Annotation, PropertyResolver, boolean, String...), getAnnotationAttributes(AnnotatedElement, Class, PropertyResolver, boolean, String...)

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(Annotation annotation,
                                                                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                               boolean ignoreDefaultValue,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes

参数:

annotation - specified Annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

non-null

从以下版本开始:

1.0.3

另请参阅:

getAttributes(Annotation, PropertyResolver, boolean, String...), getAnnotationAttributes(AnnotatedElement, Class, PropertyResolver, boolean, String...)

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(AnnotatedElement annotatedElement,
                                                                                               Class<? extends Annotation> annotationType,
                                                                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                               boolean ignoreDefaultValue,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

if annotatedElement can't be found in annotatedElement, return null

从以下版本开始:

1.0.3

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(AnnotatedElement annotatedElement,
                                                                                               Class<? extends Annotation> annotationType,
                                                                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                               boolean classValuesAsString,
                                                                                               boolean nestedAnnotationsAsMap,
                                                                                               boolean ignoreDefaultValue,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

if annotatedElement can't be found in annotatedElement, return null

从以下版本开始:

1.0.11

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(AnnotatedElement annotatedElement,
                                                                                               Class<? extends Annotation> annotationType,
                                                                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                               boolean ignoreDefaultValue,
                                                                                               boolean tryMergedAnnotation,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes, if the argument tryMergedAnnotation is true, the AnnotationAttributes will be got from merged annotation first, if failed, and then to get from normal one

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

tryMergedAnnotation - whether try merged annotation or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

if annotatedElement can't be found in annotatedElement, return null

从以下版本开始:

1.0.3

getAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes getAnnotationAttributes(AnnotatedElement annotatedElement,
                                                                                               Class<? extends Annotation> annotationType,
                                                                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                               boolean classValuesAsString,
                                                                                               boolean nestedAnnotationsAsMap,
                                                                                               boolean ignoreDefaultValue,
                                                                                               boolean tryMergedAnnotation,
                                                                                               String... ignoreAttributeNames)

Get the AnnotationAttributes, if the argument tryMergedAnnotation is true, the AnnotationAttributes will be got from merged annotation first, if failed, and then to get from normal one

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

classValuesAsString - whether to turn Class references into Strings (for compatibility with AnnotationMetadata or to preserve them as Class references

nestedAnnotationsAsMap - whether to turn nested Annotation instances into AnnotationAttributes maps (for compatibility with AnnotationMetadata or to preserve them as Annotation instances

ignoreDefaultValue - whether ignore default value or not

tryMergedAnnotation - whether try merged annotation or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

if annotatedElement can't be found in annotatedElement, return null

从以下版本开始:

1.0.11

tryGetMergedAnnotation

public static Annotation tryGetMergedAnnotation(AnnotatedElement annotatedElement,
                                                Class<? extends Annotation> annotationType)

Try to get the merged annotation

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

返回:

If current version of Spring Framework is below 4.2, return null

从以下版本开始:

1.0.3

tryGetMergedAnnotation

public static Annotation tryGetMergedAnnotation(AnnotatedElement annotatedElement,
                                                Class<? extends Annotation> annotationType,
                                                boolean classValuesAsString,
                                                boolean nestedAnnotationsAsMap)

Try to get the merged annotation

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

classValuesAsString - whether to turn Class references into Strings (for compatibility with AnnotationMetadata or to preserve them as Class references

nestedAnnotationsAsMap - whether to turn nested Annotation instances into AnnotationAttributes maps (for compatibility with AnnotationMetadata or to preserve them as Annotation instances

返回:

If current version of Spring Framework is below 4.2, return null

从以下版本开始:

1.0.11

tryGetMergedAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes tryGetMergedAnnotationAttributes(AnnotatedElement annotatedElement,
                                                                                                        Class<? extends Annotation> annotationType,
                                                                                                        org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                                        boolean ignoreDefaultValue,
                                                                                                        String... ignoreAttributeNames)

Try to get the annotation attributes after merging and resolving the placeholders

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

If the specified annotation type is not found, return null

从以下版本开始:

1.0.3

tryGetMergedAnnotationAttributes

public static org.springframework.core.annotation.AnnotationAttributes tryGetMergedAnnotationAttributes(AnnotatedElement annotatedElement,
                                                                                                        Class<? extends Annotation> annotationType,
                                                                                                        org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                                        boolean classValuesAsString,
                                                                                                        boolean nestedAnnotationsAsMap,
                                                                                                        boolean ignoreDefaultValue,
                                                                                                        String... ignoreAttributeNames)

Try to get the annotation attributes after merging and resolving the placeholders

参数:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

classValuesAsString - whether to turn Class references into Strings (for compatibility with AnnotationMetadata or to preserve them as Class references

nestedAnnotationsAsMap - whether to turn nested Annotation instances into AnnotationAttributes maps (for compatibility with AnnotationMetadata or to preserve them as Annotation instances

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

返回:

If the specified annotation type is not found, return null

从以下版本开始:

1.0.11