redisson/redisson-spring-data/README.md

Spring Data Redis integration

Integrates Redisson with Spring Data Redis library. Implements Spring Data's RedisConnection and RedisClusterConnection interfaces, so you could work with Redis through RedisTemplate object.

Supports Spring Data Redis 1.6.x, 1.7.x, 1.8.x, 2.0.x, 2.1.x

_{Please consider Redisson PRO version for advanced features and support by SLA.}

Usage

1. Add redisson-spring-data dependency into your project:

1. For JDK 1.8+

   Maven

   <dependency>
       <groupId>org.redisson</groupId>
       <!-- for Spring Data Redis v.1.6.x -->
       <artifactId>redisson-spring-data-16</artifactId>
       <!-- for Spring Data Redis v.1.7.x -->
       <artifactId>redisson-spring-data-17</artifactId>
       <!-- for Spring Data Redis v.1.8.x -->
       <artifactId>redisson-spring-data-18</artifactId>
       <!-- for Spring Data Redis v.2.0.x -->
       <artifactId>redisson-spring-data-20</artifactId>
       <!-- for Spring Data Redis v.2.1.x -->
       <artifactId>redisson-spring-data-21</artifactId>
       <version>3.10.0</version>
   </dependency>
   

   Gradle

   // for Spring Data Redis v.1.6.x
   compile 'org.redisson:redisson-spring-data-16:3.10.0'
   // for Spring Data Redis v.1.7.x
   compile 'org.redisson:redisson-spring-data-17:3.10.0'
   // for Spring Data Redis v.1.8.x
   compile 'org.redisson:redisson-spring-data-18:3.10.0'
   // for Spring Data Redis v.2.0.x
   compile 'org.redisson:redisson-spring-data-20:3.10.0'
   // for Spring Data Redis v.2.1.x
   compile 'org.redisson:redisson-spring-data-21:3.10.0'
   

2. For JDK 1.6+

   Maven

   <dependency>
       <groupId>org.redisson</groupId>
       <!-- for Spring Data Redis v.1.6.x -->
       <artifactId>redisson-spring-data-16</artifactId>
       <!-- for Spring Data Redis v.1.7.x -->
       <artifactId>redisson-spring-data-17</artifactId>
       <!-- for Spring Data Redis v.1.8.x -->
       <artifactId>redisson-spring-data-18</artifactId>
       <version>2.15.0</version>
   </dependency>
   

   Gradle

   // for Spring Data Redis v.1.6.x
   compile 'org.redisson:redisson-spring-data-16:2.15.0'
   // for Spring Data Redis v.1.7.x
   compile 'org.redisson:redisson-spring-data-17:2.15.0'
   // for Spring Data Redis v.1.8.x
   compile 'org.redisson:redisson-spring-data-18:2.15.0'
   

2. Register RedissonConnectionFactory in Spring context

 @Configuration
 public class RedissonSpringDataConfig {
    
    @Bean
    public RedissonConnectionFactory redissonConnectionFactory(RedissonClient redisson) {
        return new RedissonConnectionFactory(redisson);
    }
    
    @Bean(destroyMethod = "shutdown")
    public RedissonClient redisson(@Value("classpath:/redisson.yaml") Resource configFile) throws IOException {
        Config config = Config.fromYAML(configFile.getInputStream());
        return Redisson.create(config);
    }
    
 }