You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
redisson/redisson-spring-data/README.md

78 lines
2.8 KiB
Markdown

# Spring Data Redis integration
6 years ago
Integrates Redisson with Spring Data Redis library. Implements Spring Data's `RedisConnectionFactory` and `ReactiveRedisConnectionFactory` interfaces and allows to interact with Redis through `RedisTemplate` or `ReactiveRedisTemplate` object.
4 years ago
Supports Spring Data Redis 1.6.x - 2.4.x
6 years ago
<sub>Consider __[Redisson PRO](https://redisson.pro)__ version for advanced features and support by SLA.</sub>
6 years ago
## Usage
### 1. Add `redisson-spring-data` dependency into your project:
6 years ago
Maven
6 years ago
```xml
<dependency>
<groupId>org.redisson</groupId>
5 years ago
<!-- 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>
6 years ago
<!-- for Spring Data Redis v.2.1.x -->
<artifactId>redisson-spring-data-21</artifactId>
5 years ago
<!-- for Spring Data Redis v.2.2.x -->
<artifactId>redisson-spring-data-22</artifactId>
5 years ago
<!-- for Spring Data Redis v.2.3.x -->
<artifactId>redisson-spring-data-23</artifactId>
4 years ago
<!-- for Spring Data Redis v.2.4.x -->
<artifactId>redisson-spring-data-24</artifactId>
4 years ago
<version>3.15.2</version>
</dependency>
6 years ago
```
Gradle
```groovy
5 years ago
// for Spring Data Redis v.1.6.x
4 years ago
compile 'org.redisson:redisson-spring-data-16:3.15.2'
5 years ago
// for Spring Data Redis v.1.7.x
4 years ago
compile 'org.redisson:redisson-spring-data-17:3.15.2'
// for Spring Data Redis v.1.8.x
4 years ago
compile 'org.redisson:redisson-spring-data-18:3.15.2'
// for Spring Data Redis v.2.0.x
4 years ago
compile 'org.redisson:redisson-spring-data-20:3.15.2'
6 years ago
// for Spring Data Redis v.2.1.x
4 years ago
compile 'org.redisson:redisson-spring-data-21:3.15.2'
5 years ago
// for Spring Data Redis v.2.2.x
4 years ago
compile 'org.redisson:redisson-spring-data-22:3.15.2'
5 years ago
// for Spring Data Redis v.2.3.x
4 years ago
compile 'org.redisson:redisson-spring-data-23:3.15.2'
4 years ago
// for Spring Data Redis v.2.4.x
4 years ago
compile 'org.redisson:redisson-spring-data-24:3.15.2'
```
7 years ago
### 2. Register `RedissonConnectionFactory` in Spring context
```java
@Configuration
public class RedissonSpringDataConfig {
@Bean
public RedissonConnectionFactory redissonConnectionFactory(RedissonClient redisson) {
6 years ago
return new RedissonConnectionFactory(redisson);
}
6 years ago
@Bean(destroyMethod = "shutdown")
6 years ago
public RedissonClient redisson(@Value("classpath:/redisson.yaml") Resource configFile) throws IOException {
Config config = Config.fromYAML(configFile.getInputStream());
return Redisson.create(config);
}
}
```