Implemented read-write separation based on JedisSentineled

pom.xml

@@ -219,6 +219,12 @@
 			<version>${resilience4j.version}</version>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.powermock</groupId>
+			<artifactId>powermock-module-junit4</artifactId>
+			<version>2.0.2</version>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>io.github.resilience4j</groupId>
 			<artifactId>resilience4j-circuitbreaker</artifactId>
@@ -546,6 +552,7 @@
 						<include>**/*CommandFlags*.java</include>
 						<include>**/*CompareCondition*.java</include>
 						<include>**/*MSetExParams*.java</include>
+						<include>src/main/java/redis/clients/jedis/util/ReadOnlyCommands.java</include>
 						<include>**/*UnitTest.java</include>
 					</includes>
 				</configuration>

src/main/java/redis/clients/jedis/JedisSentineled.java

@@ -1,6 +1,5 @@
 package redis.clients.jedis;
 
-import java.util.Set;
 import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
 import redis.clients.jedis.annots.Experimental;
 import redis.clients.jedis.builders.SentinelClientBuilder;
@@ -11,6 +10,8 @@
 import redis.clients.jedis.providers.ConnectionProvider;
 import redis.clients.jedis.providers.SentineledConnectionProvider;
 
+import java.util.Set;
+
 public class JedisSentineled extends UnifiedJedis {
 
   public JedisSentineled(String masterName, final JedisClientConfig masterClientConfig,
@@ -40,6 +41,21 @@ public JedisSentineled(String masterName, final JedisClientConfig masterClientCo
         masterClientConfig.getRedisProtocol());
   }
 
+  public JedisSentineled(String masterName, final JedisClientConfig masterClientConfig,
+                         final GenericObjectPoolConfig<Connection> poolConfig,
+                         Set<HostAndPort> sentinels, final JedisClientConfig sentinelClientConfig, ReadFrom readFrom) {
+    super(new SentineledConnectionProvider(masterName, masterClientConfig, poolConfig, sentinels, sentinelClientConfig, readFrom),
+            masterClientConfig.getRedisProtocol());
+  }
+
+  public JedisSentineled(String masterName, final JedisClientConfig masterClientConfig,
+                         final GenericObjectPoolConfig<Connection> poolConfig,
+                         Set<HostAndPort> sentinels, final JedisClientConfig sentinelClientConfig, ReadFrom readFrom,
+                         ReadOnlyPredicate readOnlyPredicate) {
+    super(new SentineledConnectionProvider(masterName, masterClientConfig, poolConfig, sentinels, sentinelClientConfig, readFrom, readOnlyPredicate),
+            masterClientConfig.getRedisProtocol());
+  }
+
   @Experimental
   public JedisSentineled(String masterName, final JedisClientConfig masterClientConfig, Cache clientSideCache,
       final GenericObjectPoolConfig<Connection> poolConfig,

src/main/java/redis/clients/jedis/ReadFrom.java

@@ -0,0 +1,12 @@
+package redis.clients.jedis;
+
+public enum ReadFrom {
+  // read from the upstream only.
+  UPSTREAM,
+  // read from the replica only.
+  REPLICA,
+  // read preferred from the upstream and fall back to a replica if the upstream is not available.
+  UPSTREAM_PREFERRED,
+  // read preferred from replica and fall back to upstream if no replica is not available.
+  REPLICA_PREFERRED
+}

src/main/java/redis/clients/jedis/ReadOnlyPredicate.java

@@ -0,0 +1,11 @@
+package redis.clients.jedis;
+
+@FunctionalInterface
+public interface ReadOnlyPredicate {
+
+  /**
+   * @param command the input command.
+   * @return {@code true} if the input argument matches the predicate, otherwise {@code false}
+   */
+  boolean isReadOnly(CommandArguments command);
+}

src/main/java/redis/clients/jedis/StaticReadOnlyPredicate.java

@@ -0,0 +1,16 @@
+package redis.clients.jedis;
+
+public class StaticReadOnlyPredicate implements ReadOnlyPredicate {
+
+  private static final StaticReadOnlyPredicate REGISTRY = new StaticReadOnlyPredicate();
+
+  private StaticReadOnlyPredicate(){}
+
+  public static StaticReadOnlyPredicate registry() {
+    return REGISTRY;
+  }
+
+  public boolean isReadOnly(CommandArguments command) {
+    return StaticCommandFlagsRegistry.registry().getFlags(command).contains(CommandFlagsRegistry.CommandFlag.READONLY);
+  }
+}

src/main/java/redis/clients/jedis/builders/SentinelClientBuilder.java

@@ -1,10 +1,16 @@
 package redis.clients.jedis.builders;
 
-import java.util.Set;
-import redis.clients.jedis.*;
+import redis.clients.jedis.DefaultJedisClientConfig;
+import redis.clients.jedis.HostAndPort;
+import redis.clients.jedis.JedisClientConfig;
+import redis.clients.jedis.ReadFrom;
+import redis.clients.jedis.ReadOnlyPredicate;
+import redis.clients.jedis.StaticReadOnlyPredicate;
 import redis.clients.jedis.providers.ConnectionProvider;
 import redis.clients.jedis.providers.SentineledConnectionProvider;
 
+import java.util.Set;
+
 /**
  * Builder for creating JedisSentineled instances (Redis Sentinel connections).
  * <p>
@@ -21,6 +27,10 @@ public abstract class SentinelClientBuilder<C>
   private Set<HostAndPort> sentinels = null;
   private JedisClientConfig sentinelClientConfig = null;
 
+  private ReadFrom readFrom = ReadFrom.UPSTREAM;
+
+  private ReadOnlyPredicate readOnlyPredicate = StaticReadOnlyPredicate.registry();
+
   /**
    * Sets the master name for the Redis Sentinel configuration.
    * <p>
@@ -47,6 +57,33 @@ public SentinelClientBuilder<C> sentinels(Set<HostAndPort> sentinels) {
     return this;
   }
 
+  /**
+   * Sets the readFrom.
+   * <p>
+   * It is used to specify the policy preference of which nodes the client should read data from. It
+   * defines which type of node the client should prioritize reading data from when there are
+   * multiple Redis instances (such as master nodes and slave nodes) available in the Redis Sentinel
+   * environment.
+   * @param readFrom the read preferences
+   * @return this builder
+   */
+  public SentinelClientBuilder<C> readForm(ReadFrom readFrom) {
+    this.readFrom = readFrom;
+    return this;
+  }
+
+  /**
+   * Sets the readOnlyPredicate.
+   * <p>
+   * Check a Redis command is a read request.
+   * @param readOnlyPredicate
+   * @return this builder
+   */
+  public SentinelClientBuilder<C> readOnlyPredicate(ReadOnlyPredicate readOnlyPredicate) {
+    this.readOnlyPredicate = readOnlyPredicate;
+    return this;
+  }
+
   /**
    * Sets the client configuration for Sentinel connections.
    * <p>
@@ -68,7 +105,8 @@ protected SentinelClientBuilder<C> self() {
   @Override
   protected ConnectionProvider createDefaultConnectionProvider() {
     return new SentineledConnectionProvider(this.masterName, this.clientConfig, this.cache,
-        this.poolConfig, this.sentinels, this.sentinelClientConfig);
+        this.poolConfig, this.sentinels, this.sentinelClientConfig, this.readFrom,
+        this.readOnlyPredicate);
   }
 
   @Override