アノテーションインターフェース EntityScan
@TargetSE(TYPESE)
@RetentionSE(RUNTIMESE)
@DocumentedSE
@Import(org.springframework.boot.autoconfigure.domain.EntityScanPackages.Registrar.class)
public @interface EntityScan
エンティティクラスをスキャンするときに自動構成によって使用される基本パッケージを設定します。
@EntityScan
を使用すると、自動構成により以下が行われます。
- JPA エンティティの
packages scanned
を設定します。 - Spring Data
MongoDB
、Neo4j
、Cassandra
、Couchbase
マッピングコンテキストで使用されるinitial entity set
を設定します。
basePackageClasses()
、basePackages()
、そのエイリアス value()
のいずれかを指定して、スキャンする特定のパッケージを定義できます。特定のパッケージが定義されていない場合、このアノテーションが付いたクラスのパッケージからスキャンが行われます。
- 導入:
- 1.4.0
- 作成者:
- Phillip Webb
- 関連事項:
オプション要素のサマリー
オプション要素修飾子と型オプションの要素説明ClassSE<?>[]
エンティティをスキャンするパッケージを指定するためのbasePackages()
の型安全な代替手段。StringSE[]
エンティティをスキャンする基本パッケージ。StringSE[]
basePackages()
属性のエイリアス。
要素の詳細
value
basePackages()
属性のエイリアス。より簡潔なアノテーション宣言を許可します(例:@EntityScan(basePackages="org.my.pkg")
の代わりに@EntityScan("org.my.pkg")
)。- 戻り値:
- スキャンする基本パッケージ
- デフォルト:
- {}
basePackages
エンティティをスキャンする基本パッケージ。value()
は、この属性のエイリアスです(相互に排他的です)。文字列ベースのパッケージ名に代わる型安全な代替手段として
basePackageClasses()
を使用します。- 戻り値:
- スキャンする基本パッケージ
- デフォルト:
- {}
basePackageClasses
ClassSE<?>[] basePackageClassesエンティティをスキャンするパッケージを指定するためのbasePackages()
の型安全な代替手段。指定された各クラスのパッケージがスキャンされます。この属性によって参照される以外の目的を果たさない特別なノーオペレーションマーカークラスまたはインターフェースを各パッケージに作成することを検討してください。
- 戻り値:
- スキャンする基本パッケージのクラス
- デフォルト:
- {}