クラス LettuceConnectionFactory
- 実装されたすべてのインターフェース:
DisposableBean
、InitializingBean
、Lifecycle
、Phased
、SmartLifecycle
、PersistenceExceptionTranslator
、ReactiveRedisConnectionFactory
、RedisConnectionFactory
Connection factory
は Lettuce ベースの接続を作成します。 このファクトリは、getConnection()
を呼び出すたびに新しい LettuceConnection
を作成します。複数の LettuceConnection
はデフォルトで単一のスレッドセーフなネイティブ接続を共有しますが、LettuceConnection
とその clustered variant
はスレッドセーフではないため、インスタンスをスレッド間で共有すべきではありません。
共有ネイティブ接続は LettuceConnection
によって閉じられることはないため、デフォルトでは getConnection()
で検証されません。必要に応じて、setValidateConnection(boolean)
を使用してこの動作を変更してください。shareNativeConnection
が true の場合、共有接続は通常の操作に使用され、LettuceConnectionProvider
は、接続を共有しないブロッキングおよび tx 操作のみの接続を選択するために使用されます。ネイティブ接続共有が無効になっている場合、新しい (またはプールされた) 接続がすべての操作に使用されます。
LettuceConnectionFactory
は、環境構成と client configuration
を使用して構成する必要があります。Lettuce は、次の環境構成をサポートします。
RedisStandaloneConfiguration
RedisStaticMasterReplicaConfiguration
RedisSocketConfiguration
RedisSentinelConfiguration
RedisClusterConfiguration
この接続ファクトリは、柔軟なライフサイクル制御のために InitializingBean
と SmartLifecycle
を実装します。接続を取得するには、initialized
と started
である必要があります。デフォルトでは、この Initialization
、starts
、Bean、early
です。必要に応じて、この接続ファクトリを Lifecycle.stop()
および restart
にすることができます。early startup
を無効にすると、auto-startup
が有効になっている場合にライフサイクル管理がコンテナーのリフレッシュに委ねられます。
- 作成者:
- Costin Leau, Jennifer Hickey, Thomas Darimont, Christoph Strobl, Mark Paluch, Bal á zs N é meth, Ruben Cervilla, Luis De Bello, Andrea Como, Chris Bono, John Blum
フィールドサマリー
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
コンストラクターのサマリー
コンストラクターコンストラクター説明デフォルト設定で新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(StringSE host, int port) デフォルト設定で新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisClusterConfiguration clusterConfiguration) RedisClusterClient
を作成するために適用された特定のRedisClusterConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisClusterConfiguration clusterConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisClusterConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisConfiguration redisConfiguration) 指定されたRedisSocketConfiguration
を使用して新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisConfiguration redisConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisStaticMasterReplicaConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisSentinelConfiguration sentinelConfiguration) 指定されたRedisSentinelConfiguration
を使用して新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisSentinelConfiguration sentinelConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisSentinelConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisStandaloneConfiguration configuration) デフォルト設定で新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
(RedisStandaloneConfiguration standaloneConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisStandaloneConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。メソッドのサマリー
修飾子と型メソッド説明void
protected io.lettuce.core.AbstractRedisClient
static RedisConfiguration
createRedisConfiguration
(io.lettuce.core.RedisURI redisUri) 以下に従って、RedisURI
に基づいてRedisConfiguration
を作成します。RedisURI
にセンチネルが含まれている場合、RedisSentinelConfiguration
が返されます。RedisURI
にソケットが構成されている場合、RedisSocketConfiguration
が返されます。それ以外の場合、RedisStandaloneConfiguration
が返されます。static RedisConfiguration
createRedisConfiguration
(StringSE redisUri) 以下に従って、URI
SE に基づいてRedisConfiguration
を作成します。redisUri
にセンチネルが含まれている場合、RedisSentinelConfiguration
が返されます。redisUri
にソケットが構成されている場合、RedisSocketConfiguration
が返されます。それ以外の場合、RedisStandaloneConfiguration
が返されます。void
destroy()
protected LettuceConnectionProvider
doCreateConnectionProvider
(io.lettuce.core.AbstractRedisClient client, io.lettuce.core.codec.RedisCodec<?, ?> codec) protected LettuceClusterConnection
doCreateLettuceClusterConnection
(io.lettuce.core.cluster.api.StatefulRedisClusterConnection<byte[], byte[]> sharedConnection, LettuceConnectionProvider connectionProvider, ClusterTopologyProvider topologyProvider, ClusterCommandExecutor clusterCommandExecutor, DurationSE commandTimeout) LettuceClusterConnection
作成用のカスタマイズフック。protected LettuceConnection
doCreateLettuceConnection
(io.lettuce.core.api.StatefulRedisConnection<byte[], byte[]> sharedConnection, LettuceConnectionProvider connectionProvider, long timeout, int database) LettuceConnection
作成用のカスタマイズフック。クライアント名を返します。io.lettuce.core.resource.ClientResources
インフラストラクチャを再利用するためにClientResources
を取得します。Redis クラスターとの対話に適したconnection
を返します。Redis との対話に適したconnection
を返します。boolean
パイプライン化された結果を期待されるデータ型に変換する必要があるかどうかを指定します。int
データベースのインデックスを返します。boolean
shared connections
を先行初期化する必要があることを示します。現在のホストを返します。io.lettuce.core.AbstractRedisClient
このインスタンスで使用されるネイティブAbstractRedisClient
を返します。Redis サーバーでの認証に使用されるパスワードを返します。int
getPhase()
int
getPort()
現在のポートを返します。org.springframework.data.redis.connection.lettuce.LettuceReactiveRedisClusterConnection
org.springframework.data.redis.connection.lettuce.LettuceReactiveRedisConnection
io.lettuce.core.AbstractRedisClient
このインスタンスで使用されるネイティブAbstractRedisClient
を返します。Redis Sentinel との対話に適したconnection
を返します。protected io.lettuce.core.cluster.api.StatefulRedisClusterConnection<byte[],
byte[]> protected io.lettuce.core.api.StatefulRedisConnection<byte[],
byte[]> protected io.lettuce.core.api.StatefulConnection<ByteBufferSE,
ByteBufferSE> boolean
複数のLettuceConnection
が単一のネイティブ接続を共有する必要があるかどうかを示します。long
RedisClient をシャットダウンするためのシャットダウンタイムアウトを返します(ミリ秒単位)。long
接続タイムアウトを返します(ミリ秒単位)。boolean
ネイティブ Lettuce 接続の検証が有効になっているかどうかを示します。void
native connection sharing
が有効になっている場合は共有接続を初期化し、既存の接続をリセットします。boolean
boolean
boolean
boolean
boolean
boolean
StartTLS を発行するかどうかを返します。boolean
isUseSsl()
SSL を使用するかどうかを返します。boolean
SSL 使用時に証明書の有効性 / ホスト名チェックを検証するかどうかを返します。void
基礎となる共有接続をリセットして、次のアクセスで再初期化します。void
setAutoStartup
(boolean autoStartup) コンテナーに含まれる ApplicationContext がリフレッシュされたときに、このライフサイクル接続ファクトリがコンテナーによって自動的に開始されるかどうかを構成します。void
setClientName
(StringSE clientName) 使用すべきではありません。void
setClientResources
(io.lettuce.core.resource.ClientResources clientResources) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してClientResources
を構成します。void
setConvertPipelineAndTxResults
(boolean convertPipelineAndTxResults) パイプライン化されたトランザクション結果を期待されるデータ型に変換する必要があるかどうかを指定します。void
setDatabase
(int index) 使用すべきではありません。3.2 以降、RedisStandaloneConfiguration
、RedisSocketConfiguration
、RedisSentinelConfiguration
、またはRedisStaticMasterReplicaConfiguration
を使用してデータベースインデックスを構成します。void
setEagerInitialization
(boolean eagerInitialization) shared connections
の先行初期化を有効にします。void
setEarlyStartup
(boolean earlyStartup) Bean が初期化されるときに、この InitializingBean のコンポーネントライフサイクルをafterPropertiesSet()
によって早期に開始するかどうかを構成します。void
setExecutor
(AsyncTaskExecutor executor) クラスター全体でコマンドを非同期に実行するために使用されるexecutor
を構成します。void
setHostName
(StringSE hostName) 使用すべきではありません。2.0 以降、RedisStandaloneConfiguration
を使用してホスト名を構成します。void
setPassword
(StringSE password) 使用すべきではありません。2.0 以降、RedisStandaloneConfiguration
、RedisSentinelConfiguration
、RedisClusterConfiguration
を使用してパスワードを構成します。void
setPhase
(int phase) このエグゼキュータを一時停止および再開するためのライフサイクルフェーズを指定します。void
setPipeliningFlushPolicy
(LettuceConnection.PipeliningFlushPolicy pipeliningFlushPolicy) パイプラインを使用する場合のフラッシュポリシーを構成します。void
setPort
(int port) 使用すべきではありません。2.0 以降、RedisStandaloneConfiguration
を使用してポートを構成します。void
setShareNativeConnection
(boolean shareNativeConnection) 複数のLettuceConnection
が単一のネイティブ接続を共有できるようにします。void
setShutdownTimeout
(long shutdownTimeout) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してシャットダウンタイムアウトを構成します。void
setStartTls
(boolean startTls) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用して StartTLS を構成します。void
setTimeout
(long timeout) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してタイムアウトを構成します。void
setUseSsl
(boolean useSsl) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用して SSL の使用を構成します。void
setValidateConnection
(boolean validateConnection) getConnection()
への呼び出しで共有ネイティブ Lettuce 接続の検証を有効にします。void
setVerifyPeer
(boolean verifyPeer) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してピア検証を構成します。void
start()
void
stop()
void
共有接続を検証し、無効な場合は再初期化します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
stop
コンストラクターの詳細
LettuceConnectionFactory
public LettuceConnectionFactory()デフォルト設定で新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
デフォルト設定で新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
指定されたRedisSocketConfiguration
を使用して新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
redisConfiguration
- null であってはなりません。- 導入:
- 2.1
LettuceConnectionFactory
public LettuceConnectionFactory(RedisConfiguration redisConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisStaticMasterReplicaConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
redisConfiguration
- null であってはなりません。clientConfiguration
- null であってはなりません。- 導入:
- 2.1
LettuceConnectionFactory
RedisClusterClient
を作成するために適用された特定のRedisClusterConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
clusterConfiguration
- null であってはなりません。- 導入:
- 1.7
LettuceConnectionFactory
public LettuceConnectionFactory(RedisClusterConfiguration clusterConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisClusterConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
clusterConfiguration
- null であってはなりません。clientConfiguration
- null であってはなりません。- 導入:
- 2.0
LettuceConnectionFactory
指定されたRedisSentinelConfiguration
を使用して新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
sentinelConfiguration
- null であってはなりません。- 導入:
- 1.6
LettuceConnectionFactory
public LettuceConnectionFactory(RedisSentinelConfiguration sentinelConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisSentinelConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
sentinelConfiguration
- null であってはなりません。clientConfiguration
- null であってはなりません。- 導入:
- 2.0
LettuceConnectionFactory
デフォルト設定で新しいLettuceConnectionFactory
インスタンスを構築します。LettuceConnectionFactory
public LettuceConnectionFactory(RedisStandaloneConfiguration standaloneConfiguration, LettuceClientConfiguration clientConfiguration) 指定されたRedisStandaloneConfiguration
およびLettuceClientConfiguration
を使用して、新しいLettuceConnectionFactory
インスタンスを構築します。- パラメーター:
standaloneConfiguration
- null であってはなりません。clientConfiguration
- null であってはなりません。- 導入:
- 2.0
メソッドの詳細
createRedisConfiguration
以下に従って、URI
SE に基づいてRedisConfiguration
を作成します。redisUri
に歩哨が含まれている場合、RedisSentinelConfiguration
が返されますredisUri
に構成済みのソケットがある場合、RedisSocketConfiguration
が返されます- それ以外の場合は、
RedisStandaloneConfiguration
が返されます
- パラメーター:
redisUri
-RedisURI
形式の接続 URI。- 戻り値:
- Redis URI を表す適切な
RedisConfiguration
インスタンス。 - 導入:
- 2.5.3
- 関連事項:
createRedisConfiguration
以下に従って、RedisURI
に基づいてRedisConfiguration
を作成します。RedisURI
に歩哨が含まれている場合、RedisSentinelConfiguration
が返されますRedisURI
に構成済みのソケットがある場合、RedisSocketConfiguration
が返されます- それ以外の場合は、
RedisStandaloneConfiguration
が返されます
- パラメーター:
redisUri
- 接続 URI。- 戻り値:
- Redis URI を表す適切な
RedisConfiguration
インスタンス。 - 導入:
- 2.5.3
- 関連事項:
RedisURI
setExecutor
クラスター全体でコマンドを非同期に実行するために使用されるexecutor
を構成します。- パラメーター:
executor
-executor
は、クラスター全体でコマンドを非同期に実行していました。- 導入:
- 3.2
getHostName
現在のホストを返します。- 戻り値:
- ザホスト。
setHostName
使用すべきではありません。2.0 以降、RedisStandaloneConfiguration
を使用してホスト名を構成します。ホスト名を設定します。- パラメーター:
hostName
- 設定するホスト名。
getPort
public int getPort()現在のポートを返します。- 戻り値:
- ポート。
setPort
使用すべきではありません。2.0 以降、RedisStandaloneConfiguration
を使用してポートを構成します。ポートを設定します。- パラメーター:
port
- 設定するポート。
setPipeliningFlushPolicy
パイプラインを使用する場合のフラッシュポリシーを構成します。設定されていない場合、デフォルトはflush on each command
です。- パラメーター:
pipeliningFlushPolicy
- コマンドが Redis 接続に書き込まれるタイミングを制御するためのフラッシュポリシー。- 導入:
- 2.3
- 関連事項:
LettuceConnection.openPipeline()
StatefulConnection.flushCommands()
getTimeout
public long getTimeout()接続タイムアウトを返します(ミリ秒単位)。- 戻り値:
- 接続タイムアウト。
setTimeout
使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してタイムアウトを構成します。接続タイムアウトを設定します(ミリ秒単位)。- パラメーター:
timeout
- タイムアウト。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。
isUseSsl
public boolean isUseSsl()SSL を使用するかどうかを返します。- 戻り値:
- SSL の使用。
setUseSsl
使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用して SSL の使用を構成します。SSL 接続を使用するように設定します。- パラメーター:
useSsl
- SSL を使用する場合は true。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。
isVerifyPeer
public boolean isVerifyPeer()SSL 使用時に証明書の有効性 / ホスト名チェックを検証するかどうかを返します。- 戻り値:
- SSL を使用するときにピアを検証するかどうか。
setVerifyPeer
使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してピア検証を構成します。SSL を使用する場合に、証明書の有効性の検証 / ホスト名チェックを使用するように設定します。- パラメーター:
verifyPeer
- ホスト名を確認しない場合は false。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。
isStartTls
public boolean isStartTls()StartTLS を発行するかどうかを返します。- 戻り値:
- StartTLS の使用。
setStartTls
使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用して StartTLS を構成します。StartTLS を発行するように設定します。- パラメーター:
startTls
- StartTLS を発行する場合は true。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。
getValidateConnection
public boolean getValidateConnection()ネイティブ Lettuce 接続の検証が有効になっているかどうかを示します。- 戻り値:
- 接続検証が有効になっています。
setValidateConnection
public void setValidateConnection(boolean validateConnection) getConnection()
への呼び出しで共有ネイティブ Lettuce 接続の検証を有効にします。検証が失敗した場合、新しい接続が作成されて使用されます。Lettuce は、close が呼び出されるまで自動的に再接続します。これは、共有ネイティブ接続が使用されている場合、
LettuceConnection
を介して発生することはないため、デフォルトは false です。これを true に設定すると、新しい接続ごとにサーバーへのラウンドトリップ呼び出しが発生するため、この設定は、接続の共有が有効で、ネイティブ Lettuce 接続をアクティブに閉じるコードがある場合にのみ使用する必要があります。
- パラメーター:
validateConnection
- 接続検証を有効にします。
getEagerInitialization
public boolean getEagerInitialization()shared connections
を積極的に初期化する必要があることを示します。積極的な初期化では、接続ファクトリ構成の早期検証を可能にするために、startup
中に実行中の Redis インスタンスが必要です。積極的な初期化は、リアクティブ API の使用中に接続がブロックされるのを防ぐため、リアクティブ API の使用に推奨されます。setEagerInitialization
public void setEagerInitialization(boolean eagerInitialization) shared connections
の先行初期化を有効にします。- パラメーター:
eagerInitialization
-afterPropertiesSet()
で先行した接続共有接続の初期化を有効にします。- 導入:
- 2.2
getDatabase
public int getDatabase()データベースのインデックスを返します。- 戻り値:
- データベースインデックス。
setDatabase
使用すべきではありません。3.2 以降、RedisStandaloneConfiguration
、RedisSocketConfiguration
、RedisSentinelConfiguration
、またはRedisStaticMasterReplicaConfiguration
を使用してデータベースインデックスを構成します。この接続ファクトリが使用するデータベースのインデックスを設定します。デフォルトは 0 です。- パラメーター:
index
- データベースインデックス。
getClientName
クライアント名を返します。- 戻り値:
- クライアント名。設定されていない場合は null。
- 導入:
- 2.1
setClientName
使用すべきではありません。LettuceClientConfiguration
を使用してクライアント名を構成します。この接続ファクトリが使用するクライアント名を設定します。- パラメーター:
clientName
- クライアント名。null にすることができます。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。- 導入:
- 2.1
getNativeClient
このインスタンスで使用されるネイティブAbstractRedisClient
を返します。クライアントはthe bean initialization lifecycle
の一部として初期化され、この接続ファクトリが初期化された場合にのみ使用できます。構成に応じて、クライアントは
RedisClient
またはRedisClusterClient
のいずれかになります。- 戻り値:
- ネイティブ
AbstractRedisClient
。初期化されていない場合は null になる可能性があります。 - 導入:
- 2.5
- 関連事項:
getRequiredNativeClient
public io.lettuce.core.AbstractRedisClient getRequiredNativeClient()このインスタンスで使用されるネイティブAbstractRedisClient
を返します。クライアントはthe bean initialization lifecycle
の一部として初期化され、この接続ファクトリが初期化された場合にのみ使用できます。まだ初期化されていない場合は、IllegalStateException
SE をスローします。構成に応じて、クライアントは
RedisClient
またはRedisClusterClient
のいずれかになります。- 戻り値:
- ネイティブ
AbstractRedisClient
。 - 例外:
IllegalStateExceptionSE
- まだ初期化されていない場合。- 導入:
- 2.5
- 関連事項:
getPassword
Redis サーバーでの認証に使用されるパスワードを返します。- 戻り値:
- 認証用のパスワード。設定されていない場合は null。
setPassword
使用すべきではありません。2.0 以降、RedisStandaloneConfiguration
、RedisSentinelConfiguration
、RedisClusterConfiguration
を使用してパスワードを構成します。Redis サーバーでの認証に使用するパスワードを設定します。- パラメーター:
password
- 設定するパスワード
getShutdownTimeout
public long getShutdownTimeout()RedisClient をシャットダウンするためのシャットダウンタイムアウトを返します(ミリ秒単位)。- 戻り値:
- シャットダウンタイムアウト。
- 導入:
- 1.6
setShutdownTimeout
使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してシャットダウンタイムアウトを構成します。RedisClient をシャットダウンするためのシャットダウンタイムアウトを設定します(ミリ秒単位)。- パラメーター:
shutdownTimeout
- シャットダウンタイムアウト。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。- 導入:
- 1.6
getClientResources
インフラストラクチャを再利用するためにClientResources
を取得します。- 戻り値:
- 設定されていない場合は null。
- 導入:
- 1.7
setClientResources
@DeprecatedSE public void setClientResources(io.lettuce.core.resource.ClientResources clientResources) 使用すべきではありません。2.0 以降、LettuceClientConfiguration
を使用してClientResources
を構成します。クライアントインフラストラクチャを再利用するようにClientResources
を設定します。
リソースを共有しない場合は null に設定します。- パラメーター:
clientResources
- null でもかまいません。- 例外:
IllegalStateExceptionSE
-LettuceClientConfiguration
が不変の場合。- 導入:
- 1.7
getClientConfiguration
- 戻り値:
LettuceClientConfiguration
- 導入:
- 2.0
getStandaloneConfiguration
- 戻り値:
RedisStandaloneConfiguration
- 導入:
- 2.0
getSocketConfiguration
- 戻り値:
RedisSocketConfiguration
または設定されていない場合は null。- 導入:
- 2.1
getSentinelConfiguration
- 戻り値:
RedisSentinelConfiguration
は null の可能性があります。- 導入:
- 2.0
getClusterConfiguration
- 戻り値:
RedisClusterConfiguration
は null の可能性があります。- 導入:
- 2.0
getPhase
public int getPhase()- 次で指定:
- インターフェース
Phased
のgetPhase
- 次で指定:
- インターフェース
SmartLifecycle
のgetPhase
setPhase
public void setPhase(int phase) このエグゼキュータを一時停止および再開するためのライフサイクルフェーズを指定します。デフォルトは0
です。- 導入:
- 3.2
- 関連事項:
isAutoStartup
public boolean isAutoStartup()- 次で指定:
- インターフェース
SmartLifecycle
のisAutoStartup
- 導入:
- 3.3
setAutoStartup
public void setAutoStartup(boolean autoStartup) コンテナーに含まれる ApplicationContext がリフレッシュされたときに、このライフサイクル接続ファクトリがコンテナーによって自動的に開始されるかどうかを構成します。この接続ファクトリは、デフォルトで
afterPropertiesSet()
中に早期自動起動に設定され、ライフサイクルの早い段階で Redis 接続を作成できる可能性があります。自動起動が有効になっている場合、接続の作成を ApplicationContext リフレッシュまで遅らせるには、setEarlyStartup(boolean)
を参照してください。- パラメーター:
autoStartup
- 接続ファクトリを自動的にstart()
する場合は true、それ以外の場合は false。- 導入:
- 3.3
- 関連事項:
isEarlyStartup
public boolean isEarlyStartup()- 戻り値:
afterPropertiesSet()
中にコンポーネントをstart()
するかどうか。- 導入:
- 3.3
setEarlyStartup
public void setEarlyStartup(boolean earlyStartup) Bean が初期化されるときに、この InitializingBean のコンポーネントライフサイクルをafterPropertiesSet()
によって早期に開始するかどうかを構成します。コンポーネントはデフォルトで自動起動になります。この方法は
auto-startup
に関連しており、ApplicationContext のリフレッシュまで Redis クライアントの起動を遅らせるために使用できます。早期起動を無効にしても、自動起動は無効になりません。- パラメーター:
earlyStartup
- コンポーネントを早期にstart()
する場合は true、それ以外の場合は false。- 導入:
- 3.3
- 関連事項:
getConvertPipelineAndTxResults
public boolean getConvertPipelineAndTxResults()パイプライン結果を予期されるデータ型に変換するかどうかを指定します。false
の場合、LettuceConnection.closePipeline()
および {LettuceConnection#exec()} の結果は、Lettuce ドライバーによって返される型になります。- 次で指定:
- インターフェース
RedisConnectionFactory
のgetConvertPipelineAndTxResults
- 戻り値:
true
パイプラインとトランザクションの結果を変換します。それ以外の場合はfalse
。
setConvertPipelineAndTxResults
public void setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults) パイプライン化されたトランザクション結果を予期されるデータ型に変換するかどうかを指定します。false
の場合、LettuceConnection.closePipeline()
および {LettuceConnection#exec()} の結果は、Lettuce ドライバーによって返される型になります。- パラメーター:
convertPipelineAndTxResults
- パイプラインとトランザクションの結果を変換するtrue
。それ以外の場合はfalse
。
isRedisSentinelAware
public boolean isRedisSentinelAware()- 戻り値:
RedisSentinelConfiguration
が存在する場合は true。- 導入:
- 1.5
isClusterAware
public boolean isClusterAware()- 戻り値:
RedisClusterConfiguration
が存在する場合は true。- 導入:
- 1.7
start
public void start()stop
public void stop()isRunning
public boolean isRunning()afterPropertiesSet
public void afterPropertiesSet()- 次で指定:
- インターフェース
InitializingBean
のafterPropertiesSet
destroy
public void destroy()- 次で指定:
- インターフェース
DisposableBean
のdestroy
getConnection
インターフェースからコピーされた説明:RedisConnectionFactory
Redis との対話に適したconnection
を返します。- 次で指定:
- インターフェース
RedisConnectionFactory
のgetConnection
- 戻り値:
- Redis と対話するための
connection
。
getClusterConnection
インターフェースからコピーされた説明:RedisConnectionFactory
Redis クラスターとの対話に適したconnection
を返します。- 次で指定:
- インターフェース
RedisConnectionFactory
のgetClusterConnection
- 戻り値:
- Redis クラスターと対話するための
connection
。
getSentinelConnection
インターフェースからコピーされた説明:RedisConnectionFactory
Redis Sentinel との対話に適したconnection
を返します。- 次で指定:
- インターフェース
RedisConnectionFactory
のgetSentinelConnection
- 戻り値:
- Redis Sentinel と対話するための
connection
。
doCreateLettuceConnection
protected LettuceConnection doCreateLettuceConnection(@Nullable io.lettuce.core.api.StatefulRedisConnection<byte[], byte[]> sharedConnection, LettuceConnectionProvider connectionProvider, long timeout, int database) LettuceConnection
作成用のカスタマイズフック。- パラメーター:
sharedConnection
-getShareNativeConnection()
が true の場合、共有StatefulRedisConnection
。それ以外の場合は null。connectionProvider
- 接続を解放するLettuceConnectionProvider
。timeout
-TimeUnit.MILLISECONDS
SE でのコマンドタイムアウト。database
- 操作するデータベースインデックス。- 戻り値:
LettuceConnection
- 例外:
IllegalArgumentExceptionSE
- 必須パラメーターが null の場合。- 導入:
- 2.2
doCreateLettuceClusterConnection
protected LettuceClusterConnection doCreateLettuceClusterConnection(@Nullable io.lettuce.core.cluster.api.StatefulRedisClusterConnection<byte[], byte[]> sharedConnection, LettuceConnectionProvider connectionProvider, ClusterTopologyProvider topologyProvider, ClusterCommandExecutor clusterCommandExecutor, DurationSE commandTimeout) LettuceClusterConnection
作成用のカスタマイズフック。- パラメーター:
sharedConnection
-getShareNativeConnection()
が true の場合、共有StatefulRedisConnection
。それ以外の場合は null。connectionProvider
- 接続を解放するLettuceConnectionProvider
。topologyProvider
-ClusterTopologyProvider
clusterCommandExecutor
- 接続を解放するClusterCommandExecutor
。commandTimeout
- コマンドタイムアウトDuration
SE。- 戻り値:
LettuceConnection
- 例外:
IllegalArgumentExceptionSE
- 必須パラメーターが null の場合。- 導入:
- 2.2
getReactiveConnection
public org.springframework.data.redis.connection.lettuce.LettuceReactiveRedisConnection getReactiveConnection()- 次で指定:
- インターフェース
ReactiveRedisConnectionFactory
のgetReactiveConnection
- 戻り値:
- リアクティブ Redis 接続。
getReactiveClusterConnection
public org.springframework.data.redis.connection.lettuce.LettuceReactiveRedisClusterConnection getReactiveClusterConnection()- 次で指定:
- インターフェース
ReactiveRedisConnectionFactory
のgetReactiveClusterConnection
- 戻り値:
- リアクティブ Redis クラスター接続。
initConnection
public void initConnection()native connection sharing
が有効になっている場合は共有接続を初期化し、既存の接続をリセットします。resetConnection
public void resetConnection()基礎となる共有接続をリセットして、次のアクセスで再初期化します。validateConnection
public void validateConnection()共有接続を検証し、無効な場合は再初期化します。translateExceptionIfPossible
- 次で指定:
- インターフェース
PersistenceExceptionTranslator
のtranslateExceptionIfPossible
doCreateConnectionProvider
protected LettuceConnectionProvider doCreateConnectionProvider(io.lettuce.core.AbstractRedisClient client, io.lettuce.core.codec.RedisCodec<?, ?> codec) AbstractRedisClient
およびRedisCodec
を指定してLettuceConnectionProvider
を作成します。この接続ファクトリの構成は、作成された接続プロバイダーの型を指定します。このメソッドは、RedisClient
またはRedisClusterClient
のいずれかのLettuceConnectionProvider
を作成します。サブクラスは、このメソッドをオーバーライドして、接続プロバイダーを装飾する場合があります。- パラメーター:
client
-RedisClient
またはRedisClusterClient
のいずれかを null にすることはできません。codec
- 接続の作成に使用されます。null であってはなりません。デフォルトでは、byte[]
コーデック。リアクティブ接続にはByteBuffer
SE コーデックが必要です。- 戻り値:
- 接続プロバイダー。
- 導入:
- 2.1
createClient
protected io.lettuce.core.AbstractRedisClient createClient()
LettuceClientConfiguration
を使用してクライアント名を構成します。