Update README.md

pull/6203/head
Nikita Koksharov 4 months ago committed by GitHub
parent e647fd1623
commit ed2a5112d0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -1,102 +1 @@
# Spring Data Redis integration
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.
## Usage
### 1. Add `redisson-spring-data` dependency into your project:
Maven
```xml
<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>
<!-- for Spring Data Redis v.2.2.x -->
<artifactId>redisson-spring-data-22</artifactId>
<!-- for Spring Data Redis v.2.3.x -->
<artifactId>redisson-spring-data-23</artifactId>
<!-- for Spring Data Redis v.2.4.x -->
<artifactId>redisson-spring-data-24</artifactId>
<!-- for Spring Data Redis v.2.5.x -->
<artifactId>redisson-spring-data-25</artifactId>
<!-- for Spring Data Redis v.2.6.x -->
<artifactId>redisson-spring-data-26</artifactId>
<!-- for Spring Data Redis v.2.7.x -->
<artifactId>redisson-spring-data-27</artifactId>
<!-- for Spring Data Redis v.3.0.x -->
<artifactId>redisson-spring-data-30</artifactId>
<!-- for Spring Data Redis v.3.1.x -->
<artifactId>redisson-spring-data-31</artifactId>
<!-- for Spring Data Redis v.3.2.x -->
<artifactId>redisson-spring-data-32</artifactId>
<!-- for Spring Data Redis v.3.3.x -->
<artifactId>redisson-spring-data-33</artifactId>
<version>3.36.0</version>
</dependency>
```
Gradle
```groovy
// for Spring Data Redis v.1.6.x
compile 'org.redisson:redisson-spring-data-16:3.36.0'
// for Spring Data Redis v.1.7.x
compile 'org.redisson:redisson-spring-data-17:3.36.0'
// for Spring Data Redis v.1.8.x
compile 'org.redisson:redisson-spring-data-18:3.36.0'
// for Spring Data Redis v.2.0.x
compile 'org.redisson:redisson-spring-data-20:3.36.0'
// for Spring Data Redis v.2.1.x
compile 'org.redisson:redisson-spring-data-21:3.36.0'
// for Spring Data Redis v.2.2.x
compile 'org.redisson:redisson-spring-data-22:3.36.0'
// for Spring Data Redis v.2.3.x
compile 'org.redisson:redisson-spring-data-23:3.36.0'
// for Spring Data Redis v.2.4.x
compile 'org.redisson:redisson-spring-data-24:3.36.0'
// for Spring Data Redis v.2.5.x
compile 'org.redisson:redisson-spring-data-25:3.36.0'
// for Spring Data Redis v.2.6.x
compile 'org.redisson:redisson-spring-data-26:3.36.0'
// for Spring Data Redis v.2.7.x
compile 'org.redisson:redisson-spring-data-27:3.36.0'
// for Spring Data Redis v.3.0.x
compile 'org.redisson:redisson-spring-data-30:3.36.0'
// for Spring Data Redis v.3.1.x
compile 'org.redisson:redisson-spring-data-31:3.36.0'
// for Spring Data Redis v.3.2.x
compile 'org.redisson:redisson-spring-data-32:3.36.0'
// for Spring Data Redis v.3.3.x
compile 'org.redisson:redisson-spring-data-33:3.36.0'
```
### 2. Register `RedissonConnectionFactory` in Spring context
```java
@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);
}
}
```
Upgrade to __[Redisson PRO](https://redisson.pro)__ with **advanced features**.
## The documentation has been moved to [https://redisson.org/docs/integration-with-spring/#spring-data-redis](https://redisson.org/docs/integration-with-spring/#spring-data-redis)

Loading…
Cancel
Save