Add lettuce Redis driver autoconfiguration.

Introduce an alternative autoconfiguration if the lettuce Redis driver is available. Add lettuce-specific configuration property options "spring.redis.lettuce.shutdown-timeout" to control the shutdown timeout of the lettuce driver. Add documentation for the properties, the supported drivers, and how to switch between drivers.

Jedis stays the default driver even if both libraries are on the class path.

Author: mp911de

spring-boot-actuator/pom.xml

@@ -243,6 +243,11 @@
 			<artifactId>jedis</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>biz.paluch.redis</groupId>
+			<artifactId>lettuce</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.amqp</groupId>
 			<artifactId>spring-rabbit</artifactId>

spring-boot-autoconfigure/pom.xml

@@ -411,6 +411,11 @@
 			<artifactId>jedis</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>biz.paluch.redis</groupId>
+			<artifactId>lettuce</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.liquibase</groupId>
 			<artifactId>liquibase-core</artifactId>

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

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2012-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.autoconfigure.data.redis;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Configuration properties for the lettuce Redis driver.
+ *
+ * @author Mark Paluch
+ */
+@ConfigurationProperties(prefix = "spring.redis.lettuce")
+class LettuceRedisProperties {
+
+	/**
+	 * Shutdown timeout in milliseconds for lettuce.
+	 */
+	private int shutdownTimeout = 2000;
+
+	public int getShutdownTimeout() {
+		return this.shutdownTimeout;
+	}
+
+	public void setShutdownTimeout(int shutdownTimeout) {
+		this.shutdownTimeout = shutdownTimeout;
+	}
+}

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

@@ -20,6 +20,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import com.lambdaworks.redis.RedisClient;
 import org.apache.commons.pool2.impl.GenericObjectPool;
 import redis.clients.jedis.Jedis;
 import redis.clients.jedis.JedisPoolConfig;
@@ -40,6 +41,8 @@
 import org.springframework.data.redis.connection.RedisSentinelConfiguration;
 import org.springframework.data.redis.connection.jedis.JedisConnection;
 import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
+import org.springframework.data.redis.connection.lettuce.LettuceConnection;
+import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
 import org.springframework.data.redis.core.RedisOperations;
 import org.springframework.data.redis.core.RedisTemplate;
 import org.springframework.data.redis.core.StringRedisTemplate;
@@ -55,9 +58,10 @@
  * @author Christoph Strobl
  * @author Phillip Webb
  * @author Eddú Meléndez
+ * @author Mark Paluch
  */
 @Configuration
