Spring/spring-data-redis
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polishing.

Browse Source 
Introduce factory method overload accepting the default port so that Sentinel uses the right port.
Refine tests. Refine Javadoc.

See #2928
Original pull request: #3002
This commit is contained in:
Mark Paluch
2024-10-10 15:01:41 +02:00
parent 047e63ea78
commit 20ceb4cf05
6 changed files with 90 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java
View File

@@ -62,11 +62,9 @@ public class RedisClusterConfiguration implements RedisConfiguration, ClusterCon
/**
* Creates a new {@link RedisClusterConfiguration} for given {@link String hostPort} combinations.
*
* <pre>
* <code>
* <pre class="code">
* clusterHostAndPorts[0] = 127.0.0.1:23679
* clusterHostAndPorts[1] = 127.0.0.1:23680 ...
* </code>
* </pre>
*
* @param clusterNodes must not be {@literal null}.

41
src/main/java/org/springframework/data/redis/connection/RedisNode.java
View File

@@ -29,7 +29,8 @@ import org.springframework.util.StringUtils;
*/
public class RedisNode implements NamedNode {
private static final int DEFAULT_PORT = 6379;
public static final int DEFAULT_PORT = 6379;
public static final int DEFAULT_SENTINEL_PORT = 26379;
@Nullable String id;
@Nullable String name;
@@ -69,8 +70,11 @@ public class RedisNode implements NamedNode {
* the port. For example:
*
* <pre class="code">
* RedisNode.fromString("127.0.0.1");
* RedisNode.fromString("127.0.0.1:6379");
* RedisNode.fromString("[aaaa:bbbb::dddd:eeee]");
* RedisNode.fromString("[aaaa:bbbb::dddd:eeee]:6379");
* RedisNode.fromString("my.redis.server");
* RedisNode.fromString("my.redis.server:6379");
* </pre>
*
@@ -79,6 +83,27 @@ public class RedisNode implements NamedNode {
* @since 2.7.4
*/
public static RedisNode fromString(String hostPortString) {
return fromString(hostPortString, DEFAULT_PORT);
}
/**
* Parse a {@code hostAndPort} string into {@link RedisNode}. Supports IPv4, IPv6, and hostname notations including
* the port. For example:
*
* <pre class="code">
* RedisNode.fromString("127.0.0.1");
* RedisNode.fromString("127.0.0.1:6379");
* RedisNode.fromString("[aaaa:bbbb::dddd:eeee]");
* RedisNode.fromString("[aaaa:bbbb::dddd:eeee]:6379");
* RedisNode.fromString("my.redis.server");
* RedisNode.fromString("my.redis.server:6379");
* </pre>
*
* @param hostPortString must not be {@literal null} or empty.
* @return the parsed {@link RedisNode}.
* @since 3.4
*/
public static RedisNode fromString(String hostPortString, int defaultPort) {
Assert.notNull(hostPortString, "HostAndPort must not be null");
@@ -106,16 +131,18 @@ public class RedisNode implements NamedNode {
} else {
// bare hostname
host = hostPortString;
portString = Integer.toString(DEFAULT_PORT);
}
}
}
int port = -1;
try {
port = Integer.parseInt(portString);
} catch (RuntimeException ignore) {
throw new IllegalArgumentException("Unparseable port number: %s".formatted(hostPortString));
int port = defaultPort;
if (StringUtils.hasText(portString)) {
try {
port = Integer.parseInt(portString);
} catch (RuntimeException ignore) {
throw new IllegalArgumentException("Unparseable port number: %s".formatted(hostPortString));
}
}
if (!isValidPort(port)) {

11
src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java
View File

@@ -77,8 +77,9 @@ public class RedisSentinelConfiguration implements RedisConfiguration, SentinelC
/**
* Creates a new {@link RedisSentinelConfiguration} for given {@link String hostPort} combinations.
*
* <pre>
* sentinelHostAndPorts[0] = 127.0.0.1:23679 sentinelHostAndPorts[1] = 127.0.0.1:23680 ...
* <pre class="code">
* sentinelHostAndPorts[0] = 127.0.0.1:23679
* sentinelHostAndPorts[1] = 127.0.0.1:23680 ...
* </pre>
*
* @param sentinelHostAndPorts must not be {@literal null}.
@@ -92,11 +93,9 @@ public class RedisSentinelConfiguration implements RedisConfiguration, SentinelC
* Creates a new {@link RedisSentinelConfiguration} looking up configuration values from the given
* {@link PropertySource}.
*
* <pre>
* <code>
* <pre class="code">
* spring.redis.sentinel.master=myMaster
* spring.redis.sentinel.nodes=127.0.0.1:23679,127.0.0.1:23680,127.0.0.1:23681
* </code>
* </pre>
*
* @param propertySource must not be {@literal null}.
@@ -254,7 +253,7 @@ public class RedisSentinelConfiguration implements RedisConfiguration, SentinelC
private void appendSentinels(Set<String> hostAndPorts) {
for (String hostAndPort : hostAndPorts) {
addSentinel(RedisNode.fromString(hostAndPort));
addSentinel(RedisNode.fromString(hostAndPort, RedisNode.DEFAULT_SENTINEL_PORT));
}
}