クラス SpringApplicationBuilder
java.lang.ObjectSE
org.springframework.boot.builder.SpringApplicationBuilder
便利な流れるような API とコンテキスト階層をサポートする
SpringApplication
および ApplicationContext
インスタンスのビルダー。コンテキスト階層の簡単な例:new SpringApplicationBuilder(ParentConfig.class).child(ChildConfig.class).run(args);別の一般的な使用例は、アクティブなプロファイルとデフォルトプロパティを設定して、アプリケーションの環境を設定することです。
new SpringApplicationBuilder(Application.class).profiles("server") .properties("transport=local").run(args);
ニーズが単純な場合は、代わりに SpringApplication の静的な便利なメソッドの使用を検討してください。
- 導入:
- 1.0.0
- 作成者:
- Dave Syer, Andy Wilkinson
- 関連事項:
コンストラクターのサマリー
コンストラクター説明SpringApplicationBuilder
(ClassSE<?>... sources) SpringApplicationBuilder
(ResourceLoader resourceLoader, ClassSE<?>... sources) メソッドのサマリー
修飾子と型メソッド説明addBootstrapRegistryInitializer
(BootstrapRegistryInitializer bootstrapRegistryInitializer) BootstrapRegistry
の初期化に使用できるBootstrapRegistryInitializer
インスタンスを追加します。addCommandLineProperties
(boolean addCommandLineProperties) コマンドライン引数を環境に追加する必要があることを示すフラグ。allowCircularReferences
(boolean allowCircularReferences) Bean 間の循環参照を許可し、自動的に解決しようとするかどうか。現在のアプリケーションのアクセサー。applicationStartup
(ApplicationStartup applicationStartup) スタートアップメトリクスを収集するためにApplicationContext
とともに使用されるようにApplicationStartup
を構成します。静的バナーファイルが提供されない場合にバナーを出力するために使用されるBanner
インスタンスを設定します。bannerMode
(Banner.Mode bannerMode) beanNameGenerator
(BeanNameGenerator beanNameGenerator) アプリケーションコンテキストで自動的に生成された Bean 名の Bean 名ジェネレーター。build()
実行準備が完了した完全に構成されたSpringApplication
を返します。実行準備が完了した完全に構成されたSpringApplication
を返します。提供されたソースで子アプリケーションを作成します。context()
現在のアプリケーションコンテキストのアクセサー。contextFactory
(ApplicationContextFactory factory) アプリケーションコンテキストの作成に使用されるファクトリを明示的に設定します。protected SpringApplication
createSpringApplication
(ResourceLoader resourceLoader, ClassSE<?>... sources) 指定されたResourceLoader
を使用して、指定されたソースから新しいSpringApplication
インスタンスを作成します。environment
(ConfigurableEnvironment environment) アプリケーションコンテキストの環境。environmentPrefix
(StringSE environmentPrefix) システム環境から構成プロパティを取得するときに適用する必要があるプレフィックス。headless
(boolean headless) アプリケーションがヘッドレスであり、AWT をインスタンス化しないかどうかを設定します。initializers
(ApplicationContextInitializer<?>... initializers) アプリケーションに初期化子をいくつか追加します(Bean 定義がロードされる前にApplicationContext
に適用されます)。lazyInitialization
(boolean lazyInitialization) アプリケーションを遅延初期化する必要があるかどうかを制御するフラグ。listeners
(ApplicationListener<?>... listeners) いくつかのリスナーをアプリケーションに追加します(コンテキストが実行されたら、通常の Spring イベントと同様に SpringApplication イベントをリスニングします)。logStartupInfo
(boolean logStartupInfo) 起動情報を記録する必要があることを示すフラグ。起動メッセージを固定するために使用されるメインアプリケーションクラスを修正します。提供されたソースで親アプリケーションを追加します。parent
(ConfigurableApplicationContext parent) すでに実行中の親コンテキストを既存のアプリケーションに追加します。このアプリ(およびその親と子)のアクティブな Spring プロファイルに追加します。properties
(StringSE... defaultProperties) key=value
またはkey:value
形式の環境のデフォルトプロパティ。properties
(MapSE<StringSE, ObjectSE> defaults) 環境のデフォルトのプロパティ。properties
(PropertiesSE defaultProperties) 環境のデフォルトプロパティ。このメソッドへの複数の呼び出しは累積的であり、以前に設定されたプロパティはクリアされません。registerShutdownHook
(boolean registerShutdownHook) 作成されたApplicationContext
にシャットダウンフックを登録する必要があるかどうかを設定します。resourceLoader
(ResourceLoader resourceLoader) アプリケーションコンテキストのResourceLoader
。指定されたコマンドライン引数を使用して、アプリケーションコンテキスト(および指定されている場合はその親)を作成します。setAddConversionService
(boolean addConversionService) ApplicationConversionService
をアプリケーションコンテキストのEnvironment
に追加する必要があるかどうかを示すフラグ。兄弟アプリケーション(同じ親を持つアプリケーション)を作成します。兄弟アプリケーション(同じ親を持つアプリケーション)を作成します。このアプリケーションにさらにソース(構成クラスおよびコンポーネント)を追加します。web
(WebApplicationType webApplicationType) 特定の型の Web アプリケーションを明示的にリクエストするフラグ。
コンストラクターの詳細
SpringApplicationBuilder
SpringApplicationBuilder
メソッドの詳細
createSpringApplication
protected SpringApplication createSpringApplication(ResourceLoader resourceLoader, ClassSE<?>... sources) 指定されたResourceLoader
を使用して、指定されたソースから新しいSpringApplication
インスタンスを作成します。サブクラスは、SpringApplication
のカスタムサブクラスを提供するためにオーバーライドできます。- パラメーター:
resourceLoader
- リソースローダーまたはnull
sources
- ソース- 戻り値:
SpringApplication
インスタンス- 導入:
- 2.6.0
context
現在のアプリケーションコンテキストのアクセサー。- 戻り値:
- 現在のアプリケーションコンテキスト (まだ実行されていない場合は null)
application
現在のアプリケーションのアクセサー。- 戻り値:
- 現在のアプリケーション (非 null)
run
指定されたコマンドライン引数を使用して、アプリケーションコンテキスト (および指定されている場合はその親) を作成します。親がまだ開始されていない場合は、最初に同じ引数で実行されます。- パラメーター:
args
- コマンドライン引数- 戻り値:
- 現在の状態から作成されたアプリケーションコンテキスト
build
実行準備が完了した完全に構成されたSpringApplication
を返します。- 戻り値:
- 完全に構成された
SpringApplication
build
実行準備が完了した完全に構成されたSpringApplication
を返します。構成されているすべての親は、指定されたargs
で実行されます。- パラメーター:
args
- 親の引数- 戻り値:
- 完全に構成された
SpringApplication
child
提供されたソースで子アプリケーションを作成します。デフォルトの引数と環境は子にコピーされますが、それ以外はすべてクリーンです。- パラメーター:
sources
- アプリケーションのソース (Spring の構成)- 戻り値:
- 子アプリケーションビルダー
parent
提供されたソースで親アプリケーションを追加します。デフォルトの引数と環境は親にコピーされますが、それ以外はすべてクリーンです。- パラメーター:
sources
- アプリケーションのソース (Spring の構成)- 戻り値:
- 親ビルダー
parent
すでに実行中の親コンテキストを既存のアプリケーションに追加します。- パラメーター:
parent
- 親コンテキスト- 戻り値:
- 現在のビルダー (親ではない)
sibling
兄弟アプリケーション(同じ親を持つアプリケーション)を作成します。このメソッドを呼び出す副作用は、現在のアプリケーション(およびその親)がまだ実行されていない場合、引数なしで起動されることです。現在のアプリケーションとその親を起動するときに引数を指定するには、代わりにsibling(Class[], String...)
を使用します。- パラメーター:
sources
- アプリケーションのソース (Spring の構成)- 戻り値:
- 新しい兄弟ビルダー
sibling
兄弟アプリケーション(同じ親を持つアプリケーション)を作成します。このメソッドを呼び出すことの副作用は、現在のアプリケーション(およびその親)がまだ実行されていない場合に開始されることです。- パラメーター:
sources
- アプリケーションのソース (Spring の構成)args
- 現在のアプリとその親を起動するときに使用するコマンドライン引数- 戻り値:
- 新しい兄弟ビルダー
contextFactory
アプリケーションコンテキストの作成に使用されるファクトリを明示的に設定します。- パラメーター:
factory
- 使用するファクトリ- 戻り値:
- 現在のビルダー
- 導入:
- 2.4.0
sources
このアプリケーションにさらにソース(構成クラスおよびコンポーネント)を追加します。- パラメーター:
sources
- 追加するソース- 戻り値:
- 現在のビルダー
web
特定の型の Web アプリケーションを明示的にリクエストするフラグ。設定されていない場合、クラスパスに基づいて自動検出されます。- パラメーター:
webApplicationType
- Web アプリケーションの型- 戻り値:
- 現在のビルダー
- 導入:
- 2.0.0
logStartupInfo
起動情報を記録する必要があることを示すフラグ。- パラメーター:
logStartupInfo
- 設定するフラグ。デフォルトは true。- 戻り値:
- 現在のビルダー
banner
静的バナーファイルが提供されない場合にバナーを出力するために使用されるBanner
インスタンスを設定します。- パラメーター:
banner
- 使用するバナー- 戻り値:
- 現在のビルダー
bannerMode
headless
アプリケーションがヘッドレスであり、AWT をインスタンス化しないかどうかを設定します。java アイコンが表示されないようにするには、デフォルトでtrue
になります。- パラメーター:
headless
- アプリケーションがヘッドレスの場合- 戻り値:
- 現在のビルダー
registerShutdownHook
作成されたApplicationContext
にシャットダウンフックを登録する必要があるかどうかを設定します。- パラメーター:
registerShutdownHook
- シャットダウンフックを登録する必要がある場合- 戻り値:
- 現在のビルダー
main
起動メッセージを固定するために使用されるメインアプリケーションクラスを修正します。- パラメーター:
mainApplicationClass
- 使用するクラス。- 戻り値:
- 現在のビルダー
addCommandLineProperties
コマンドライン引数を環境に追加する必要があることを示すフラグ。- パラメーター:
addCommandLineProperties
- 設定するフラグ。デフォルトは true。- 戻り値:
- 現在のビルダー
setAddConversionService
ApplicationConversionService
をアプリケーションコンテキストのEnvironment
に追加する必要があるかどうかを示すフラグ。- パラメーター:
addConversionService
- 変換サービスを追加する必要がある場合。- 戻り値:
- 現在のビルダー
- 導入:
- 2.1.0
addBootstrapRegistryInitializer
public SpringApplicationBuilder addBootstrapRegistryInitializer(BootstrapRegistryInitializer bootstrapRegistryInitializer) BootstrapRegistry
の初期化に使用できるBootstrapRegistryInitializer
インスタンスを追加します。- パラメーター:
bootstrapRegistryInitializer
- 追加するブートストラップレジストリ初期化子- 戻り値:
- 現在のビルダー
- 導入:
- 2.4.5
lazyInitialization
アプリケーションを遅延初期化する必要があるかどうかを制御するフラグ。- パラメーター:
lazyInitialization
- 設定するフラグ。デフォルトは false です。- 戻り値:
- 現在のビルダー
- 導入:
- 2.2
properties
key=value
またはkey:value
の形式の環境のデフォルトプロパティ。このメソッドへの複数の呼び出しは累積的であり、以前に設定されたプロパティはクリアされません。- パラメーター:
defaultProperties
- 設定するプロパティ。- 戻り値:
- 現在のビルダー
- 関連事項:
properties
環境のデフォルトプロパティ。このメソッドへの複数の呼び出しは累積的であり、以前に設定されたプロパティはクリアされません。- パラメーター:
defaultProperties
- 設定するプロパティ。- 戻り値:
- 現在のビルダー
- 関連事項:
properties
環境のデフォルトプロパティ。このメソッドへの複数の呼び出しは累積的であり、以前に設定されたプロパティはクリアされません。- パラメーター:
defaults
- デフォルトのプロパティ- 戻り値:
- 現在のビルダー
- 関連事項:
profiles
このアプリ(およびその親と子)のアクティブな Spring プロファイルに追加します。- パラメーター:
profiles
- 追加するプロファイル。- 戻り値:
- 現在のビルダー
beanNameGenerator
アプリケーションコンテキストで自動的に生成された Bean 名の Bean 名ジェネレーター。- パラメーター:
beanNameGenerator
- 設定するジェネレーター。- 戻り値:
- 現在のビルダー
environment
アプリケーションコンテキストの環境。- パラメーター:
environment
- 設定する環境。- 戻り値:
- 現在のビルダー
environmentPrefix
システム環境から構成プロパティを取得するときに適用する必要があるプレフィックス。- パラメーター:
environmentPrefix
- 設定する環境プロパティプレフィックス- 戻り値:
- 現在のビルダー
- 導入:
- 2.5.0
resourceLoader
アプリケーションコンテキストのResourceLoader
。カスタムクラスローダーが必要な場合は、ここに追加します。- パラメーター:
resourceLoader
- 設定するリソースローダー。- 戻り値:
- 現在のビルダー
initializers
アプリケーションに初期化子をいくつか追加します(Bean 定義がロードされる前にApplicationContext
に適用されます)。- パラメーター:
initializers
- 追加する初期化子- 戻り値:
- 現在のビルダー
listeners
いくつかのリスナーをアプリケーションに追加します(コンテキストが実行されると、SpringApplication イベントと通常の Spring イベントをリスニングします)。ApplicationContextInitializer
でもあるリスナーは、initializers
に自動的に追加されます。- パラメーター:
listeners
- 追加するリスナー- 戻り値:
- 現在のビルダー
applicationStartup
スタートアップメトリクスを収集するためにApplicationContext
とともに使用されるようにApplicationStartup
を構成します。- パラメーター:
applicationStartup
- 使用するアプリケーションの起動- 戻り値:
- 現在のビルダー
- 導入:
- 2.4.0
allowCircularReferences
Bean 間の循環参照を許可し、自動的に解決しようとするかどうか。- パラメーター:
allowCircularReferences
- 循環参照が許可されているかどうか- 戻り値:
- 現在のビルダー
- 導入:
- 2.6.0
- 関連事項: