redisson/docs/getting-started.md

1. Add dependency

Maven

<dependency>
   <groupId>org.redisson</groupId>
   <artifactId>redisson</artifactId>
   <version>xVERSIONx</version>
</dependency>  

Gradle

compile 'org.redisson:redisson:xVERSIONx'  

SBT

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

2. Start development

1. Create config object

   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

   // 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.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.

Upgrade to Redisson PRO with advanced features.