public class EhCacheManagerFactoryBean extends ObjectSE implements FactoryBean<CacheManager>, InitializingBean, DisposableBean
CacheManager
インスタンス(独立または共有)を公開する FactoryBean
。構成場所が指定されていない場合、CacheManager はクラスパスのルートにある "ehcache.xml" から構成されます(つまり、デフォルトの EhCache 初期化(EhCache ドキュメントで定義されている)が適用されます)。
(デフォルトで)独立した CacheManager インスタンスを提供し、CacheManager の適切なシャットダウンを考慮しているため、EhCacheFactoryBean を使用する場合は、別の EhCacheManagerFactoryBean をセットアップすることもお勧めします。EhCacheManagerFactoryBean は、デフォルト以外の設定場所から EhCache 設定をロードするためにも必要です。
メモ: Spring 5.0 以降、Spring の EhCache サポートには EhCache 2.10 以上が必要です。
setConfigLocation(org.springframework.core.io.Resource)
, setShared(boolean)
, EhCacheFactoryBean
, CacheManager
修飾子と型 | フィールドと説明 |
---|---|
protected Log | logger |
OBJECT_TYPE_ATTRIBUTE
コンストラクターと説明 |
---|
EhCacheManagerFactoryBean() |
修飾子と型 | メソッドと説明 |
---|---|
void | afterPropertiesSet() |
void | destroy() Bean の破棄時に、包含 BeanFactory によって呼び出されます。 |
CacheManager | getObject() このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。 |
ClassSE<? extends CacheManager> | getObjectType() この FactoryBean が作成するオブジェクトの型、または事前に不明な場合は null を返します。 |
boolean | isSingleton() このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、 FactoryBean.getObject() は常に同じオブジェクト(キャッシュ可能な参照)を返しますか? |
void | setAcceptExisting(boolean acceptExisting) この EhCacheManagerFactoryBean セットアップで同じ名前の既存の EhCache CacheManager を受け入れるかどうかを設定します。 |
void | setCacheManagerName(StringSE cacheManagerName) EhCache CacheManager の名前を設定します(特定の名前が必要な場合)。 |
void | setConfigLocation(Resource configLocation) EhCache 構成ファイルの場所を設定します。 |
void | setShared(boolean shared) EhCache CacheManager を共有する(ClassLoader レベルのシングルトンとして)か、独立する(通常はアプリケーション内でローカル)かを設定します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
protected final Log logger
public void setConfigLocation(Resource configLocation)
デフォルトは、クラスパスのルートにある "ehcache.xml" です。見つからない場合は、EhCache jar にある "ehcache-failsafe.xml" (デフォルトは EhCache 初期化)です。
public void setCacheManagerName(StringSE cacheManagerName)
public void setAcceptExisting(boolean acceptExisting)
通常は "cacheManagerName"
と組み合わせて使用されますが、何も指定されていない場合は、デフォルトの CacheManager 名で機能します。同じ ClassLoader スペース内の同じ CacheManager 名(または同じデフォルト)へのすべての参照は、指定された CacheManager を共有します。
public void setShared(boolean shared)
注意 : この機能により、この EhCacheManagerFactoryBean の CacheManager を、同じ ClassLoader スペースで CacheManager.create()
を呼び出す任意のコードと共有できます。特定の CacheManager 名について合意する必要はありません。ただし、基礎となる CacheManager のライフサイクル(特に、そのシャットダウン)を制御する、関与する単一の EhCacheManagerFactoryBean のみをサポートします。
このフラグは "acceptExisting"
をオーバーライドします。両方が設定されている場合、「より強力な」共有モードを示しているためです。
public void afterPropertiesSet() throws CacheException
InitializingBean
BeanFactoryAware
、ApplicationContextAware
などを満たした後、包含 BeanFactory
によって呼び出されます。このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
InitializingBean
の afterPropertiesSet
CacheException
@Nullable public CacheManager getObject()
FactoryBean
BeanFactory
と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。
この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する FactoryBeanNotInitializedException
をスローします。
Spring 2.0 以降、FactoryBeans は null
オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。
FactoryBean<CacheManager>
の getObject
null
にすることができます)FactoryBeanNotInitializedException
public ClassSE<? extends CacheManager> getObjectType()
FactoryBean
null
を返します。これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。
シングルトンオブジェクトを作成している実装の場合、このメソッドはシングルトンの作成を可能な限り回避しようとします。むしろ、事前に型を推定する必要があります。プロトタイプの場合、ここで意味のある型を返すこともお勧めします。
このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。
注意 : オートワイヤーは、ここで null
を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。
FactoryBean<CacheManager>
の getObjectType
null
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.getObject()
は常に同じオブジェクト(キャッシュ可能な参照)を返しますか? 注意 : FactoryBean がシングルトンオブジェクトを保持することを示す場合、getObject()
から返されたオブジェクトは所有 BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true
を返さないでください。
FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。
注意 : false
を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張 SmartFactoryBean
インターフェースの実装は、SmartFactoryBean.isPrototype()
メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンな FactoryBean
実装は、isSingleton()
実装が false
を返す場合、常に独立したインスタンスを返すと単純に想定されます。
FactoryBean
は通常シングルトンインスタンスを管理するため、デフォルトの実装では true
が返されます。
FactoryBean<CacheManager>
の isSingleton
FactoryBean.getObject()
, SmartFactoryBean.isPrototype()
public void destroy()
DisposableBean
BeanFactory
によって呼び出されます。DisposableBean
の destroy