AnnotationUtils.java 32.2 KB
Newer Older
A
Arjen Poutsma 已提交
1
/*
2
 * Copyright 2002-2014 the original author or authors.
A
Arjen Poutsma 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.core.annotation;

import java.lang.annotation.Annotation;
20
import java.lang.reflect.AnnotatedElement;
A
Arjen Poutsma 已提交
21
import java.lang.reflect.Method;
22 23 24 25
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
26
import java.util.List;
A
Arjen Poutsma 已提交
27
import java.util.Map;
28
import java.util.Set;
A
Arjen Poutsma 已提交
29

30 31 32
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

A
Arjen Poutsma 已提交
33 34
import org.springframework.core.BridgeMethodResolver;
import org.springframework.util.Assert;
35
import org.springframework.util.ConcurrentReferenceHashMap;
36
import org.springframework.util.ObjectUtils;
37
import org.springframework.util.ReflectionUtils;
A
Arjen Poutsma 已提交
38 39

/**
S
Sam Brannen 已提交
40 41 42 43
 * General utility methods for working with annotations, handling bridge methods
 * (which the compiler generates for generic declarations) as well as super methods
 * (for optional "annotation inheritance"). Note that none of this is
 * provided by the JDK's introspection facilities themselves.
A
Arjen Poutsma 已提交
44
 *
S
Sam Brannen 已提交
45 46 47 48 49 50 51 52
 * <p>As a general rule for runtime-retained annotations (e.g. for transaction
 * control, authorization, or service exposure), always use the lookup methods
 * on this class (e.g., {@link #findAnnotation(Method, Class)},
 * {@link #getAnnotation(Method, Class)}, and {@link #getAnnotations(Method)})
 * instead of the plain annotation lookup methods in the JDK. You can still
 * explicitly choose between a <em>get</em> lookup on the given class level only
 * ({@link #getAnnotation(Method, Class)}) and a <em>find</em> lookup in the entire
 * inheritance hierarchy of the given method ({@link #findAnnotation(Method, Class)}).
A
Arjen Poutsma 已提交
53 54 55 56 57
 *
 * @author Rob Harrop
 * @author Juergen Hoeller
 * @author Sam Brannen
 * @author Mark Fisher
C
Chris Beams 已提交
58
 * @author Chris Beams
59
 * @author Phillip Webb
A
Arjen Poutsma 已提交
60 61 62 63 64 65 66
 * @since 2.0
 * @see java.lang.reflect.Method#getAnnotations()
 * @see java.lang.reflect.Method#getAnnotation(Class)
 */
public abstract class AnnotationUtils {

	/** The attribute name for annotations with a single element */
67
	public static final String VALUE = "value";
A
Arjen Poutsma 已提交
68

69

70 71 72 73 74
	private static final Map<AnnotationCacheKey, Annotation> findAnnotationCache =
			new ConcurrentReferenceHashMap<AnnotationCacheKey, Annotation>(256);

	private static final Map<Class<?>, Boolean> annotatedInterfaceCache =
			new ConcurrentReferenceHashMap<Class<?>, Boolean>(256);
75

76 77
	private static transient Log logger;

J
Juergen Hoeller 已提交
78

79 80 81 82
	/**
	 * Get a single {@link Annotation} of {@code annotationType} from the supplied
	 * annotation: either the given annotation itself or a meta-annotation thereof.
	 * @param ann the Annotation to check
J
Juergen Hoeller 已提交
83 84
	 * @param annotationType the annotation type to look for, both locally and as a meta-annotation
	 * @return the matching annotation, or {@code null} if none found
85 86 87 88 89 90 91
	 * @since 4.0
	 */
	@SuppressWarnings("unchecked")
	public static <T extends Annotation> T getAnnotation(Annotation ann, Class<T> annotationType) {
		if (annotationType.isInstance(ann)) {
			return (T) ann;
		}
92 93 94 95 96
		try {
			return ann.annotationType().getAnnotation(annotationType);
		}
		catch (Exception ex) {
			// Assuming nested Class values not resolvable within annotation attributes...
97
			logIntrospectionFailure(ann.annotationType(), ex);
98 99
			return null;
		}
100 101
	}

102
	/**
C
Chris Beams 已提交
103 104 105
	 * Get a single {@link Annotation} of {@code annotationType} from the supplied
	 * Method, Constructor or Field. Meta-annotations will be searched if the annotation
	 * is not declared locally on the supplied element.
106
	 * @param annotatedElement the Method, Constructor or Field from which to get the annotation
J
Juergen Hoeller 已提交
107 108
	 * @param annotationType the annotation type to look for, both locally and as a meta-annotation
	 * @return the matching annotation, or {@code null} if none found
C
Chris Beams 已提交
109
	 * @since 3.1
110
	 */
111
	public static <T extends Annotation> T getAnnotation(AnnotatedElement annotatedElement, Class<T> annotationType) {
112
		try {
113
			T ann = annotatedElement.getAnnotation(annotationType);
114
			if (ann == null) {
115
				for (Annotation metaAnn : annotatedElement.getAnnotations()) {
116 117 118 119
					ann = metaAnn.annotationType().getAnnotation(annotationType);
					if (ann != null) {
						break;
					}
120 121
				}
			}
122 123 124 125
			return ann;
		}
		catch (Exception ex) {
			// Assuming nested Class values not resolvable within annotation attributes...
126
			logIntrospectionFailure(annotatedElement, ex);
127
			return null;
128 129 130
		}
	}

A
Arjen Poutsma 已提交
131 132 133 134 135 136 137 138
	/**
	 * Get all {@link Annotation Annotations} from the supplied {@link Method}.
	 * <p>Correctly handles bridge {@link Method Methods} generated by the compiler.
	 * @param method the method to look for annotations on
	 * @return the annotations found
	 * @see org.springframework.core.BridgeMethodResolver#findBridgedMethod(Method)
	 */
	public static Annotation[] getAnnotations(Method method) {
139 140 141 142 143
		try {
			return BridgeMethodResolver.findBridgedMethod(method).getAnnotations();
		}
		catch (Exception ex) {
			// Assuming nested Class values not resolvable within annotation attributes...
144
			logIntrospectionFailure(method, ex);
145 146
			return null;
		}
A
Arjen Poutsma 已提交
147 148 149
	}

