ComponentScan (Spring Framework API)

```
@RetentionSE(valueSE=RUNTIMESE)
 @TargetSE(valueSE=TYPESE)
 @DocumentedSE
 @RepeatableSE(valueSE=ComponentScans.class)
public @interface ComponentScan
```
@Configuration クラスで使用するコンポーネントスキャンディレクティブを構成します。Spring XML の <context:component-scan> 要素と並行してサポートを提供します。
basePackageClasses() または basePackages()（またはその別名 value()）のいずれかを指定して、スキャンする特定のパッケージを定義できます。特定のパッケージが定義されていない場合、このアノテーションを宣言するクラスのパッケージからスキャンが行われます。
<context:component-scan> 要素には annotation-config 属性があることに注意してください。ただし、このアノテーションはそうではありません。これは、ほとんどすべての場合で @ComponentScan を使用する場合、デフォルトのアノテーション構成処理（たとえば、@Autowired およびフレンドの処理）が想定されるためです。さらに、AnnotationConfigApplicationContext を使用する場合、アノテーション構成プロセッサーは常に登録されます。つまり、@ComponentScan レベルで無効にしようとしても無視されます。
使用例については、@Configuration の Javadoc を参照してください。
導入:
3.1
作成者:
Chris Beams, Juergen Hoeller, Sam Brannen
関連事項:
Configuration

オプション要素のサマリー

オプション要素
修飾子と型	オプションの要素と説明
`ClassSE<?>[]`	`basePackageClasses` アノテーション付きコンポーネントをスキャンするパッケージを指定するための、`basePackages()` の型安全な代替。
`StringSE[]`	`basePackages` アノテーション付きコンポーネントをスキャンするベースパッケージ。
`ComponentScan.Filter[]`	`excludeFilters` コンポーネントのスキャンに適さない型を指定します。
`ComponentScan.Filter[]`	`includeFilters` コンポーネントのスキャンに適格な型を指定します。
`boolean`	`lazyInit` スキャンされた Bean を遅延初期化用に登録するかどうかを指定します。
`ClassSE<? extends BeanNameGenerator>`	`nameGenerator` Spring コンテナー内で検出されたコンポーネントの命名に使用される `BeanNameGenerator` クラス。
`StringSE`	`resourcePattern` コンポーネント検出に適格なクラスファイルを制御します。
`ScopedProxyMode`	`scopedProxy` 検出されたコンポーネントに対してプロキシを生成する必要があるかどうかを示します。これは、スコープをプロキシスタイルで使用する場合に必要になる可能性があります。
`ClassSE<? extends ScopeMetadataResolver>`	`scopeResolver` 検出されたコンポーネントの範囲を解決するために使用される `ScopeMetadataResolver`。
`boolean`	`useDefaultFilters` `@Component@Repository`、`@Service` または `@Controller` アノテーションが付けられたクラスの自動検出を有効にする必要があるかどうかを示します。
`StringSE[]`	`value` `basePackages()` のエイリアス。

- 要素の詳細
  - value
```
@AliasFor(value="basePackages")
public abstract StringSE[] value
```
    basePackages() のエイリアス。
    他の属性が必要ない場合は、より簡潔なアノテーション宣言を許可します。— たとえば、@ComponentScan(basePackages = "org.my.pkg") ではなく @ComponentScan("org.my.pkg") です。
    デフォルト:
    {}
- - basePackages
```
@AliasFor(value="value")
public abstract StringSE[] basePackages
```
    アノテーション付きコンポーネントをスキャンするベースパッケージ。
    value() は、この属性のエイリアスです（相互に排他的です）。
    文字列ベースのパッケージ名に代わる型安全な代替手段として basePackageClasses() を使用します。
    デフォルト:
    {}
- - basePackageClasses
```
public abstract ClassSE<?>[] basePackageClasses
```
    アノテーション付きコンポーネントをスキャンするパッケージを指定するための、basePackages() の型安全な代替。指定された各クラスのパッケージがスキャンされます。
    この属性によって参照される以外の目的を果たさない特別なノーオペレーションマーカークラスまたはインターフェースを各パッケージに作成することを検討してください。
    デフォルト:
    {}
