itdotaer / redisson

Redisson - Redis Java client with features of In-Memory Data Grid. Supports over 30 objects and services: Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Publish / Subscribe, Bloom filter, Spring Cache, Tomcat, Scheduler, JCache API, Hibernate, RPC.

Redisson - Redis Java client
with features of In-Memory Data Grid

Quick start | Documentation | Javadocs | Changelog | Code examples | FAQs | Report an issue

Based on high-performance async and lock-free Java Redis client and Netty framework.
JDK compatibility: 1.8 - 13, Android

Features

• Replicated Redis servers mode (also supports AWS ElastiCache and Azure Redis Cache):
  1. automatic master server change discovery
• Clustered Redis servers mode (also supports AWS ElastiCache Cluster and Azure Redis Cache):
  1. automatic master and slave servers discovery
  2. automatic status and topology update
  3. automatic slots change discovery
• Sentinel Redis servers mode:
  1. automatic master, slave and sentinel servers discovery
  2. automatic status and topology update
• Master with Slave Redis servers mode
• Single Redis server mode (also supports Azure Redis Cache and Google Cloud Memorystore for Redis)
• Thread-safe implementation
• Reactive Streams API
• RxJava2 API
• Asynchronous API
• Asynchronous connection pool
• Lua scripting
• Distributed Java objects
  Object holder, Binary stream holder, Geospatial holder, BitSet, AtomicLong, AtomicDouble, PublishSubscribe, Bloom filter, HyperLogLog
• Distributed Java collections
  Map, Multimap, Set, List, SortedSet, ScoredSortedSet, LexSortedSet, Queue, Deque, Blocking Queue, Bounded Blocking Queue, Blocking Deque, Delayed Queue, Priority Queue, Priority Deque
• Distributed Java locks and synchronizers
  Lock, FairLock, MultiLock, RedLock, ReadWriteLock, Semaphore, PermitExpirableSemaphore, CountDownLatch
• Distributed services
  Remote service, Live Object service, Executor service, Scheduler service, MapReduce service
• Spring Framework
• Spring Cache implementation
• Spring Transaction API implementation
• Spring Data Redis integration
• Spring Boot Starter implementation
• Hibernate Cache implementation
• Transactions API
• XA Transaction API implementation
• JCache API (JSR-107) implementation
• Tomcat Session Manager implementation
• Spring Session implementation
• Redis pipelining (command batches)
• Supports Android platform
• Supports auto-reconnection
• Supports failed to send command auto-retry
• Supports OSGi
• Supports SSL
• Supports many popular codecs (Jackson JSON, Avro, Smile, CBOR, MsgPack, Kryo, Amazon Ion, FST, LZ4, Snappy and JDK Serialization)
• With over 2000 unit tests

Success stories

Moving from Hazelcast to Redis / Datorama

Distributed Locking with Redis (Migration from Hazelcast) / ContaAzul

Migrating from Coherence to Redis

Quick start

Maven

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

Gradle

compile 'org.redisson:redisson:3.11.6'  

Java

// 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.createReactive(config);

// RxJava2 API
RedissonRxClient redissonRx = Redisson.createRx(config);

// 3. Get Redis based Map
RMap<MyKey, MyValue> map = redisson.getMap("myMap");

RMapReactive<MyKey, MyValue> mapReactive = redissonReactive.getMap("myMap");

RMapRx<MyKey, MyValue> mapRx = redissonRx.getMap("myMap");

// 4. Get Redis based Lock
RLock lock = redisson.getLock("myLock");

RLockReactive lockReactive = redissonReactive.getLock("myLock");

RLockRx lockRx = redissonRx.getLock("myLock");

// 4. Get Redis based ExecutorService
RExecutorService executor = redisson.getExecutorService("myExecutorService");

// over 30 different Redis based objects and services ...

Consider Redisson PRO version for advanced features and support by SLA.

Downloads

Redisson 3.11.6, Redisson node 3.11.6

FAQs

Q: I saw a RedisTimeOutException, What does it mean? What shall I do? Can Redisson Team fix it?

Q: I saw a com.fasterxml.jackson.databind.JsonMappingException during deserialization process, can you fix it?

Q: There were too many quotes appeared in the redis-cli console output, how do I fix it?

Q: When do I need to shut down a Redisson instance, at the end of each request or the end of the life of a thread?

Q: In MapCache/SetCache/SpringCache/JCache, I have set an expiry time to an entry, why is it still in Redis when it should be disappeared?

Q: How can I perform Pipelining/Transaction through Redisson?

Q: Is Redisson thread safe? Can I share an instance of it between different threads?

Q: Can I use different encoder/decoders for different tasks?