spring-data-redis
Provides support to increase developer productivity in Java when using Redis, a key-value store. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Top Related Projects
Redis Java client
Redisson - Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava/Reactive API. Over 50 Redis or Valkey based Java objects and services: Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Spring, Tomcat, Scheduler, JCache API, Hibernate, RPC, local cache...
Advanced Java Redis client for thread-safe sync, async, and reactive usage. Supports Cluster, Sentinel, Pipelining, and codecs.
Main Portal page for the Jackson project
RxJava – Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.
Quick Overview
Spring Data Redis is a project within the Spring Data family that provides easy configuration and access to Redis from Spring applications. It offers a high-level abstraction for Redis interactions, including support for various Redis operations, caching, and messaging, while integrating seamlessly with other Spring and Spring Data projects.
Pros
- Seamless integration with Spring Framework and other Spring Data projects
- Provides high-level abstractions for Redis operations, simplifying development
- Supports various Redis features like caching, pub/sub messaging, and transactions
- Offers both imperative and reactive programming models
Cons
- Learning curve for developers new to Spring ecosystem
- May introduce unnecessary complexity for simple Redis use cases
- Performance overhead due to abstraction layer (though minimal in most cases)
- Limited support for some advanced Redis features compared to direct Redis client usage
Code Examples
- Configuring Redis connection:
@Configuration
@EnableRedisRepositories
public class RedisConfig {
@Bean
public LettuceConnectionFactory redisConnectionFactory() {
return new LettuceConnectionFactory(new RedisStandaloneConfiguration("localhost", 6379));
}
}
- Using RedisTemplate for basic operations:
@Autowired
private RedisTemplate<String, String> redisTemplate;
public void setKey(String key, String value) {
redisTemplate.opsForValue().set(key, value);
}
public String getKey(String key) {
return redisTemplate.opsForValue().get(key);
}
- Using Redis Repository for CRUD operations:
@RedisHash("Person")
public class Person {
@Id
private String id;
private String name;
// getters and setters
}
public interface PersonRepository extends CrudRepository<Person, String> {
}
@Autowired
private PersonRepository personRepository;
public void savePerson(Person person) {
personRepository.save(person);
}
Getting Started
- Add Spring Data Redis dependency to your project:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
- Configure Redis connection in
application.properties
:
spring.redis.host=localhost
spring.redis.port=6379
- Create a configuration class to enable Redis repositories:
@Configuration
@EnableRedisRepositories
public class RedisConfig {
}
- Inject and use RedisTemplate or Redis repositories in your services:
@Service
public class MyService {
@Autowired
private RedisTemplate<String, String> redisTemplate;
public void setValue(String key, String value) {
redisTemplate.opsForValue().set(key, value);
}
}
Competitor Comparisons
Redis Java client
Pros of Jedis
- Lightweight and simple to use, with a straightforward API
- Direct implementation of Redis commands, offering fine-grained control
- Suitable for projects that don't require the full Spring ecosystem
Cons of Jedis
- Lacks advanced features like connection pooling and automatic serialization
- Not as well-integrated with Spring applications as Spring Data Redis
- May require more manual configuration and management
Code Comparison
Spring Data Redis:
@Autowired
private RedisTemplate<String, Object> redisTemplate;
redisTemplate.opsForValue().set("key", "value");
String value = (String) redisTemplate.opsForValue().get("key");
Jedis:
Jedis jedis = new Jedis("localhost");
jedis.set("key", "value");
String value = jedis.get("key");
jedis.close();
Spring Data Redis provides a higher-level abstraction with RedisTemplate, offering more features and integration with Spring. Jedis, on the other hand, provides a more direct approach to Redis operations, requiring manual connection management but offering simplicity for basic use cases.
Redisson - Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava/Reactive API. Over 50 Redis or Valkey based Java objects and services: Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Spring, Tomcat, Scheduler, JCache API, Hibernate, RPC, local cache...
Pros of Redisson
- More comprehensive Redis feature support, including distributed objects, locks, and services
- Better performance for complex operations and high-concurrency scenarios
- Built-in support for Redis clustering and sentinel configurations
Cons of Redisson
- Steeper learning curve due to its extensive API and features
- Less seamless integration with Spring ecosystem compared to Spring Data Redis
- Potentially overkill for simple Redis use cases
Code Comparison
Spring Data Redis:
@Autowired
private RedisTemplate<String, Object> redisTemplate;
redisTemplate.opsForValue().set("key", "value");
String value = (String) redisTemplate.opsForValue().get("key");
Redisson:
RedissonClient redisson = Redisson.create();
RBucket<String> bucket = redisson.getBucket("key");
bucket.set("value");
String value = bucket.get();
Both libraries provide Redis integration for Java applications, but they cater to different use cases. Spring Data Redis offers seamless integration with the Spring ecosystem and is suitable for simpler Redis operations. Redisson, on the other hand, provides a more comprehensive set of Redis features and better performance for complex scenarios, making it a good choice for applications that require advanced Redis functionality.
Advanced Java Redis client for thread-safe sync, async, and reactive usage. Supports Cluster, Sentinel, Pipelining, and codecs.
Pros of Lettuce
- Direct Redis client with more low-level control
- Supports advanced Redis features like pipelining and transactions
- Non-blocking, reactive programming model
Cons of Lettuce
- Steeper learning curve for developers new to Redis
- Less abstraction and higher-level features compared to Spring Data Redis
- Requires more boilerplate code for common operations
Code Comparison
Spring Data Redis:
@Autowired
private RedisTemplate<String, Object> redisTemplate;
redisTemplate.opsForValue().set("key", "value");
String value = (String) redisTemplate.opsForValue().get("key");
Lettuce:
RedisClient redisClient = RedisClient.create("redis://localhost:6379");
StatefulRedisConnection<String, String> connection = redisClient.connect();
RedisCommands<String, String> syncCommands = connection.sync();
syncCommands.set("key", "value");
String value = syncCommands.get("key");
Spring Data Redis provides a higher-level abstraction with RedisTemplate, while Lettuce offers more direct control over Redis commands. Spring Data Redis is generally easier for beginners and integrates well with Spring applications, whereas Lettuce provides more flexibility and advanced features for experienced Redis users.
Main Portal page for the Jackson project
Pros of Jackson
- More versatile, supporting various data formats beyond JSON (XML, YAML, etc.)
- Highly customizable with numerous annotations and modules
- Better performance for large-scale data processing
Cons of Jackson
- Steeper learning curve due to extensive features and configurations
- Not specifically designed for Redis operations, requiring additional setup
- May introduce unnecessary complexity for simple Redis-specific use cases
Code Comparison
Spring Data Redis:
@RedisHash("Person")
public class Person {
@Id private String id;
private String name;
private int age;
}
Jackson:
@JsonPropertyOrder({"id", "name", "age"})
public class Person {
@JsonProperty("id") private String id;
@JsonProperty("name") private String name;
@JsonProperty("age") private int age;
}
Summary
Spring Data Redis is tailored for Redis operations, offering seamless integration with Spring applications and simplified Redis interactions. It's ideal for projects primarily focused on Redis as a data store.
Jackson, on the other hand, is a general-purpose data-binding library with broader applications. It excels in JSON processing and supports various data formats, making it suitable for complex data serialization needs beyond Redis.
Choose Spring Data Redis for Redis-centric applications within the Spring ecosystem, and Jackson for more diverse data processing requirements or when working with multiple data formats.
RxJava – Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.
Pros of RxJava
- Offers a more comprehensive reactive programming model
- Provides a rich set of operators for composing asynchronous and event-based programs
- Supports multiple programming languages and platforms
Cons of RxJava
- Steeper learning curve due to its extensive API
- Can be overkill for simpler applications that don't require complex reactive programming
- May introduce additional complexity in codebases that are not fully reactive
Code Comparison
RxJava:
Observable.just("Hello", "World")
.map(String::toUpperCase)
.subscribe(System.out::println);
Spring Data Redis:
redisTemplate.opsForValue().set("greeting", "Hello World");
String value = redisTemplate.opsForValue().get("greeting");
System.out.println(value);
Key Differences
- RxJava focuses on reactive programming paradigms, while Spring Data Redis is specifically designed for Redis operations
- Spring Data Redis provides a higher-level abstraction for working with Redis, whereas RxJava is a general-purpose reactive library
- RxJava offers more flexibility in terms of composing and transforming data streams, while Spring Data Redis simplifies Redis-specific operations
Use Cases
- Choose RxJava for complex, event-driven applications requiring reactive programming across multiple components
- Opt for Spring Data Redis when working specifically with Redis in a Spring ecosystem and needing simplified Redis operations
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
= Spring Data Redis image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-redis%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-redis/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data Redis"]
The primary goal of the https://spring.io/projects/spring-data/[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
This module provides integration with the https://redis.io/[Redis] store.
== Features
- Connection package as low-level abstraction across multiple Redis drivers (https://github.com/lettuce-io/lettuce-core[Lettuce] and https://github.com/redis/jedis[Jedis]).
- Exception translation to Springâs portable Data Access exception hierarchy for Redis driver exceptions
- https://docs.spring.io/spring-data/redis/reference/redis/template.html[`RedisTemplate`] that provides a high level abstraction for performing various Redis operations, exception translation and serialization support.
- Pubsub support (such as a MessageListenerContainer for message-driven POJOs).
- https://docs.spring.io/spring-data/redis/reference/redis/connection-modes.html#redis:sentinel[Redis Sentinel] and https://docs.spring.io/spring-data/redis/reference/redis/connection-modes.html#cluster.enable[Redis Cluster] support.
- Reactive API using the Lettuce driver.
- JDK, String, JSON and Spring Object/XML mapping serializers.
- JDK Collection implementations on top of Redis.
- Atomic counter support classes.
- Sorting and Pipelining functionality.
- Dedicated support for SORT, SORT/GET pattern and returned bulk values.
- Redis implementation for Spring 3.1 cache abstraction.
- Automatic implementation of
Repository
interfaces including support for custom finder methods using@EnableRedisRepositories
. - CDI support for repositories.
== Code of Conduct
This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
== Getting Started
Here is a quick teaser of an application using Spring Data Redis in Java:
[source,java]
public class Example {
// inject the actual template
@Autowired
private RedisTemplate<String, String> template;
// inject the template as ListOperations
// can also inject as Value, Set, ZSet, and HashOperations
@Resource(name="redisTemplate")
private ListOperations<String, String> listOps;
public void addLink(String userId, URL url) {
listOps.leftPush(userId, url.toExternalForm());
// or use template directly
redisTemplate.boundListOps(userId).leftPush(url.toExternalForm());
}
}
@Configuration class ApplicationConfig {
@Bean public RedisConnectionFactory redisConnectionFactory() { return new LettuceConnectionFactory(); } }
=== Maven configuration
Add the Maven dependency:
[source,xml]
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
[source,xml]
== Getting Help
Having trouble with Spring Data? Weâd love to help!
- Check the https://docs.spring.io/spring-data/redis/reference/[reference documentation], and https://docs.spring.io/spring-data/redis/docs/current/api/[Javadocs].
- Learn the Spring basics â Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation. If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
- If you are upgrading, check out the https://github.com/spring-projects/spring-data-commons/wiki#release-notes[Release notes] for "
new and noteworthy
" features. - Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-redis`]. You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].
- Report bugs with Spring Data Redis at https://github.com/spring-projects/spring-data-redis/issues/new[github.com/spring-projects/spring-data-redis].
== Reporting Issues
Spring Data uses Github as issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
- Before you log a bug, please search the https://github.com/spring-projects/spring-data-redis/issues[issue tracker] to see if someone has already reported the problem.
- If the issue does not already exist, https://github.com/spring-projects/spring-data-redis/issues/new[create a new issue].
- Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using, the JVM version, Stacktrace, etc.
- If you need to paste code, or include a stack trace use https://guides.github.com/features/mastering-markdown/[Markdown] code fences +++```+++.
- If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.
== Building from Source
You donât need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
You also need JDK 17 or above and make
.
The local build environment is managed within a Makefile
to download, build and spin up Redis in various configurations (Standalone, Sentinel, Cluster, etc.)
[source,bash]
$ make test
The preceding command runs a full build.
You can use make start
, make stop
, and make clean
commands to control the environment yourself.
This is useful if you want to avoid constant server restarts.
Once all Redis instances have been started, you can either run tests in your IDE or the full Maven build:
[source,bash]
$ ./mvnw clean install
If you want to build with the regular mvn
command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.8.0 or above].
Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributorâs Agreement] before your first non-trivial change.
=== Building reference documentation
Building the documentation builds also the project without running tests.
[source,bash]
$ ./mvnw clean install -Pantora
The generated documentation is available from target/antora/site/index.html
.
== Guides
The https://spring.io/[spring.io] site contains several guides that show how to use Spring Data step-by-step:
- https://spring.io/guides/gs/messaging-redis/[Messaging with Redis]: Learn how to use Redis as a message broker.
- https://spring.io/guides/gs/spring-data-reactive-redis/[Accessing Data Reactively with Redis]: Learn how to reactively interface with Redis and Spring Data.
== Examples
- https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.
== License
Spring Data Redis is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
Top Related Projects
Redis Java client
Redisson - Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava/Reactive API. Over 50 Redis or Valkey based Java objects and services: Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Spring, Tomcat, Scheduler, JCache API, Hibernate, RPC, local cache...
Advanced Java Redis client for thread-safe sync, async, and reactive usage. Supports Cluster, Sentinel, Pipelining, and codecs.
Main Portal page for the Jackson project
RxJava – Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot