Skip to content

Getting Started

Getting started with Redisson takes two steps: add the dependency to your project, then create a client and obtain your first Valkey or Redis based object or service.

  1. Add dependency

    • Community Edition

      Maven

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

      Gradle

      compile 'org.redisson:redisson:4.6.0'

    • Redisson PRO

      Maven

      <dependency>
   <groupId>pro.redisson</groupId>
   <artifactId>redisson</artifactId>
   <version>4.6.0</version>
</dependency>

      Gradle

      compile 'pro.redisson:redisson:4.6.0'

      License key configuration

    Redisson PRO vs. Community Edition ➜

  2. Start development

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

      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"));

    • Create Redisson instance. 

      // Sync and Async API
RedissonClient redisson = Redisson.create(config);

// Reactive API
RedissonReactiveClient redissonReactive = redisson.reactive();

// RxJava3 API
RedissonRxClient redissonRx = redisson.rxJava();
      RedissonClient is thread-safe, so create a single instance and reuse it as a shared singleton across your application. It is a common pattern for Redisson to start and stop together with the application, so shut the client down when the application stops: 
      // on application shutdown
redisson.shutdown();

    • 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> localCachedMap = 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.

Framework and platform integrations