org.springframework.context.annotation.ReflectiveScan Maven / Gradle / Ivy
/*
* Copyright 2002-2024 the original author or authors.
*
* 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
*
* https://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.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.aot.hint.annotation.Reflective;
import org.springframework.aot.hint.annotation.RegisterReflection;
import org.springframework.core.annotation.AliasFor;
/**
* Scan arbitrary types for use of {@link Reflective}. Typically used on
* {@link Configuration @Configuration} classes but can be added to any bean.
* Scanning happens during AOT processing, typically at build-time.
*
* In the example below, {@code com.example.app} and its subpackages are
* scanned:
* @Configuration
* @ReflectiveScan("com.example.app")
* class MyConfiguration {
* // ...
* }
*
* Either {@link #basePackageClasses} or {@link #basePackages} (or its alias
* {@link #value}) may be specified to define specific packages to scan. If specific
* packages are not defined, scanning will occur recursively beginning with the
* package of the class that declares this annotation.
*
*
A type does not need to be annotated at class level to be candidate, and
* this performs a "deep scan" by loading every class in the target packages and
* search for {@link Reflective} on types, constructors, methods, and fields.
* Enclosed classes are candidates as well. Classes that fail to load are
* ignored.
*
* @author Stephane Nicoll
* @see Reflective @Reflective
* @see RegisterReflection @RegisterReflection
* @since 6.2
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface ReflectiveScan {
/**
* Alias for {@link #basePackages}.
*
Allows for more concise annotation declarations if no other attributes
* are needed — for example, {@code @ReflectiveScan("org.my.pkg")}
* instead of {@code @ReflectiveScan(basePackages = "org.my.pkg")}.
*/
@AliasFor("basePackages")
String[] value() default {};
/**
* Base packages to scan for reflective usage.
*
{@link #value} is an alias for (and mutually exclusive with) this
* attribute.
*
Use {@link #basePackageClasses} for a type-safe alternative to
* String-based package names.
*/
@AliasFor("value")
String[] basePackages() default {};
/**
* Type-safe alternative to {@link #basePackages} for specifying the packages
* to scan for reflection usage. The package of each class specified will be scanned.
*
Consider creating a special no-op marker class or interface in each package
* that serves no purpose other than being referenced by this attribute.
*/
Class[] basePackageClasses() default {};
}