クラス TestPropertySourceUtils
@TestPropertySource
を操作し、テスト PropertySources
を Environment
に追加するためのユーティリティメソッド。主にフレームワーク内での使用を目的としています。
- 導入:
- 4.1
- 作成者:
- Sam Brannen, Anatoliy Korovin, Phillip Webb
- 関連事項:
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明static void
addInlinedPropertiesToEnvironment
(ConfigurableApplicationContext context, StringSE... inlinedProperties) 指定されたインライン化されたプロパティを、提供されたcontext
のEnvironment
に追加します。static void
addInlinedPropertiesToEnvironment
(ConfigurableEnvironment environment, StringSE... inlinedProperties) 指定されたインライン化されたプロパティ(キーと値のペアの形式)を、指定されたenvironment
に追加します。static void
addPropertiesFilesToEnvironment
(ConfigurableApplicationContext context, StringSE... locations) static void
addPropertiesFilesToEnvironment
(ConfigurableEnvironment environment, ResourceLoader resourceLoader, StringSE... locations) static void
addPropertySourcesToEnvironment
(ConfigurableApplicationContext context, ListSE<PropertySourceDescriptor> descriptors) static void
addPropertySourcesToEnvironment
(ConfigurableEnvironment environment, ResourceLoader resourceLoader, ListSE<PropertySourceDescriptor> descriptors) 指定されたdescriptors
のプロパティソースを、指定されたenvironment
に追加します。convertInlinedPropertiesToMap
(StringSE... inlinedProperties) 指定されたインライン化プロパティ ( キーと値のペアの形式) を、プロパティ名をキーとしたマップに変換します。
フィールドの詳細
INLINED_PROPERTIES_PROPERTY_SOURCE_NAME
インライン化されたプロパティから作成されたMapPropertySource
の名前。
コンストラクターの詳細
TestPropertySourceUtils
public TestPropertySourceUtils()
メソッドの詳細
addPropertiesFilesToEnvironment
public static void addPropertiesFilesToEnvironment(ConfigurableApplicationContext context, StringSE... locations) 指定されたリソースlocations
のProperties
SE ファイルを、提供されたcontext
のEnvironment
に追加します。このメソッドは
addPropertiesFilesToEnvironment(ConfigurableEnvironment, ResourceLoader, String...)
に委譲します。- パラメーター:
context
- 環境を更新する必要があるアプリケーションコンテキスト。null
locations
- 環境に追加するProperties
ファイルのリソースの場所。空になる可能性がありますが、null
はありません- 例外:
IllegalStateExceptionSE
- プロパティファイルの処理中にエラーが発生した場合- 導入:
- 4.1.5
- 関連事項:
addPropertiesFilesToEnvironment
public static void addPropertiesFilesToEnvironment(ConfigurableEnvironment environment, ResourceLoader resourceLoader, StringSE... locations) 指定されたリソースlocations
から提供されたenvironment
にProperties
SE ファイルを追加します。リソースの場所(
${...}
など)のプロパティプレースホルダーは、Environment
に対して解決されます。ResourcePatternResolver
は、リソースの場所パターンを複数のリソースの場所に解決するために使用されます。各プロパティファイルは
ResourcePropertySource
に変換され、環境のPropertySources
に最も高い優先順位で追加されます。- パラメーター:
environment
- 更新する環境。null
resourceLoader
- 各リソースをロードするために使用するResourceLoader
。null
locations
- 環境に追加するProperties
ファイルのリソースの場所。空になる可能性がありますが、null
はありません- 例外:
IllegalStateExceptionSE
- プロパティファイルの処理中にエラーが発生した場合- 導入:
- 4.3
- 関連事項:
addPropertySourcesToEnvironment
public static void addPropertySourcesToEnvironment(ConfigurableApplicationContext context, ListSE<PropertySourceDescriptor> descriptors) 指定されたdescriptors
のプロパティソースを、指定されたcontext
のEnvironment
に追加します。このメソッドは
addPropertySourcesToEnvironment(ConfigurableEnvironment, ResourceLoader, List)
に委譲します。- パラメーター:
context
- 環境を更新する必要があるアプリケーションコンテキスト。null
descriptors
- 処理するプロパティソース記述子。空の可能性がありますが、null
ではありません- 例外:
IllegalStateExceptionSE
- 記述子の処理およびプロパティソースの登録中にエラーが発生した場合- 導入:
- 6.1
- 関連事項:
addPropertySourcesToEnvironment
public static void addPropertySourcesToEnvironment(ConfigurableEnvironment environment, ResourceLoader resourceLoader, ListSE<PropertySourceDescriptor> descriptors) 指定されたdescriptors
のプロパティソースを、指定されたenvironment
に追加します。リソースの場所(
${...}
など)のプロパティプレースホルダーは、Environment
に対して解決されます。ResourcePatternResolver
は、リソースの場所パターンを複数のリソースの場所に解決するために使用されます。各
PropertySource
は、構成されたPropertySourceFactory
(またはファクトリが構成されていない場合はDefaultPropertySourceFactory
) を介して作成され、最も高い優先順位で環境のPropertySources
に追加されます。- パラメーター:
environment
- 更新する環境。null
resourceLoader
- リソースをロードするために使用するResourceLoader
。決してnull
ではありませんdescriptors
- 処理するプロパティソース記述子。空の可能性がありますが、null
ではありません- 例外:
IllegalStateExceptionSE
- 記述子の処理およびプロパティソースの登録中にエラーが発生した場合- 導入:
- 6.1
- 関連事項:
addInlinedPropertiesToEnvironment
public static void addInlinedPropertiesToEnvironment(ConfigurableApplicationContext context, StringSE... inlinedProperties) 指定されたインライン化されたプロパティを、提供されたcontext
のEnvironment
に追加します。このメソッドは、単に
addInlinedPropertiesToEnvironment(ConfigurableEnvironment, String[])
に委譲します。- パラメーター:
context
- 環境を更新する必要があるアプリケーションコンテキスト。null
inlinedProperties
- 環境に追加するインラインプロパティ。空になる可能性がありますが、null
になることはありません- 導入:
- 4.1.5
- 関連事項:
addInlinedPropertiesToEnvironment
public static void addInlinedPropertiesToEnvironment(ConfigurableEnvironment environment, StringSE... inlinedProperties) 指定されたインライン化されたプロパティ(キーと値のペアの形式)を、指定されたenvironment
に追加します。すべてのキーと値のペアは、最高の優先順位を持つ単一の
MapPropertySource
としてEnvironment
に追加されます。インライン化されたプロパティの解析の詳細については、
convertInlinedPropertiesToMap(java.lang.String...)
の Javadoc を参照してください。- パラメーター:
environment
- 更新する環境。null
inlinedProperties
- 環境に追加するインラインプロパティ。空になる可能性がありますが、null
になることはありません- 導入:
- 4.1.5
- 関連事項:
convertInlinedPropertiesToMap
指定されたインライン化プロパティ ( キーと値のペアの形式) を、プロパティ名をキーとしたマップに変換します。キーと値のペアの解析は、提供されたすべての文字列をメモリ内の仮想プロパティファイルに変換し、各仮想ファイルの解析を
Properties.load(java.io.Reader)
SE に委譲することによって実現されます。プロパティ名の順序は、キーと値のペアがこのメソッドに提供される順序と同様に、返されたマップ内に保持されます。これは、単一の文字列に改行で区切られた複数のキーと値のペアが含まれている場合にも当てはまります。たとえば、ユーザーがテキストブロックを介して指定した場合です。
インライン化されたプロパティの詳細については、
TestPropertySource.properties()
の Javadoc を参照してください。- パラメーター:
inlinedProperties
- 変換するインラインプロパティ。空になる可能性がありますが、null
になることはありません- 戻り値:
- 変換されたプロパティを含む新しい順序付けられたマップ
- 例外:
IllegalStateExceptionSE
- 指定されたキーと値のペアを解析できない場合- 導入:
- 4.1.5
- 関連事項: