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.
84 lines
1.9 KiB
Markdown
84 lines
1.9 KiB
Markdown
**1. Add dependency**
|
|
|
|
Maven
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>org.redisson</groupId>
|
|
<artifactId>redisson</artifactId>
|
|
<version>xVERSIONx</version>
|
|
</dependency>
|
|
```
|
|
|
|
Gradle
|
|
|
|
```java
|
|
compile 'org.redisson:redisson:xVERSIONx'
|
|
```
|
|
|
|
SBT
|
|
|
|
```java
|
|
libraryDependencies += "org.redisson" % "redisson" % "xVERSIONx"
|
|
```
|
|
|
|
**2. Start development**
|
|
|
|
1. Create config object
|
|
```java
|
|
Config config = new Config();
|
|
config.useClusterServers()
|
|
// use "rediss://" for SSL connection
|
|
.addNodeAddress("redis://127.0.0.1:7181");
|
|
|
|
// or read config from file
|
|
config = Config.fromYAML(new File("config-file.yaml"));
|
|
```
|
|
|
|
2. Create Redisson instance
|
|
```java
|
|
// Sync and Async API
|
|
RedissonClient redisson = Redisson.create(config);
|
|
|
|
// Reactive API
|
|
RedissonReactiveClient redissonReactive = redisson.reactive();
|
|
|
|
// RxJava3 API
|
|
RedissonRxClient redissonRx = redisson.rxJava();
|
|
```
|
|
|
|
3. Get Redis or Valkey based object or service
|
|
```java
|
|
// java.util.concurrent.ConcurrentMap
|
|
|
|
RMap<MyKey, MyValue> map = redisson.getMap("myMap");
|
|
|
|
RMapReactive<MyKey, MyValue> mapReactive = redissonReactive.getMap("myMap");
|
|
|
|
RMapRx<MyKey, MyValue> mapRx = redissonRx.getMap("myMap");
|
|
|
|
// client side caching
|
|
|
|
RLocalCachedMap<MyKey, MyValue> map = redisson.getLocalCachedMap(LocalCachedMapOptions.<MyKey, MyValue>name("myMap"));
|
|
|
|
|
|
// java.util.concurrent.locks.Lock
|
|
|
|
RLock lock = redisson.getLock("myLock");
|
|
|
|
RLockReactive lockReactive = redissonReactive.getLock("myLock");
|
|
|
|
RLockRx lockRx = redissonRx.getLock("myLock");
|
|
|
|
|
|
// java.util.concurrent.ExecutorService
|
|
|
|
RExecutorService executor = redisson.getExecutorService("myExecutorService");
|
|
|
|
|
|
// over 50 Redis or Valkey based Java objects and services ...
|
|
```
|
|
|
|
More code examples can be found [here](https://github.com/redisson/redisson-examples).
|
|
|
|
Upgrade to __[Redisson PRO](https://redisson.pro)__ with **advanced features**. |