org.springframework.data.redis.core.script

Class DefaultReactiveScriptExecutor<K>

java.lang.Object

org.springframework.data.redis.core.script.DefaultReactiveScriptExecutor<K>

Type Parameters:

K - The type of keys that may be passed during script execution

All Implemented Interfaces:

ReactiveScriptExecutor<K>

public class DefaultReactiveScriptExecutor<K>
extends Object
implements ReactiveScriptExecutor<K>

Default implementation of ReactiveScriptExecutor. Optimizes performance by attempting to execute script first using EVALSHA, then falling back to EVAL if Redis has not yet cached the script.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
DefaultReactiveScriptExecutor(ReactiveRedisConnectionFactory connectionFactory, RedisSerializationContext<K,?> serializationContext) Creates a new DefaultReactiveScriptExecutor given ReactiveRedisConnectionFactory and RedisSerializationContext.

Method Summary

Modifier and Type	Method and Description
protected <T> reactor.core.publisher.Flux<T>	deserializeResult(RedisElementReader<T> reader, reactor.core.publisher.Flux<T> result)
protected <T> reactor.core.publisher.Flux<T>	eval(ReactiveRedisConnection connection, RedisScript<T> script, ReturnType returnType, int numKeys, ByteBuffer[] keysAndArgs, RedisElementReader<T> resultReader)
<T> reactor.core.publisher.Flux<T>	execute(RedisScript<T> script, List<K> keys, List<?> args) Executes the given RedisScript
<T> reactor.core.publisher.Flux<T>	execute(RedisScript<T> script, List<K> keys, List<?> args, RedisElementWriter<?> argsWriter, RedisElementReader<T> resultReader) Executes the given RedisScript, using the provided RedisSerializers to serialize the script arguments and result.
ReactiveRedisConnectionFactory	getConnectionFactory()
protected ByteBuffer[]	keysAndArgs(RedisElementWriter argsWriter, List<K> keys, List<?> args)
protected RedisSerializationContext.SerializationPair<K>	keySerializer()
protected ByteBuffer	scriptBytes(RedisScript<?> script)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.redis.core.script.ReactiveScriptExecutor

execute, execute

Constructor Detail

DefaultReactiveScriptExecutor

public DefaultReactiveScriptExecutor(ReactiveRedisConnectionFactory connectionFactory,
                                     RedisSerializationContext<K,?> serializationContext)

Creates a new DefaultReactiveScriptExecutor given ReactiveRedisConnectionFactory and RedisSerializationContext.

Parameters:

connectionFactory - must not be null.

serializationContext - must not be null.

Method Detail

execute

public <T> reactor.core.publisher.Flux<T> execute(RedisScript<T> script,
                                                  List<K> keys,
                                                  List<?> args)

Description copied from interface: ReactiveScriptExecutor

Executes the given RedisScript

Specified by:

execute in interface ReactiveScriptExecutor<K>

Parameters:

script - The script to execute. Must not be null.

keys - Any keys that need to be passed to the script. Must not be null.

args - Any args that need to be passed to the script. Can be empty.

Returns:

The return value of the script or Flux.empty() if RedisScript.getResultType() is null, likely indicating a throw-away status reply (i.e. "OK")

execute

public <T> reactor.core.publisher.Flux<T> execute(RedisScript<T> script,
                                                  List<K> keys,
                                                  List<?> args,
                                                  RedisElementWriter<?> argsWriter,
                                                  RedisElementReader<T> resultReader)

Description copied from interface: ReactiveScriptExecutor

Executes the given RedisScript, using the provided RedisSerializers to serialize the script arguments and result.

Specified by:

execute in interface ReactiveScriptExecutor<K>

Parameters:

script - The script to execute. must not be null.

keys - Any keys that need to be passed to the script

args - Any args that need to be passed to the script

argsWriter - The RedisElementWriter to use for serializing args. Must not be null.

resultReader - The RedisElementReader to use for serializing the script return value. Must not be null.

Returns:

The return value of the script or Flux.empty() if RedisScript.getResultType() is null, likely indicating a throw-away status reply (i.e. "OK")

eval

protected <T> reactor.core.publisher.Flux<T> eval(ReactiveRedisConnection connection,
                                                  RedisScript<T> script,
                                                  ReturnType returnType,
                                                  int numKeys,
                                                  ByteBuffer[] keysAndArgs,
                                                  RedisElementReader<T> resultReader)

keysAndArgs

protected ByteBuffer[] keysAndArgs(RedisElementWriter argsWriter,
                                   List<K> keys,
                                   List<?> args)

scriptBytes

protected ByteBuffer scriptBytes(RedisScript<?> script)

Parameters:

script -

Returns:

deserializeResult

protected <T> reactor.core.publisher.Flux<T> deserializeResult(RedisElementReader<T> reader,
                                                               reactor.core.publisher.Flux<T> result)

keySerializer

protected RedisSerializationContext.SerializationPair<K> keySerializer()

getConnectionFactory

public ReactiveRedisConnectionFactory getConnectionFactory()