	/**
150
	 * Get a single {@link Annotation} of {@code annotationType} from the supplied {@link Method}.
A
Arjen Poutsma 已提交
151 152
	 * <p>Correctly handles bridge {@link Method Methods} generated by the compiler.
	 * @param method the method to look for annotations on
J
Juergen Hoeller 已提交
153
	 * @param annotationType the annotation type to look for
A
Arjen Poutsma 已提交
154 155 156 157
	 * @return the annotations found
	 * @see org.springframework.core.BridgeMethodResolver#findBridgedMethod(Method)
	 */
	public static <A extends Annotation> A getAnnotation(Method method, Class<A> annotationType) {
158
		Method resolvedMethod = BridgeMethodResolver.findBridgedMethod(method);
159
		return getAnnotation((AnnotatedElement) resolvedMethod, annotationType);
A
Arjen Poutsma 已提交
160 161
	}

162 163 164 165 166 167 168
	/**
	 * Get the possibly repeating {@link Annotation}s of {@code annotationType} from the
	 * supplied {@link Method}. Deals with both a single direct annotation and repeating
	 * annotations nested within a containing annotation.
	 * <p>Correctly handles bridge {@link Method Methods} generated by the compiler.
	 * @param method the method to look for annotations on
	 * @param containerAnnotationType the class of the container that holds the annotations
J
Juergen Hoeller 已提交
169
	 * @param annotationType the annotation type to look for
170 171
	 * @return the annotations found
	 * @since 4.0
J
Juergen Hoeller 已提交
172
	 * @see org.springframework.core.BridgeMethodResolver#findBridgedMethod(Method)
173 174 175
	 */
	public static <A extends Annotation> Set<A> getRepeatableAnnotation(Method method,
			Class<? extends Annotation> containerAnnotationType, Class<A> annotationType) {
J
Juergen Hoeller 已提交
176

177
		Method resolvedMethod = BridgeMethodResolver.findBridgedMethod(method);
J
Juergen Hoeller 已提交
178
		return getRepeatableAnnotation((AnnotatedElement) resolvedMethod, containerAnnotationType, annotationType);
179 180 181 182 183 184 185 186 187
	}