- - nameGenerator
```
public abstract ClassSE<? extends BeanNameGenerator> nameGenerator
```
    Spring コンテナー内で検出されたコンポーネントの命名に使用される BeanNameGenerator クラス。
    BeanNameGenerator インターフェース自体のデフォルト値は、この @ComponentScan アノテーションの処理に使用されるスキャナーが、継承された Bean 名前ジェネレーターを使用する必要があることを示します。デフォルトの AnnotationBeanNameGenerator またはブートストラップ時にアプリケーションコンテキストに提供されるカスタムインスタンス。
    関連事項:
    AnnotationConfigApplicationContext.setBeanNameGenerator(BeanNameGenerator), AnnotationBeanNameGenerator, FullyQualifiedAnnotationBeanNameGenerator
    デフォルト:
    org.springframework.beans.factory.support.BeanNameGenerator.class
- - scopeResolver
```
public abstract ClassSE<? extends ScopeMetadataResolver> scopeResolver
```
    検出されたコンポーネントの範囲を解決するために使用される ScopeMetadataResolver。
    デフォルト:
    org.springframework.context.annotation.AnnotationScopeMetadataResolver.class
- - scopedProxy
```
public abstract ScopedProxyMode scopedProxy
```
    検出されたコンポーネントに対してプロキシを生成する必要があるかどうかを示します。これは、スコープをプロキシスタイルで使用する場合に必要になる可能性があります。
    デフォルトは、実際のスキャンの実行に使用されるコンポーネントスキャナーのデフォルトの動作に従います。
    この属性を設定すると、scopeResolver() に設定された値がオーバーライドされることに注意してください。
    関連事項:
    ClassPathBeanDefinitionScanner.setScopedProxyMode(ScopedProxyMode)
    デフォルト:
    org.springframework.context.annotation.ScopedProxyMode.DEFAULT
- - resourcePattern
```
public abstract StringSE resourcePattern
```
    コンポーネント検出に適格なクラスファイルを制御します。
    より柔軟なアプローチのために、includeFilters() および excludeFilters() の使用を検討してください。
    デフォルト:
    "**/*.class"
- - useDefaultFilters
```
public abstract boolean useDefaultFilters
```
    @Component@Repository、@Service または @Controller アノテーションが付けられたクラスの自動検出を有効にする必要があるかどうかを示します。
    デフォルト:
    true
- - includeFilters
```
public abstract ComponentScan.Filter[] includeFilters
```
    コンポーネントのスキャンに適格な型を指定します。
    basePackages() のすべてから、指定されたフィルターに一致する基本パッケージのすべてに、候補コンポーネントのセットをさらに絞り込みます。
    これらのフィルターは、指定されている場合、デフォルトのフィルターに加えて適用されることに注意してください。デフォルトのフィルターに一致しない場合（つまり、@Component でアノテーションが付けられていない場合）でも、指定されたフィルターに一致する指定された基本パッケージのすべての型が含まれます。
    関連事項:
    resourcePattern(), useDefaultFilters()
    デフォルト:
    {}
- - excludeFilters
```
public abstract ComponentScan.Filter[] excludeFilters
```
    コンポーネントのスキャンに適さない型を指定します。
    関連事項:
    resourcePattern()
    デフォルト:
    {}
- - lazyInit
```
public abstract boolean lazyInit
```
    スキャンされた Bean を遅延初期化用に登録するかどうかを指定します。
    デフォルトは false です。必要に応じて、これを true に切り替えます。
    導入:
    4.1
    デフォルト:
    false

アノテーション型 ComponentScan

オプション要素のサマリー

要素の詳細

value

basePackages

basePackageClasses

nameGenerator

scopeResolver

scopedProxy

resourcePattern

useDefaultFilters

includeFilters

excludeFilters

lazyInit