ReloadableResourceBundleMessageSource (Spring Framework 5.2.10.RELEASE API)

java.lang.ObjectSE
- org.springframework.context.support.MessageSourceSupport
- - org.springframework.context.support.AbstractMessageSource
  - - org.springframework.context.support.AbstractResourceBasedMessageSource
    - - org.springframework.context.support.ReloadableResourceBundleMessageSource

実装されたすべてのインターフェース:
Aware, HierarchicalMessageSource, MessageSource, ResourceLoaderAware
```
public class ReloadableResourceBundleMessageSource
extends AbstractResourceBasedMessageSource
implements ResourceLoaderAware
```
指定されたベース名を使用してリソースバンドルにアクセスし、Spring ApplicationContext のリソースロードに参加する、Spring 固有の MessageSource 実装。
JDK ベースの ResourceBundleMessageSource とは対照的に、このクラスはメッセージのカスタムデータ構造として PropertiesSE インスタンスを使用し、Spring Resource ハンドルから PropertiesPersister 戦略を介してロードします。この方法では、タイムスタンプの変更に基づいてファイルを再ロードできるだけでなく、特定の文字エンコーディングでプロパティファイルをロードすることもできます。XML プロパティファイルも検出します。
"basenames" プロパティとして設定されたベース名は、ResourceBundleMessageSource の "basenames" プロパティとは少し異なる方法で処理されることに注意してください。ファイル拡張子や言語コードを指定しないという基本的な ResourceBundle ルールに従いますが、クラスパスリソースに制限されるのではなく、任意の Spring リソースの場所を参照できます。"classpath:" プレフィックスを使用すると、リソースはクラスパスからロードできますが、この場合、"-1" (永久にキャッシュ) 以外の "cacheSeconds" 値は確実に機能しない可能性があります。
典型的な Web アプリケーションの場合、メッセージファイルは WEB-INF に配置できます。たとえば、"WEB-INF/messages" ベース名は "WEB-INF/messages.properties"、"WEB-INF/messages_en.properties" などの配置も検索します "WEB-INF/messages.xml"、"WEB-INF/messages_en.xml" など。順次検索により、前のリソースバンドルのメッセージ定義が後のバンドルのメッセージ定義をオーバーライドすることに注意してください。
この MessageSource は、ApplicationContext の外部で簡単に使用できます。デフォルトで DefaultResourceLoader を使用し、コンテキストで実行されている場合は、ApplicationContext のリソースローダーでオーバーライドされるだけです。他の特定の依存関係はありません。
このメッセージソースの初期実装を提供してくれた Thomas Achleitner に感謝します。
作成者:
Juergen Hoeller
関連事項:
AbstractResourceBasedMessageSource.setCacheSeconds(int), AbstractResourceBasedMessageSource.setBasenames(java.lang.String...), AbstractResourceBasedMessageSource.setDefaultEncoding(java.lang.String), setFileEncodings(java.util.Properties), setPropertiesPersister(org.springframework.util.PropertiesPersister), setResourceLoader(org.springframework.core.io.ResourceLoader), DefaultPropertiesPersister, DefaultResourceLoader, ResourceBundleMessageSource, ResourceBundleSE

ネストされたクラスのサマリー
ネストされたクラス
修飾子と型クラスと説明
protected class ReloadableResourceBundleMessageSource.PropertiesHolder
キャッシュ用の PropertiesHolder。

ネストされたクラス
修飾子と型	クラスと説明
`protected class`	`ReloadableResourceBundleMessageSource.PropertiesHolder` キャッシュ用の PropertiesHolder。

フィールドのサマリー
- クラス org.springframework.context.support.MessageSourceSupport から継承されたフィールド
  logger

コンストラクターの概要
コンストラクター
コンストラクターと説明
ReloadableResourceBundleMessageSource()

