1. Add dependency

Maven 

  1. <dependency>
  2.    <groupId>org.redisson</groupId>
  3.    <artifactId>redisson</artifactId>
  4.    <version>xVERSIONx</version>
  5. </dependency>

Gradle 

  1. compile 'org.redisson:redisson:xVERSIONx'

SBT 

  1. libraryDependencies += "org.redisson" % "redisson" % "xVERSIONx"

2. Start development

  1. Create config object.
    Use one of supported modes: (single mode, replicated mode, cluster mode, sentinel mode, proxy mode, multi cluster mode, multi sentinel mode)

    1. Config config = new Config();
    2. config.useClusterServers()
    3.       // use "redis://" for Redis connection
    4.       // use "valkey://" for Valkey connection
    5.       // use "valkeys://" for Valkey SSL connection
    6.       // use "rediss://" for Redis SSL connection
    7.       .addNodeAddress("redis://127.0.0.1:7181");
    9. // or read config from file
    10. config = Config.fromYAML(new File("config-file.yaml"));

  2. Create Redisson instance.

    1. // Sync and Async API
    2. RedissonClient redisson = Redisson.create(config);
    4. // Reactive API
    5. RedissonReactiveClient redissonReactive = redisson.reactive();
    7. // RxJava3 API
    8. RedissonRxClient redissonRx = redisson.rxJava();

  3. Get Redis or Valkey based object or service.

    1. // java.util.concurrent.ConcurrentMap
    3. RMap<MyKey, MyValue> map = redisson.getMap("myMap");
    5. RMapReactive<MyKey, MyValue> mapReactive = redissonReactive.getMap("myMap");
    7. RMapRx<MyKey, MyValue> mapRx = redissonRx.getMap("myMap");
    9. // client side caching
    11. RLocalCachedMap<MyKey, MyValue> map = redisson.getLocalCachedMap(LocalCachedMapOptions.<MyKey, MyValue>name("myMap"));
    13. // java.util.concurrent.locks.Lock
    15. RLock lock = redisson.getLock("myLock");
    17. RLockReactive lockReactive = redissonReactive.getLock("myLock");
    19. RLockRx lockRx = redissonRx.getLock("myLock");
    21. // java.util.concurrent.ExecutorService
    23. RExecutorService executor = redisson.getExecutorService("myExecutorService");
    25. // over 50 Redis or Valkey based Java objects and services ...

More code examples can be found here.

Upgrade to Redisson PRO with advanced features.