	/**
	 * Get the possibly repeating {@link Annotation}s of {@code annotationType} from the
	 * supplied {@link AnnotatedElement}. Deals with both a single direct annotation and
	 * repeating annotations nested within a containing annotation.
	 * <p>Correctly handles bridge {@link Method Methods} generated by the compiler.
	 * @param annotatedElement the element to look for annotations on
	 * @param containerAnnotationType the class of the container that holds the annotations
J
Juergen Hoeller 已提交
188
	 * @param annotationType the annotation type to look for
189 190
	 * @return the annotations found
	 * @since 4.0
J
Juergen Hoeller 已提交
191
	 * @see org.springframework.core.BridgeMethodResolver#findBridgedMethod(Method)
192 193 194
	 */
	public static <A extends Annotation> Set<A> getRepeatableAnnotation(AnnotatedElement annotatedElement,
			Class<? extends Annotation> containerAnnotationType, Class<A> annotationType) {
J
Juergen Hoeller 已提交
195

196 197 198 199
		try {
			if (annotatedElement.getAnnotations().length > 0) {
				return new AnnotationCollector<A>(containerAnnotationType, annotationType).getResult(annotatedElement);
			}
200
		}
201 202
		catch (Exception ex) {
			// Assuming nested Class values not resolvable within annotation attributes...
203
			logIntrospectionFailure(annotatedElement, ex);
204 205
		}
		return Collections.emptySet();
206 207
	}

A
Arjen Poutsma 已提交
208
	/**
S
Sam Brannen 已提交
209
	 * Find a single {@link Annotation} of {@code annotationType} from the supplied
J
Juergen Hoeller 已提交
210
	 * {@link Method}, traversing its super methods (i.e., from superclasses and
S
Sam Brannen 已提交
211 212 213
	 * interfaces) if no annotation can be found on the given method itself.
	 * <p>Annotations on methods are not inherited by default, so we need to handle
	 * this explicitly.
A
Arjen Poutsma 已提交
214
	 * @param method the method to look for annotations on
J
Juergen Hoeller 已提交
215 216
	 * @param annotationType the annotation type to look for
	 * @return the annotation found, or {@code null} if none
A
Arjen Poutsma 已提交
217
	 */
218
	@SuppressWarnings("unchecked")
A
Arjen Poutsma 已提交
219
	public static <A extends Annotation> A findAnnotation(Method method, Class<A> annotationType) {
220 221 222 223 224 225 226
		AnnotationCacheKey cacheKey = new AnnotationCacheKey(method, annotationType);
		A result = (A) findAnnotationCache.get(cacheKey);
		if (result == null) {
			result = getAnnotation(method, annotationType);
			Class<?> clazz = method.getDeclaringClass();
			if (result == null) {
				result = searchOnInterfaces(method, annotationType, clazz.getInterfaces());
A
Arjen Poutsma 已提交
227
			}
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
			while (result == null) {
				clazz = clazz.getSuperclass();
				if (clazz == null || clazz.equals(Object.class)) {
					break;
				}
				try {
					Method equivalentMethod = clazz.getDeclaredMethod(method.getName(), method.getParameterTypes());
					result = getAnnotation(equivalentMethod, annotationType);
				}
				catch (NoSuchMethodException ex) {
					// No equivalent method found
				}
				if (result == null) {
					result = searchOnInterfaces(method, annotationType, clazz.getInterfaces());
				}
243
			}
244 245
			if (result != null) {
				findAnnotationCache.put(cacheKey, result);
A
Arjen Poutsma 已提交
246 247
			}
		}
248
		return result;
A
Arjen Poutsma 已提交
249 250
	}

251
	private static <A extends Annotation> A searchOnInterfaces(Method method, Class<A> annotationType, Class<?>... ifcs) {
252
		A annotation = null;
J
Juergen Hoeller 已提交
253
		for (Class<?> iface : ifcs) {
254 255 256 257 258 259 260 261 262 263 264
			if (isInterfaceWithAnnotatedMethods(iface)) {
				try {
					Method equivalentMethod = iface.getMethod(method.getName(), method.getParameterTypes());
					annotation = getAnnotation(equivalentMethod, annotationType);
				}
				catch (NoSuchMethodException ex) {
					// Skip this interface - it doesn't have the method...
				}
				if (annotation != null) {
					break;
				}
265
			}
266 267 268 269 270
		}
		return annotation;
	}

	private static boolean isInterfaceWithAnnotatedMethods(Class<?> iface) {
271 272 273 274 275 276 277 278 279 280
		Boolean flag = annotatedInterfaceCache.get(iface);
		if (flag != null) {
			return flag;
		}
		boolean found = false;
		for (Method ifcMethod : iface.getMethods()) {
			try {
				if (ifcMethod.getAnnotations().length > 0) {
					found = true;
					break;
281
				}
282 283 284
			}
			catch (Exception ex) {
				// Assuming nested Class values not resolvable within annotation attributes...
285
				logIntrospectionFailure(ifcMethod, ex);
286 287
			}
		}
288 289
		annotatedInterfaceCache.put(iface, found);
		return found;
290 291
	}

A
Arjen Poutsma 已提交
292
	/**
293 294 295 296
	 * Find a single {@link Annotation} of {@code annotationType} on the
	 * supplied {@link Class}, traversing its interfaces, annotations, and
	 * superclasses if the annotation is not <em>present</em> on the given class
	 * itself.
S
Sam Brannen 已提交
297
	 * <p>This method explicitly handles class-level annotations which are not
298 299
	 * declared as {@link java.lang.annotation.Inherited inherited} <em>as well
	 * as meta-annotations and annotations on interfaces</em>.
S
Sam Brannen 已提交
300 301
	 * <p>The algorithm operates as follows:
	 * <ol>
302 303 304 305
	 * <li>Search for the annotation on the given class and return it if found.
	 * <li>Recursively search through all interfaces that the given class declares.
	 * <li>Recursively search through all annotations that the given class declares.
	 * <li>Recursively search through the superclass hierarchy of the given class.
S
Sam Brannen 已提交
306
	 * </ol>
307 308 309
	 * <p>Note: in this context, the term <em>recursively</em> means that the search
	 * process continues by returning to step #1 with the current interface,
	 * annotation, or superclass as the class to look for annotations on.
A
Arjen Poutsma 已提交
310
	 * @param clazz the class to look for annotations on
311 312
	 * @param annotationType the type of annotation to look for
	 * @return the annotation if found, or {@code null} if not found
A
Arjen Poutsma 已提交
313
	 */
314
	@SuppressWarnings("unchecked")
A
Arjen Poutsma 已提交
315
	public static <A extends Annotation> A findAnnotation(Class<?> clazz, Class<A> annotationType) {
316 317 318 319 320 321 322 323 324
		AnnotationCacheKey cacheKey = new AnnotationCacheKey(clazz, annotationType);
		A result = (A) findAnnotationCache.get(cacheKey);
		if (result == null) {
			result = findAnnotation(clazz, annotationType, new HashSet<Annotation>());
			if (result != null) {
				findAnnotationCache.put(cacheKey, result);
			}
		}
		return result;
325 326 327 328 329
	}