コンストラクター
コンストラクターと説明
`ReloadableResourceBundleMessageSource()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ListSE<StringSE>`	`calculateAllFilenames(StringSE basename, LocaleSE locale)` 指定されたバンドルのベース名とロケールのすべてのファイル名を計算します。
`protected ListSE<StringSE>`	`calculateFilenamesForLocale(StringSE basename, LocaleSE locale)` 特定のバンドルのベース名とロケールのファイル名を計算し、言語コード、国コード、バリアントコードを追加します。
`void`	`clearCache()` リソースバンドルキャッシュをクリアします。
`void`	`clearCacheIncludingAncestors()` この MessageSource とそのすべての祖先のリソースバンドルキャッシュをクリアします。
`protected ReloadableResourceBundleMessageSource.PropertiesHolder`	`getMergedProperties(LocaleSE locale)` 指定されたすべてのリソースバンドルをマージした後、ロケールに実際に表示されるプロパティを含む PropertiesHolder を取得します。
`protected ReloadableResourceBundleMessageSource.PropertiesHolder`	`getProperties(StringSE filename)` 指定されたファイル名の PropertiesHolder を、キャッシュから、新たにロードして取得します。
`protected PropertiesSE`	`loadProperties(Resource resource, StringSE filename)` 指定されたリソースからプロパティをロードします。
`protected PropertiesSE`	`newProperties()` プレーンな新しい `Properties`SE インスタンスを作成するためのテンプレートメソッド。
`protected ReloadableResourceBundleMessageSource.PropertiesHolder`	`refreshProperties(StringSE filename, ReloadableResourceBundleMessageSource.PropertiesHolder propHolder)` 指定されたバンドルファイル名の PropertiesHolder をリフレッシュします。
`protected MessageFormatSE`	`resolveCode(StringSE code, LocaleSE locale)` メッセージコードごとにキャッシュされた MessageFormat インスタンスを使用して、取得されたバンドルファイルのキーとして指定されたメッセージコードを解決します。
`protected StringSE`	`resolveCodeWithoutArguments(StringSE code, LocaleSE locale)` 取得されたバンドルファイルのキーとして指定されたメッセージコードを解決し、バンドルで見つかった値をそのまま返します（MessageFormat 解析なし）。
`void`	`setConcurrentRefresh(boolean concurrentRefresh)` 同時リフレッシュ動作を許可するかどうかを指定します。
`void`	`setFileEncodings(PropertiesSE fileEncodings)` プロパティファイルの解析に使用するファイルごとの文字セットを設定します。
`void`	`setPropertiesPersister(PropertiesPersister propertiesPersister)` プロパティファイルの解析に使用する PropertiesPersister を設定します。
`void`	`setResourceLoader(ResourceLoader resourceLoader)` バンドルプロパティファイルのロードに使用する ResourceLoader を設定します。
`StringSE`	`toString()`

クラス org.springframework.context.support.AbstractResourceBasedMessageSource から継承されたメソッド
addBasenames, getBasenameSet, getCacheMillis, getDefaultEncoding, getDefaultLocale, isFallbackToSystemLocale, setBasename, setBasenames, setCacheMillis, setCacheSeconds, setDefaultEncoding, setDefaultLocale, setFallbackToSystemLocale

クラス org.springframework.context.support.AbstractMessageSource から継承されたメソッド
getCommonMessages, getDefaultMessage, getDefaultMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, resolveArguments, setCommonMessages, setParentMessageSource, setUseCodeAsDefaultMessage

クラス org.springframework.context.support.MessageSourceSupport から継承されたメソッド
createMessageFormat, formatMessage, isAlwaysUseMessageFormat, renderDefaultMessage, setAlwaysUseMessageFormat

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ReloadableResourceBundleMessageSource
```
public ReloadableResourceBundleMessageSource()
```
- メソッドの詳細
  - setFileEncodings
```
public void setFileEncodings(PropertiesSE fileEncodings)
```
    プロパティファイルの解析に使用するファイルごとの文字セットを設定します。
    クラシックプロパティファイルにのみ適用され、XML ファイルには適用されません。
    パラメーター:
    fileEncodings - ファイル名をキー、文字セット名を値とするプロパティ。ファイル名は、オプションのロケール固有のコンポーネントを使用して、basename 構文と一致する必要があります。"WEB-INF/messages" または "WEB-INF/messages_en"。
    関連事項:
    AbstractResourceBasedMessageSource.setBasenames(java.lang.String...), PropertiesPersister.load(java.util.Properties, java.io.InputStream)
  - setConcurrentRefresh
