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.
97 lines
3.1 KiB
Markdown
97 lines
3.1 KiB
Markdown
**1. Add dependency**
|
|
<div style="display: flex; flex-wrap: wrap; gap: 20px;">
|
|
<div style="flex: 1; min-width: 250px;">
|
|
<h3 style="margin-top: 0.75em">Redisson PRO</h3>
|
|
<h5>Maven</h5>
|
|
<pre><code><dependency>
|
|
<groupId>pro.redisson</groupId>
|
|
<artifactId>redisson</artifactId>
|
|
<version>xVERSIONx</version>
|
|
</dependency></code></pre>
|
|
<h5>Gradle</h5>
|
|
<pre><code>compile 'pro.redisson:redisson:xVERSIONx'</code></pre>
|
|
</div>
|
|
|
|
<div style="flex: 1; min-width: 250px;">
|
|
<h3 style="margin-top: 0.75em">Community Edition</h3>
|
|
<h5>Maven</h5>
|
|
<pre><code><dependency>
|
|
<groupId>org.redisson</groupId>
|
|
<artifactId>redisson</artifactId>
|
|
<version>xVERSIONx</version>
|
|
</dependency></code></pre>
|
|
<h5>Gradle</h5>
|
|
<pre><code>compile 'org.redisson:redisson:xVERSIONx'</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
[Redisson PRO vs. Community Edition ➜](https://redisson.pro/feature-comparison.html)
|
|
|
|
**2. Start development**
|
|
|
|
1. Create config object.
|
|
Use one of supported modes: ([single mode](configuration.md/#single-mode),
|
|
[replicated mode](configuration.md/#replicated-mode),
|
|
[cluster mode](configuration.md/#cluster-mode),
|
|
[sentinel mode](configuration.md/#sentinel-mode),
|
|
[proxy mode](configuration.md/#proxy-mode),
|
|
[multi cluster mode](configuration.md/#multi-cluster-mode),
|
|
[multi sentinel mode](configuration.md/#multi-sentinel-mode))
|
|
```java
|
|
Config config = new Config();
|
|
config.useClusterServers()
|
|
// use "redis://" for Redis connection
|
|
// use "valkey://" for Valkey connection
|
|
// use "valkeys://" for Valkey SSL connection
|
|
// use "rediss://" for Redis 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). |