	/**
	 * Perform the search algorithm for {@link #findAnnotation(Class, Class)},
	 * avoiding endless recursion by tracking which annotations have already
S
Sam Brannen 已提交
330
	 * been <em>visited</em>.
331 332
	 * @param clazz the class to look for annotations on
	 * @param annotationType the type of annotation to look for
S
Sam Brannen 已提交
333
	 * @param visited the set of annotations that have already been visited
334 335
	 * @return the annotation if found, or {@code null} if not found
	 */
336
	@SuppressWarnings("unchecked")
J
Juergen Hoeller 已提交
337
	private static <A extends Annotation> A findAnnotation(Class<?> clazz, Class<A> annotationType, Set<Annotation> visited) {
A
Arjen Poutsma 已提交
338
		Assert.notNull(clazz, "Class must not be null");
339 340 341 342 343 344 345

		try {
			Annotation[] anns = clazz.getDeclaredAnnotations();
			for (Annotation ann : anns) {
				if (ann.annotationType().equals(annotationType)) {
					return (A) ann;
				}
346
			}
347 348 349 350 351 352
			for (Annotation ann : anns) {
				if (!isInJavaLangAnnotationPackage(ann) && visited.add(ann)) {
					A annotation = findAnnotation(ann.annotationType(), annotationType, visited);
					if (annotation != null) {
						return annotation;
					}
353
				}
354
			}
A
Arjen Poutsma 已提交
355
		}
356 357
		catch (Exception ex) {
			// Assuming nested Class values not resolvable within annotation attributes...
358
			logIntrospectionFailure(clazz, ex);
359 360 361
			return null;
		}

A
Arjen Poutsma 已提交
362
		for (Class<?> ifc : clazz.getInterfaces()) {
363
			A annotation = findAnnotation(ifc, annotationType, visited);
A
Arjen Poutsma 已提交
364 365 366 367
			if (annotation != null) {
				return annotation;
			}
		}
368

369 370
		Class<?> superclass = clazz.getSuperclass();
		if (superclass == null || superclass.equals(Object.class)) {
A
Arjen Poutsma 已提交
371 372
			return null;
		}
S
Sam Brannen 已提交
373
		return findAnnotation(superclass, annotationType, visited);
A
Arjen Poutsma 已提交
374 375 376
	}

	/**
377 378 379 380 381
	 * Find the first {@link Class} in the inheritance hierarchy of the specified {@code clazz}
	 * (including the specified {@code clazz} itself) which declares an annotation for the
	 * specified {@code annotationType}, or {@code null} if not found. If the supplied
	 * {@code clazz} is {@code null}, {@code null} will be returned.
	 * <p>If the supplied {@code clazz} is an interface, only the interface itself will be checked;
J
Juergen Hoeller 已提交
382 383 384 385
	 * the inheritance hierarchy for interfaces will not be traversed.
	 * <p>The standard {@link Class} API does not provide a mechanism for determining which class
	 * in an inheritance hierarchy actually declares an {@link Annotation}, so we need to handle
	 * this explicitly.
J
Juergen Hoeller 已提交
386 387
	 * @param annotationType the annotation type to look for, both locally and as a meta-annotation
	 * @param clazz the class on which to check for the annotation (may be {@code null})
388 389
	 * @return the first {@link Class} in the inheritance hierarchy of the specified {@code clazz}
	 * which declares an annotation for the specified {@code annotationType}, or {@code null}
J
Juergen Hoeller 已提交
390
	 * if not found
A
Arjen Poutsma 已提交
391 392
	 * @see Class#isAnnotationPresent(Class)
	 * @see Class#getDeclaredAnnotations()
393 394
	 * @see #findAnnotationDeclaringClassForTypes(List, Class)
	 * @see #isAnnotationDeclaredLocally(Class, Class)
A
Arjen Poutsma 已提交
395 396 397 398 399 400
	 */
	public static Class<?> findAnnotationDeclaringClass(Class<? extends Annotation> annotationType, Class<?> clazz) {
		Assert.notNull(annotationType, "Annotation type must not be null");
		if (clazz == null || clazz.equals(Object.class)) {
			return null;
		}
401 402 403 404
		if (isAnnotationDeclaredLocally(annotationType, clazz)) {
			return clazz;
		}
		return findAnnotationDeclaringClass(annotationType, clazz.getSuperclass());
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
	}