```
public void setConcurrentRefresh(boolean concurrentRefresh)
```
    同時リフレッシュ動作を許可するかどうかを指定します。つまり、特定のキャッシュされたプロパティファイルのリフレッシュ試行で 1 つのスレッドがロックされる一方で、リフレッシュ試行が完了するまで、他のスレッドはしばらくの間古いプロパティを返し続けます。
    デフォルトは「true」: この動作は Spring Framework 4.1 から新しくなり、スレッド間の競合を最小限に抑えています。以前の動作、つまりリフレッシュ時に完全にブロックする場合は、このフラグを "false" に切り替えます。
    導入:
    4.1
    関連事項:
    AbstractResourceBasedMessageSource.setCacheSeconds(int)
  - setPropertiesPersister
```
public void setPropertiesPersister(@Nullable
                                   PropertiesPersister propertiesPersister)
```
    プロパティファイルの解析に使用する PropertiesPersister を設定します。
    デフォルトは DefaultPropertiesPersister です。
    関連事項:
    DefaultPropertiesPersister
  - setResourceLoader
```
public void setResourceLoader(@Nullable
                              ResourceLoader resourceLoader)
```
    バンドルプロパティファイルのロードに使用する ResourceLoader を設定します。
    デフォルトは DefaultResourceLoader です。コンテキストで実行されている場合、ResourceLoaderAware インターフェースを実装しているため、ApplicationContext によってオーバーライドされます。ApplicationContext の外部で実行する場合は、手動でオーバーライドできます。
    次で指定:
    インターフェース ResourceLoaderAware の setResourceLoader
    パラメーター:
    resourceLoader - このオブジェクトによって使用される ResourceLoader オブジェクト
    関連事項:
    DefaultResourceLoader, ResourceLoaderAware
  - resolveCodeWithoutArguments
```
protected StringSE resolveCodeWithoutArguments(StringSE code,
                                             LocaleSE locale)
```
    取得されたバンドルファイルのキーとして指定されたメッセージコードを解決し、バンドルで見つかった値をそのまま返します（MessageFormat 解析なし）。
    オーバーライド:
    クラス AbstractMessageSource の resolveCodeWithoutArguments
    パラメーター:
    code - 解決するメッセージのコード
    locale - コードを解決するロケール (サブクラスは国際化をサポートすることが推奨されます)
    戻り値:
    メッセージ文字列、または見つからない場合は null
    関連事項:
    AbstractMessageSource.resolveCode(java.lang.String, java.util.Locale), MessageFormatSE
  - resolveCode
```
@Nullable
protected MessageFormatSE resolveCode(StringSE code,
                                              LocaleSE locale)
```
    メッセージコードごとにキャッシュされた MessageFormat インスタンスを使用して、取得されたバンドルファイルのキーとして指定されたメッセージコードを解決します。
    次で指定:
    クラス AbstractMessageSource の resolveCode
    パラメーター:
    code - 解決するメッセージのコード
    locale - コードを解決するロケール (サブクラスは国際化をサポートすることが推奨されます)
    戻り値:
    メッセージの MessageFormat。見つからない場合は null
    関連事項:
    AbstractMessageSource.resolveCodeWithoutArguments(String, java.util.Locale)
  - getMergedProperties
```
protected ReloadableResourceBundleMessageSource.PropertiesHolder getMergedProperties(LocaleSE locale)
```
    指定されたすべてのリソースバンドルをマージした後、ロケールに実際に表示されるプロパティを含む PropertiesHolder を取得します。ホルダーをキャッシュからフェッチするか、新たにロードします。
    リソースバンドルの内容を永久にキャッシュする場合にのみ使用されます (つまり、cacheSeconds < 0)。マージされたプロパティは常に永久にキャッシュされます。
  - calculateAllFilenames
