public class RedisCommandFactory extends Object
This class is the entry point to implement command interfaces and obtain a reference to the implementation. Redis Command
interfaces provide a dynamic API that are declared in userland code. RedisCommandFactory
and its supportive classes
analyze method declarations and derive from those factories to create and execute RedisCommand
s.
public interface MyRedisCommands extends Commands { String get(String key); // Synchronous Execution of GET @Command("GET") byte[] getAsBytes(String key); // Synchronous Execution of GET returning data as byte array @Command("SET") // synchronous execution applying a Timeout String setSync(String key, String value, Timeout timeout); Future<String> set(String key, String value); // asynchronous SET execution @Command("SET") Mono<String> setReactive(String key, String value, SetArgs setArgs); // reactive SET execution using SetArgs @CommandNaming(split = DOT) // support for Redis Module command notation -> NR.RUN double nrRun(String key, int... indexes); } RedisCommandFactory factory = new RedisCommandFactory(connection); MyRedisCommands commands = factory.getCommands(MyRedisCommands.class); String value = commands.get("key");
Command
,
CommandMethod
Constructor and Description |
---|
RedisCommandFactory(StatefulConnection<?,?> connection)
Create a new
CommandFactory given StatefulConnection . |
RedisCommandFactory(StatefulConnection<?,?> connection,
Iterable<? extends RedisCodec<?,?>> redisCodecs)
|
Modifier and Type | Method and Description |
---|---|
<T extends Commands> |
getCommands(Class<T> commandInterface)
Returns a Redis Commands interface instance for the given interface.
|
void |
setCommandOutputFactoryResolver(CommandOutputFactoryResolver commandOutputFactoryResolver)
Set a
CommandOutputFactoryResolver . |
void |
setVerifyCommandMethods(boolean verifyCommandMethods)
Enables/disables command verification which checks the command name against Redis
COMMAND and the argument count. |
public RedisCommandFactory(StatefulConnection<?,?> connection)
CommandFactory
given StatefulConnection
.connection
- must not be null
.public RedisCommandFactory(StatefulConnection<?,?> connection, Iterable<? extends RedisCodec<?,?>> redisCodecs)
connection
- must not be null
.redisCodecs
- must not be null
.public void setCommandOutputFactoryResolver(CommandOutputFactoryResolver commandOutputFactoryResolver)
CommandOutputFactoryResolver
.commandOutputFactoryResolver
- must not be null
.public void setVerifyCommandMethods(boolean verifyCommandMethods)
COMMAND
and the argument count.verifyCommandMethods
- true
to enable command verification (default) or false
to disable command
verification.Copyright © 2021 lettuce.io. All rights reserved.