	/**
	 * Find the first {@link Class} in the inheritance hierarchy of the specified
	 * {@code clazz} (including the specified {@code clazz} itself) which declares
	 * at least one of the specified {@code annotationTypes}, or {@code null} if
	 * none of the specified annotation types could be found.
	 * <p>If the supplied {@code clazz} is {@code null}, {@code null} will be
	 * returned.
	 * <p>If the supplied {@code clazz} is an interface, only the interface itself
	 * will be checked; the inheritance hierarchy for interfaces will not be traversed.
	 * <p>The standard {@link Class} API does not provide a mechanism for determining
	 * which class in an inheritance hierarchy actually declares one of several
	 * candidate {@linkplain Annotation annotations}, so we need to handle this
	 * explicitly.
	 * @param annotationTypes the list of Class objects corresponding to the
	 * annotation types
	 * @param clazz the Class object corresponding to the class on which to check
	 * for the annotations, or {@code null}
	 * @return the first {@link Class} in the inheritance hierarchy of the specified
	 * {@code clazz} which declares an annotation of at least one of the specified
	 * {@code annotationTypes}, or {@code null} if not found
427
	 * @since 3.2.2
428 429 430 431 432
	 * @see Class#isAnnotationPresent(Class)
	 * @see Class#getDeclaredAnnotations()
	 * @see #findAnnotationDeclaringClass(Class, Class)
	 * @see #isAnnotationDeclaredLocally(Class, Class)
	 */
433
	public static Class<?> findAnnotationDeclaringClassForTypes(List<Class<? extends Annotation>> annotationTypes, Class<?> clazz) {
434 435 436 437 438 439 440 441 442 443
		Assert.notEmpty(annotationTypes, "The list of annotation types must not be empty");
		if (clazz == null || clazz.equals(Object.class)) {
			return null;
		}
		for (Class<? extends Annotation> annotationType : annotationTypes) {
			if (isAnnotationDeclaredLocally(annotationType, clazz)) {
				return clazz;
			}
		}
		return findAnnotationDeclaringClassForTypes(annotationTypes, clazz.getSuperclass());
A
Arjen Poutsma 已提交
444 445 446
	}

	/**
447 448
	 * Determine whether an annotation for the specified {@code annotationType} is
	 * declared locally on the supplied {@code clazz}. The supplied {@link Class}
J
Juergen Hoeller 已提交
449 450
	 * may represent any type.
	 * <p>Note: This method does <strong>not</strong> determine if the annotation is
S
Sam Brannen 已提交
451 452 453
	 * {@linkplain java.lang.annotation.Inherited inherited}. For greater clarity
	 * regarding inherited annotations, consider using
	 * {@link #isAnnotationInherited(Class, Class)} instead.
A
Arjen Poutsma 已提交
454
	 * @param annotationType the Class object corresponding to the annotation type
J
Juergen Hoeller 已提交
455
	 * @param clazz the Class object corresponding to the class on which to check for the annotation
456 457
	 * @return {@code true} if an annotation for the specified {@code annotationType}
	 * is declared locally on the supplied {@code clazz}
A
Arjen Poutsma 已提交
458 459 460 461 462 463 464
	 * @see Class#getDeclaredAnnotations()
	 * @see #isAnnotationInherited(Class, Class)
	 */
	public static boolean isAnnotationDeclaredLocally(Class<? extends Annotation> annotationType, Class<?> clazz) {
		Assert.notNull(annotationType, "Annotation type must not be null");
		Assert.notNull(clazz, "Class must not be null");
		boolean declaredLocally = false;
465
		try {
466 467
			for (Annotation ann : clazz.getDeclaredAnnotations()) {
				if (ann.annotationType().equals(annotationType)) {
468 469 470
					declaredLocally = true;
					break;
				}
A
Arjen Poutsma 已提交
471 472
			}
		}
473 474
		catch (Exception ex) {
			// Assuming nested Class values not resolvable within annotation attributes...
475
			logIntrospectionFailure(clazz, ex);
476
		}
A
Arjen Poutsma 已提交
477 478 479 480
		return declaredLocally;
	}