```
protected ListSE<StringSE> calculateAllFilenames(StringSE basename,
                                             LocaleSE locale)
```
    指定されたバンドルのベース名とロケールのすべてのファイル名を計算します。指定されたロケール、システムロケール（該当する場合）、デフォルトファイルのファイル名を計算します。
    パラメーター:
    basename - バンドルのベース名
    locale - ロケール
    戻り値:
    チェックするファイル名のリスト
    関連事項:
    AbstractResourceBasedMessageSource.setFallbackToSystemLocale(boolean), calculateFilenamesForLocale(java.lang.String, java.util.Locale)
  - calculateFilenamesForLocale
```
protected ListSE<StringSE> calculateFilenamesForLocale(StringSE basename,
                                                   LocaleSE locale)
```
    特定のバンドルのベース名とロケールのファイル名を計算し、言語コード、国コード、バリアントコードを追加します。例: basename "messages"、Locale "de_AT_oo" -> "messages_de_AT_OO"、"messages_de_AT"、"messages_de"。
    Locale.toString()SE で定義されたルールに従います。
    パラメーター:
    basename - バンドルのベース名
    locale - ロケール
    戻り値:
    チェックするファイル名のリスト
  - getProperties
```
protected ReloadableResourceBundleMessageSource.PropertiesHolder getProperties(StringSE filename)
```
    指定されたファイル名の PropertiesHolder を、キャッシュから、新たにロードして取得します。
    パラメーター:
    filename - バンドルのファイル名 (ベース名 + ロケール)
    戻り値:
    バンドルの現在の PropertiesHolder
  - refreshProperties
```
protected ReloadableResourceBundleMessageSource.PropertiesHolder refreshProperties(StringSE filename,
                                                                                   @Nullable
                                                                                   ReloadableResourceBundleMessageSource.PropertiesHolder propHolder)
```
    指定されたバンドルファイル名の PropertiesHolder をリフレッシュします。ホルダーは、以前にキャッシュされていない場合は null か、タイムアウトしたキャッシュエントリ（現在の最終変更タイムスタンプに対して再検証される可能性があります）になります。
    パラメーター:
    filename - バンドルのファイル名 (ベース名 + ロケール)
    propHolder - バンドルの現在の PropertiesHolder
  - loadProperties
```
protected PropertiesSE loadProperties(Resource resource,
                                    StringSE filename)
                             throws IOExceptionSE
```
    指定されたリソースからプロパティをロードします。
    パラメーター:
    resource - ロード元のリソース
    filename - 元のバンドルファイル名 (ベース名 + ロケール)
    戻り値:
    移入された Properties インスタンス
    例外:
    IOExceptionSE - プロパティの読み込みに失敗した場合
  - newProperties
```
protected PropertiesSE newProperties()
```
    プレーンな新しい PropertiesSE インスタンスを作成するためのテンプレートメソッド。デフォルトの実装では、単に Properties.Properties()SE を呼び出します。
    サブクラスでカスタム PropertiesSE 拡張を返すことができます。オーバーライドするメソッドは、カスタム PropertiesSE サブクラスをインスタンス化するだけで、その時点でそれ以上の初期化やポピュレーションは実行されません。
    戻り値:
    プレーンプロパティインスタンス
    導入:
    4.2
  - clearCache
```
public void clearCache()
```
    リソースバンドルキャッシュをクリアします。その後の resolve 呼び出しは、プロパティファイルのリロードにつながります。
  - clearCacheIncludingAncestors
```
public void clearCacheIncludingAncestors()
```
    この MessageSource とそのすべての祖先のリソースバンドルキャッシュをクリアします。
    関連事項:
    clearCache()
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス ReloadableResourceBundleMessageSource

ネストされたクラスのサマリー

フィールドのサマリー

クラス org.springframework.context.support.MessageSourceSupport から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.context.support.AbstractResourceBasedMessageSource から継承されたメソッド

クラス org.springframework.context.support.AbstractMessageSource から継承されたメソッド

クラス org.springframework.context.support.MessageSourceSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

ReloadableResourceBundleMessageSource

メソッドの詳細

setFileEncodings

setConcurrentRefresh

setPropertiesPersister

setResourceLoader

resolveCodeWithoutArguments

resolveCode

getMergedProperties

calculateAllFilenames

calculateFilenamesForLocale

getProperties

refreshProperties

loadProperties

newProperties

clearCache

clearCacheIncludingAncestors

toString