-@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
+@ConditionalOnClass({ RedisOperations.class })
 @EnableConfigurationProperties
 public class RedisAutoConfiguration {
 
@@ -67,6 +71,12 @@ public RedisProperties redisProperties() {
 		return new RedisProperties();
 	}
 
+	@Bean(name = "org.springframework.autoconfigure.redis.LettuceRedisProperties")
+	@ConditionalOnMissingBean
+	public LettuceRedisProperties lettuceRedisProperties() {
+		return new LettuceRedisProperties();
+	}
+
 	/**
 	 * Base class for Redis configurations.
 	 */
@@ -81,20 +91,6 @@ protected static abstract class AbstractRedisConfiguration {
 		@Autowired(required = false)
 		private RedisClusterConfiguration clusterConfiguration;
 
-		protected final JedisConnectionFactory applyProperties(
-				JedisConnectionFactory factory) {
-			factory.setHostName(this.properties.getHost());
-			factory.setPort(this.properties.getPort());
-			if (this.properties.getPassword() != null) {
-				factory.setPassword(this.properties.getPassword());
-			}
-			factory.setDatabase(this.properties.getDatabase());
-			if (this.properties.getTimeout() > 0) {
-				factory.setTimeout(this.properties.getTimeout());
-			}
-			return factory;
-		}
-
 		protected final RedisSentinelConfiguration getSentinelConfig() {
 			if (this.sentinelConfiguration != null) {
 				return this.sentinelConfiguration;
@@ -146,16 +142,41 @@ private List<RedisNode> createSentinels(Sentinel sentinel) {
 			}
 			return nodes;
 		}
+	}
+
+	/**
+	 * Base class for Redis configurations using the Jedis driver.
+	 */
+	protected static abstract class AbstractJedisRedisConfiguration
+			extends AbstractRedisConfiguration {
+
+		@Autowired
+		protected RedisProperties properties;
+
+		protected final JedisConnectionFactory applyProperties(
+				JedisConnectionFactory factory) {
+			factory.setHostName(this.properties.getHost());
+			factory.setPort(this.properties.getPort());
+			if (this.properties.getPassword() != null) {
+				factory.setPassword(this.properties.getPassword());
+			}
+			factory.setDatabase(this.properties.getDatabase());
+			if (this.properties.getTimeout() > 0) {
+				factory.setTimeout(this.properties.getTimeout());
+			}
+			return factory;
+		}
 
 	}
 
 	/**
 	 * Redis connection configuration.
 	 */
 	@Configuration
+	@ConditionalOnClass({ JedisConnection.class, Jedis.class })
 	@ConditionalOnMissingClass("org.apache.commons.pool2.impl.GenericObjectPool")
-	protected static class RedisConnectionConfiguration
-			extends AbstractRedisConfiguration {
+	protected static class JedisRedisConnectionConfiguration
+			extends AbstractJedisRedisConfiguration {
 
 		@Bean
 		@ConditionalOnMissingBean(RedisConnectionFactory.class)
@@ -179,9 +200,9 @@ private JedisConnectionFactory createJedisConnectionFactory() {
 	 * Redis pooled connection configuration.
 	 */
 	@Configuration
-	@ConditionalOnClass(GenericObjectPool.class)
-	protected static class RedisPooledConnectionConfiguration
-			extends AbstractRedisConfiguration {
+	@ConditionalOnClass({ GenericObjectPool.class, JedisConnection.class, Jedis.class })
+	protected static class JedisRedisPooledConnectionConfiguration
+			extends AbstractJedisRedisConfiguration {
 
 		@Bean
 		@ConditionalOnMissingBean(RedisConnectionFactory.class)
@@ -215,6 +236,60 @@ private JedisPoolConfig jedisPoolConfig() {
 
 	}
 
+	/**
+	 * Base class for Redis configurations using the Jedis driver.
+	 */
+	protected static abstract class AbstractLettuceRedisConfiguration
+			extends AbstractRedisConfiguration {
+
+		@Autowired
+		protected LettuceRedisProperties lettuceRedisProperties;
+
+		protected final LettuceConnectionFactory applyProperties(
+				LettuceConnectionFactory factory) {
+			factory.setHostName(this.properties.getHost());
+			factory.setPort(this.properties.getPort());
+			if (this.properties.getPassword() != null) {
+				factory.setPassword(this.properties.getPassword());
+			}
+			factory.setDatabase(this.properties.getDatabase());
+			if (this.properties.getTimeout() > 0) {
+				factory.setTimeout(this.properties.getTimeout());
+			}
+			if (this.lettuceRedisProperties.getShutdownTimeout() > 0) {
+				factory.setShutdownTimeout(this.lettuceRedisProperties.getShutdownTimeout());
+			}
+			return factory;
+		}
+	}
+
+	/**
+	 * Redis connection configuration using the Lettuce driver.
+	 */
+	@Configuration
+	@ConditionalOnClass({ LettuceConnection.class, RedisClient.class })
+	@ConditionalOnMissingClass("redis.clients.jedis.Jedis")
+	protected static class LettuceRedisConnectionConfiguration
+			extends AbstractLettuceRedisConfiguration {
+
+		@Bean
+		@ConditionalOnMissingBean(RedisConnectionFactory.class)
+		public LettuceConnectionFactory redisConnectionFactory()
+				throws UnknownHostException {
+			return applyProperties(createLettuceConnectionFactory());
+		}
+
+		private LettuceConnectionFactory createLettuceConnectionFactory() {
+			if (getSentinelConfig() != null) {
+				return new LettuceConnectionFactory(getSentinelConfig());
+			}
+			if (getClusterConfiguration() != null) {
+				return new LettuceConnectionFactory(getClusterConfiguration());
+			}
+			return new LettuceConnectionFactory();
+		}
+	}
+
 	/**
 	 * Standard Redis configuration.
 	 */

spring-boot-dependencies/pom.xml

@@ -111,6 +111,7 @@
 		<jtds.version>1.3.1</jtds.version>
 		<junit.version>4.12</junit.version>
 		<liquibase.version>3.4.2</liquibase.version>
+		<lettuce.version>3.4.2.Final</lettuce.version>
 		<log4j2.version>2.5</log4j2.version>
 		<logback.version>1.1.5</logback.version>
 		<lombok.version>1.16.6</lombok.version>
@@ -2098,6 +2099,11 @@
 				<artifactId>jedis</artifactId>
 				<version>${jedis.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>biz.paluch.redis</groupId>
+				<artifactId>lettuce</artifactId>
+				<version>${lettuce.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>wsdl4j</groupId>
 				<artifactId>wsdl4j</artifactId>

spring-boot-docs/pom.xml

@@ -558,6 +558,11 @@
 			<artifactId>jedis</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>biz.paluch.redis</groupId>
+			<artifactId>lettuce</artifactId>
+			<optional>true</optional>
+		</dependency>
 	</dependencies>
 	<profiles>
 		<profile>

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -685,7 +685,7 @@ content into your application; rather pick only the properties that you need.
 	spring.mongodb.embedded.features=SYNC_DELAY # Comma-separated list of features to enable.
 	spring.mongodb.embedded.version=2.6.10 # Version of Mongo to use.
 
-	# REDIS ({sc-spring-boot-autoconfigure}/redis/RedisProperties.{sc-ext}[RedisProperties])
+	# REDIS ({sc-spring-boot-autoconfigure}/data/redis/RedisProperties.{sc-ext}[RedisProperties])
 	spring.redis.cluster.max-redirects= # Maximum number of redirects to follow when executing commands across the cluster.
 	spring.redis.cluster.nodes= # Comma-separated list of "host:port" pairs to bootstrap from.
 	spring.redis.database=0 # Database index used by the connection factory.
@@ -700,6 +700,8 @@ content into your application; rather pick only the properties that you need.
 	spring.redis.sentinel.nodes= # Comma-separated list of host:port pairs.
 	spring.redis.timeout=0 # Connection timeout in milliseconds.
 
+	# REDIS LETTUCE DRIVER ({sc-spring-boot-autoconfigure}/data/redis/LettuceRedisProperties.{sc-ext}[LettuceRedisProperties])
+	spring.redis.lettuce.shutdown-timeout=2000 # Shutdown timeout in milliseconds.
 
 	# ----------------------------------------
 	# INTEGRATION PROPERTIES

spring-boot-docs/src/main/asciidoc/howto.adoc

@@ -2775,3 +2775,44 @@ but the rest of it is normal for a Spring application in Servlet 2.5. Example:
 In this example we are using a single application context (the one created by the context
 listener) and attaching it to the `DispatcherServlet` using an init parameter. This is
 normal in a Spring Boot application (you normally only have one application context).
+
+[[howto-use-lettuce-instead-of-jedis]]
+=== Use Lettuce instead of Jedis
+The Spring Boot Redis starter (`spring-boot-starter-data-redis` in particular) uses
+https://github.com/xetorthio/jedis/[Jedis] by default. You need to exclude that dependency
+and include the https://github.com/mp911de/lettuce/[Lettuce] one instead. Spring Boot provides a managed dependency
+to help make this process as easy as possible.
+
+Example in Maven:
+
+[source,xml,indent=0,subs="verbatim,quotes,attributes"]
+----
+	<dependency>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-data-redis</artifactId>
+		<exclusions>
+			<exclusion>
+				<groupId>redis.clients</groupId>
+				<artifactId>jedis</artifactId>
+			</exclusion>
+		</exclusions>
+	</dependency>
+	<dependency>
+		<groupId>biz.paluch.redis</groupId>
+		<artifactId>lettuce</artifactId>
+	</dependency>
+----
+
+Example in Gradle:
+
+[source,groovy,indent=0,subs="verbatim,quotes,attributes"]
+----
+	configurations {
+		compile.exclude module: "jedis"
+	}
+
+	dependencies {
+		compile("biz.paluch.redis:lettuce:{lettuce.version}")
+		// ...
+	}
+----

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -2761,10 +2761,10 @@ http://projects.spring.io/spring-data[projects.spring.io/spring-data].
 === Redis
 http://redis.io/[Redis] is a cache, message broker and richly-featured key-value store.
 Spring Boot offers basic auto-configuration for the
-https://github.com/xetorthio/jedis/[Jedis] client library and abstractions on top of it
-provided by https://github.com/spring-projects/spring-data-redis[Spring Data Redis]. There
-is a `spring-boot-starter-data-redis` '`Starter POM`' for collecting the dependencies in a
-convenient way.
+https://github.com/xetorthio/jedis/[Jedis] and https://github.com/mp911de/lettuce/[Lettuce]
+client libraries and abstractions on top of it provided by https://github.com/spring-projects/spring-data-redis[Spring Data Redis].
+There is a `spring-boot-starter-data-redis` '`Starter POM`' for collecting the dependencies in a
+convenient way that uses https://github.com/xetorthio/jedis/[Jedis] by default.