	/**
481
	 * Determine whether an annotation for the specified {@code annotationType} is present
S
Sam Brannen 已提交
482 483
	 * on the supplied {@code clazz} and is {@linkplain java.lang.annotation.Inherited inherited}
	 * (i.e., not declared locally for the class).
484
	 * <p>If the supplied {@code clazz} is an interface, only the interface itself will be checked.
J
Juergen Hoeller 已提交
485
	 * In accordance with standard meta-annotation semantics, the inheritance hierarchy for interfaces
S
Sam Brannen 已提交
486 487
	 * will not be traversed. See the {@linkplain java.lang.annotation.Inherited Javadoc} for the
	 * {@code @Inherited} meta-annotation for further details regarding annotation inheritance.
A
Arjen Poutsma 已提交
488
	 * @param annotationType the Class object corresponding to the annotation type
J
Juergen Hoeller 已提交
489
	 * @param clazz the Class object corresponding to the class on which to check for the annotation
490
	 * @return {@code true} if an annotation for the specified {@code annotationType} is present
S
Sam Brannen 已提交
491
	 * on the supplied {@code clazz} and is <em>inherited</em>
A
Arjen Poutsma 已提交
492 493 494 495 496 497 498 499 500
	 * @see Class#isAnnotationPresent(Class)
	 * @see #isAnnotationDeclaredLocally(Class, Class)
	 */
	public static boolean isAnnotationInherited(Class<? extends Annotation> annotationType, Class<?> clazz) {
		Assert.notNull(annotationType, "Annotation type must not be null");
		Assert.notNull(clazz, "Class must not be null");
		return (clazz.isAnnotationPresent(annotationType) && !isAnnotationDeclaredLocally(annotationType, clazz));
	}

501
	/**
J
Juergen Hoeller 已提交
502
	 * Determine if the supplied {@link Annotation} is defined in the core JDK
503
	 * {@code java.lang.annotation} package.
J
Juergen Hoeller 已提交
504
	 * @param annotation the annotation to check (never {@code null})
505 506 507 508 509 510 511
	 * @return {@code true} if the annotation is in the {@code java.lang.annotation} package
	 */
	public static boolean isInJavaLangAnnotationPackage(Annotation annotation) {
		Assert.notNull(annotation, "Annotation must not be null");
		return annotation.annotationType().getName().startsWith("java.lang.annotation");
	}

A
Arjen Poutsma 已提交
512
	/**
J
Juergen Hoeller 已提交
513 514 515 516
	 * Retrieve the given annotation's attributes as a {@link Map}, preserving all
	 * attribute types as-is.
	 * <p>Note: This method actually returns an {@link AnnotationAttributes} instance.
	 * However, the {@code Map} signature has been preserved for binary compatibility.
A
Arjen Poutsma 已提交
517
	 * @param annotation the annotation to retrieve the attributes for
J
Juergen Hoeller 已提交
518 519
	 * @return the Map of annotation attributes, with attribute names as keys and
	 * corresponding attribute values as values
A
Arjen Poutsma 已提交
520 521
	 */
	public static Map<String, Object> getAnnotationAttributes(Annotation annotation) {
522
		return getAnnotationAttributes(annotation, false, false);
523 524 525
	}

	/**
J
Juergen Hoeller 已提交
526 527
	 * Retrieve the given annotation's attributes as a {@link Map}. Equivalent to
	 * calling {@link #getAnnotationAttributes(Annotation, boolean, boolean)} with
528
	 * the {@code nestedAnnotationsAsMap} parameter set to {@code false}.
J
Juergen Hoeller 已提交
529 530
	 * <p>Note: This method actually returns an {@link AnnotationAttributes} instance.
	 * However, the {@code Map} signature has been preserved for binary compatibility.
531
	 * @param annotation the annotation to retrieve the attributes for
532
	 * @param classValuesAsString whether to turn Class references into Strings (for
J
Juergen Hoeller 已提交
533 534
	 * compatibility with {@link org.springframework.core.type.AnnotationMetadata}
	 * or to preserve them as Class references
J
Juergen Hoeller 已提交
535 536
	 * @return the Map of annotation attributes, with attribute names as keys and
	 * corresponding attribute values as values
537
	 */
538
	public static Map<String, Object> getAnnotationAttributes(Annotation annotation, boolean classValuesAsString) {
539 540 541 542 543
		return getAnnotationAttributes(annotation, classValuesAsString, false);
	}

