Add 'client-name' property to specify a Redis client name.

gh-17315

Author: nosan

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/JedisConnectionConfiguration.java

@@ -87,13 +87,17 @@ private JedisClientConfiguration getJedisClientConfiguration(
 	}
 
 	private JedisClientConfigurationBuilder applyProperties(JedisClientConfigurationBuilder builder) {
-		if (getProperties().isSsl()) {
+		RedisProperties properties = getProperties();
+		if (properties.isSsl()) {
 			builder.useSsl();
 		}
-		if (getProperties().getTimeout() != null) {
-			Duration timeout = getProperties().getTimeout();
+		if (properties.getTimeout() != null) {
+			Duration timeout = properties.getTimeout();
 			builder.readTimeout(timeout).connectTimeout(timeout);
 		}
+		if (StringUtils.hasText(properties.getClientName())) {
+			builder.clientName(properties.getClientName());
+		}
 		return builder;
 	}
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceConnectionConfiguration.java

@@ -102,18 +102,22 @@ private LettuceClientConfigurationBuilder createBuilder(Pool pool) {
 
 	private LettuceClientConfigurationBuilder applyProperties(
 			LettuceClientConfiguration.LettuceClientConfigurationBuilder builder) {
-		if (getProperties().isSsl()) {
+		RedisProperties properties = getProperties();
+		if (properties.isSsl()) {
 			builder.useSsl();
 		}
-		if (getProperties().getTimeout() != null) {
-			builder.commandTimeout(getProperties().getTimeout());
+		if (properties.getTimeout() != null) {
+			builder.commandTimeout(properties.getTimeout());
 		}
-		if (getProperties().getLettuce() != null) {
-			RedisProperties.Lettuce lettuce = getProperties().getLettuce();
+		if (properties.getLettuce() != null) {
+			RedisProperties.Lettuce lettuce = properties.getLettuce();
 			if (lettuce.getShutdownTimeout() != null && !lettuce.getShutdownTimeout().isZero()) {
-				builder.shutdownTimeout(getProperties().getLettuce().getShutdownTimeout());
+				builder.shutdownTimeout(properties.getLettuce().getShutdownTimeout());
 			}
 		}
+		if (StringUtils.hasText(properties.getClientName())) {
+			builder.clientName(properties.getClientName());
+		}
 		return builder;
 	}
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java

@@ -70,6 +70,11 @@ public class RedisProperties {
 	 */
 	private Duration timeout;
 
+	/**
+	 * Configure a clientName to be set with CLIENT SETNAME.
+	 */
+	private String clientName;
+
 	private Sentinel sentinel;
 
 	private Cluster cluster;
@@ -134,6 +139,14 @@ public Duration getTimeout() {
 		return this.timeout;
 	}
 
+	public String getClientName() {
+		return this.clientName;
+	}
+
+	public void setClientName(String clientName) {
+		this.clientName = clientName;
+	}
+
 	public Sentinel getSentinel() {
 		return this.sentinel;
 	}

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/redis/RedisAutoConfigurationJedisTests.java

@@ -134,6 +134,16 @@ public void testRedisConfigurationWithTimeout() {
 		});
 	}
 
+	@Test
+	public void testRedisConfigurationWithClientName() {
+		this.contextRunner.withPropertyValues("spring.redis.host:foo", "spring.redis.client-name:spring-boot")
+				.run((context) -> {
+					JedisConnectionFactory cf = context.getBean(JedisConnectionFactory.class);
+					assertThat(cf.getHostName()).isEqualTo("foo");
+					assertThat(cf.getClientName()).isEqualTo("spring-boot");
+				});
+	}
+
 	@Test
 	public void testRedisConfigurationWithSentinel() {
 		this.contextRunner

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/data/redis/RedisAutoConfigurationTests.java

@@ -30,6 +30,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.redis.connection.RedisClusterConfiguration;
 import org.springframework.data.redis.connection.RedisNode;
+import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
 import org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder;
 import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
 import org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration;
@@ -160,6 +161,16 @@ void testRedisConfigurationWithTimeout() {
 		});
 	}
 
+	@Test
+	void testRedisConfigurationWithClientName() {
+		this.contextRunner.withPropertyValues("spring.redis.host:foo", "spring.redis.client-name:spring-boot")
+				.run((context) -> {
+					JedisConnectionFactory cf = context.getBean(JedisConnectionFactory.class);
+					assertThat(cf.getHostName()).isEqualTo("foo");
+					assertThat(cf.getClientName()).isEqualTo("spring-boot");
+				});
+	}
+
 	@Test
 	void testRedisConfigurationWithSentinel() {
 		List<String> sentinels = Arrays.asList("127.0.0.1:26379", "127.0.0.1:26380");