	/**
	 * Retrieve the given annotation's attributes as an {@link AnnotationAttributes}
J
Juergen Hoeller 已提交
544 545 546
	 * map structure.
	 * <p>This method provides fully recursive annotation reading capabilities on par with
	 * the reflection-based {@link org.springframework.core.type.StandardAnnotationMetadata}.
547 548
	 * @param annotation the annotation to retrieve the attributes for
	 * @param classValuesAsString whether to turn Class references into Strings (for
J
Juergen Hoeller 已提交
549 550
	 * compatibility with {@link org.springframework.core.type.AnnotationMetadata}
	 * or to preserve them as Class references
551 552 553 554 555 556 557 558
	 * @param nestedAnnotationsAsMap whether to turn nested Annotation instances into
	 * {@link AnnotationAttributes} maps (for compatibility with
	 * {@link org.springframework.core.type.AnnotationMetadata} or to preserve them as
	 * Annotation instances
	 * @return the annotation attributes (a specialized Map) with attribute names as keys
	 * and corresponding attribute values as values
	 * @since 3.1.1
	 */
559 560
	public static AnnotationAttributes getAnnotationAttributes(Annotation annotation, boolean classValuesAsString,
			boolean nestedAnnotationsAsMap) {
561 562

		AnnotationAttributes attrs = new AnnotationAttributes();
A
Arjen Poutsma 已提交
563
		Method[] methods = annotation.annotationType().getDeclaredMethods();
564
		for (Method method : methods) {
A
Arjen Poutsma 已提交
565 566
			if (method.getParameterTypes().length == 0 && method.getReturnType() != void.class) {
				try {
567
					Object value = method.invoke(annotation);
568
					attrs.put(method.getName(), adaptValue(value, classValuesAsString, nestedAnnotationsAsMap));
A
Arjen Poutsma 已提交
569 570 571 572 573 574 575 576 577
				}
				catch (Exception ex) {
					throw new IllegalStateException("Could not obtain annotation attribute values", ex);
				}
			}
		}
		return attrs;
	}

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
	/**
	 * Adapt the given value according to the given class and nested annotation settings.
	 * @param value the annotation attribute value
	 * @param classValuesAsString whether to turn Class references into Strings (for
	 * compatibility with {@link org.springframework.core.type.AnnotationMetadata}
	 * or to preserve them as Class references
	 * @param nestedAnnotationsAsMap whether to turn nested Annotation instances into
	 * {@link AnnotationAttributes} maps (for compatibility with
	 * {@link org.springframework.core.type.AnnotationMetadata} or to preserve them as
	 * Annotation instances
	 * @return the adapted value, or the original value if no adaptation is needed
	 */
	static Object adaptValue(Object value, boolean classValuesAsString, boolean nestedAnnotationsAsMap) {
		if (classValuesAsString) {
			if (value instanceof Class) {
				value = ((Class<?>) value).getName();
			}
			else if (value instanceof Class[]) {
				Class<?>[] clazzArray = (Class[]) value;
				String[] newValue = new String[clazzArray.length];
				for (int i = 0; i < clazzArray.length; i++) {
					newValue[i] = clazzArray[i].getName();
				}
				value = newValue;
			}
		}
		if (nestedAnnotationsAsMap && value instanceof Annotation) {
			return getAnnotationAttributes((Annotation) value, classValuesAsString, true);
		}
		else if (nestedAnnotationsAsMap && value instanceof Annotation[]) {
			Annotation[] realAnnotations = (Annotation[]) value;
			AnnotationAttributes[] mappedAnnotations = new AnnotationAttributes[realAnnotations.length];
			for (int i = 0; i < realAnnotations.length; i++) {
				mappedAnnotations[i] = getAnnotationAttributes(realAnnotations[i], classValuesAsString, true);
			}
			return mappedAnnotations;
		}
		else {
			return value;
		}
	}

A
Arjen Poutsma 已提交
620
	/**
621
	 * Retrieve the <em>value</em> of the {@code &quot;value&quot;} attribute of a
J
Juergen Hoeller 已提交
622
	 * single-element Annotation, given an annotation instance.
A
Arjen Poutsma 已提交
623
	 * @param annotation the annotation instance from which to retrieve the value
624
	 * @return the attribute value, or {@code null} if not found
A
Arjen Poutsma 已提交
625 626 627 628 629 630 631
	 * @see #getValue(Annotation, String)
	 */
	public static Object getValue(Annotation annotation) {
		return getValue(annotation, VALUE);
	}

	/**
J
Juergen Hoeller 已提交
632
	 * Retrieve the <em>value</em> of a named attribute, given an annotation instance.
A
Arjen Poutsma 已提交
633 634
	 * @param annotation the annotation instance from which to retrieve the value
	 * @param attributeName the name of the attribute value to retrieve
635
	 * @return the attribute value, or {@code null} if not found
J
Juergen Hoeller 已提交
636
	 * @see #getValue(Annotation)
A
Arjen Poutsma 已提交
637 638 639
	 */
	public static Object getValue(Annotation annotation, String attributeName) {
		try {
J
Juergen Hoeller 已提交
640
			Method method = annotation.annotationType().getDeclaredMethod(attributeName);
641
			ReflectionUtils.makeAccessible(method);
A
Arjen Poutsma 已提交
642 643 644 645 646 647 648 649
			return method.invoke(annotation);
		}
		catch (Exception ex) {
			return null;
		}
	}

	/**
650
	 * Retrieve the <em>default value</em> of the {@code &quot;value&quot;} attribute
J
Juergen Hoeller 已提交
651 652
	 * of a single-element Annotation, given an annotation instance.
	 * @param annotation the annotation instance from which to retrieve the default value
653
	 * @return the default value, or {@code null} if not found
A
Arjen Poutsma 已提交
654 655 656 657 658 659 660
	 * @see #getDefaultValue(Annotation, String)
	 */
	public static Object getDefaultValue(Annotation annotation) {
		return getDefaultValue(annotation, VALUE);
	}

	/**
J
Juergen Hoeller 已提交
661
	 * Retrieve the <em>default value</em> of a named attribute, given an annotation instance.
J
Juergen Hoeller 已提交
662
	 * @param annotation the annotation instance from which to retrieve the default value
A
Arjen Poutsma 已提交
663
	 * @param attributeName the name of the attribute value to retrieve
664
	 * @return the default value of the named attribute, or {@code null} if not found
A
Arjen Poutsma 已提交
665 666 667 668 669 670 671
	 * @see #getDefaultValue(Class, String)
	 */
	public static Object getDefaultValue(Annotation annotation, String attributeName) {
		return getDefaultValue(annotation.annotationType(), attributeName);
	}

	/**
672
	 * Retrieve the <em>default value</em> of the {@code &quot;value&quot;} attribute
J
Juergen Hoeller 已提交
673 674
	 * of a single-element Annotation, given the {@link Class annotation type}.
	 * @param annotationType the <em>annotation type</em> for which the default value should be retrieved
675
	 * @return the default value, or {@code null} if not found
A
Arjen Poutsma 已提交
676 677 678 679 680 681 682
	 * @see #getDefaultValue(Class, String)
	 */
	public static Object getDefaultValue(Class<? extends Annotation> annotationType) {
		return getDefaultValue(annotationType, VALUE);
	}

	/**
J
Juergen Hoeller 已提交
683 684
	 * Retrieve the <em>default value</em> of a named attribute, given the
	 * {@link Class annotation type}.
J
Juergen Hoeller 已提交
685
	 * @param annotationType the <em>annotation type</em> for which the default value should be retrieved
A
Arjen Poutsma 已提交
686
	 * @param attributeName the name of the attribute value to retrieve.
687
	 * @return the default value of the named attribute, or {@code null} if not found
A
Arjen Poutsma 已提交
688 689 690 691
	 * @see #getDefaultValue(Annotation, String)
	 */
	public static Object getDefaultValue(Class<? extends Annotation> annotationType, String attributeName) {
		try {
J
Juergen Hoeller 已提交
692
			return annotationType.getDeclaredMethod(attributeName).getDefaultValue();
A
Arjen Poutsma 已提交
693 694 695 696 697 698
		}
		catch (Exception ex) {
			return null;
		}
	}

699

700 701 702 703 704 705 706 707 708 709 710 711
	private static void logIntrospectionFailure(AnnotatedElement annotatedElement, Exception ex) {
		Log loggerToUse = logger;
		if (loggerToUse == null) {
			loggerToUse = LogFactory.getLog(AnnotationUtils.class);
			logger = loggerToUse;
		}
		if (loggerToUse.isInfoEnabled()) {
			loggerToUse.info("Failed to introspect annotations on [" + annotatedElement + "]: " + ex);
		}
	}


712
	/**
713
	 * Cache key for the AnnotatedElement cache.
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
	 */
	private static class AnnotationCacheKey {

		private final AnnotatedElement element;

		private final Class<? extends Annotation> annotationType;

		public AnnotationCacheKey(AnnotatedElement element, Class<? extends Annotation> annotationType) {
			this.element = element;
			this.annotationType = annotationType;
		}

		@Override
		public boolean equals(Object other) {
			if (this == other) {
				return true;
			}
			if (!(other instanceof AnnotationCacheKey)) {
				return false;
			}
			AnnotationCacheKey otherKey = (AnnotationCacheKey) other;
			return (this.element.equals(otherKey.element) &&
					ObjectUtils.nullSafeEquals(this.annotationType, otherKey.annotationType));
		}

		@Override
		public int hashCode() {
			return (this.element.hashCode() * 29 + this.annotationType.hashCode());
		}
	}


746 747 748 749 750 751 752 753 754 755
	private static class AnnotationCollector<A extends Annotation> {

		private final Class<? extends Annotation> containerAnnotationType;

		private final Class<A> annotationType;

		private final Set<AnnotatedElement> visited = new HashSet<AnnotatedElement>();

		private final Set<A> result = new LinkedHashSet<A>();

J
Juergen Hoeller 已提交
756
		public AnnotationCollector(Class<? extends Annotation> containerAnnotationType, Class<A> annotationType) {
757 758 759 760 761 762 763 764 765 766 767 768
			this.containerAnnotationType = containerAnnotationType;
			this.annotationType = annotationType;
		}

		public Set<A> getResult(AnnotatedElement element) {
			process(element);
			return Collections.unmodifiableSet(this.result);
		}

		@SuppressWarnings("unchecked")
		private void process(AnnotatedElement annotatedElement) {
			if (this.visited.add(annotatedElement)) {
769 770 771
				for (Annotation ann : annotatedElement.getAnnotations()) {
					if (ObjectUtils.nullSafeEquals(this.annotationType, ann.annotationType())) {
						this.result.add((A) ann);
772
					}
773 774
					else if (ObjectUtils.nullSafeEquals(this.containerAnnotationType, ann.annotationType())) {
						this.result.addAll(getValue(ann));
775
					}
776 777
					else if (!isInJavaLangAnnotationPackage(ann)) {
						process(ann.annotationType());
778 779 780 781 782 783
					}
				}
			}
		}

		@SuppressWarnings("unchecked")
784
		private List<A> getValue(Annotation annotation) {
785 786
			try {
				Method method = annotation.annotationType().getDeclaredMethod("value");
787
				ReflectionUtils.makeAccessible(method);
788
				return Arrays.asList((A[]) method.invoke(annotation));
789 790
			}
			catch (Exception ex) {
791 792
				// Unable to read value from repeating annotation container -> ignore it.
				return Collections.emptyList();
793 794 795
			}
		}
	}
J
Juergen Hoeller 已提交
796

A
Arjen Poutsma 已提交
797
}