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.
redisson/README.md

137 lines
6.8 KiB
Markdown

9 years ago
Redis based In-Memory Data Grid for Java. Redisson.
9 years ago
====
9 years ago
9 years ago
Based on high-performance async and lock-free Java Redis client and [Netty](http://netty.io) framework.
8 years ago
Redis 2.8+ compatible.
| Stable Release Version | JDK Version compatibility | Release Date |
| ------------- | ------------- | ------------|
8 years ago
| 3.0.1 | 1.8+ | 27.10.2016 |
| 2.5.1 | 1.6+ | 27.10.2016 |
11 years ago
9 years ago
Please read [documentation](https://github.com/mrniko/redisson/wiki) for more details.
9 years ago
Redisson [releases history](https://github.com/mrniko/redisson/blob/master/CHANGELOG.md).
11 years ago
11 years ago
Licensed under the Apache License 2.0.
8 years ago
Welcome to support chat [![Join the chat at https://gitter.im/mrniko/redisson](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mrniko/redisson?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
11 years ago
8 years ago
####Try [Redisson PRO](http://redisson.pro) version.
####Redisson team offers commercial support. Please contact sales@redisson.pro for details.
9 years ago
11 years ago
Features
================================
9 years ago
* [AWS ElastiCache](https://aws.amazon.com/elasticache/) servers mode:
1. automatic new master server discovery
2. automatic new slave servers discovery
10 years ago
* Cluster servers mode:
9 years ago
1. automatic master and slave servers discovery
10 years ago
2. automatic new master server discovery
9 years ago
3. automatic new slave servers discovery
9 years ago
4. automatic slave servers offline/online discovery
5. automatic slots change discovery
11 years ago
* Sentinel servers mode:
11 years ago
1. automatic master and slave servers discovery
2. automatic new master server discovery
3. automatic new slave servers discovery
10 years ago
4. automatic slave servers offline/online discovery
5. automatic sentinel servers discovery
9 years ago
* Master with Slave servers mode
* Single server mode
9 years ago
* Asynchronous interface for each object
9 years ago
* Asynchronous connection pool
10 years ago
* Thread-safe implementation
9 years ago
* Lua scripting
9 years ago
* [Distributed objects](https://github.com/mrniko/redisson/wiki/6.-Distributed-objects)
* [Distributed collections](https://github.com/mrniko/redisson/wiki/7.-Distributed-collections)
* [Distributed locks and synchronizers](https://github.com/mrniko/redisson/wiki/8.-Distributed-locks-and-synchronizers)
9 years ago
* [Distributed services](https://github.com/mrniko/redisson/wiki/9.-distributed-services)
9 years ago
* [Spring cache](https://github.com/mrniko/redisson/wiki/14.-Integration%20with%20frameworks/#141-spring-cache) integration
9 years ago
* [Hibernate](https://github.com/mrniko/redisson/wiki/14.-Integration%20with%20frameworks/#142-hibernate) integration
* [Reactive Streams](https://github.com/mrniko/redisson/wiki/3.-operations-execution#32-reactive-way)
* [Redis pipelining](https://github.com/mrniko/redisson/wiki/10.-additional-features#102-execution-batches-of-commands) (command batches)
9 years ago
* Supports Android platform
9 years ago
* Supports auto-reconnect
9 years ago
* Supports failed to send command auto-retry
11 years ago
* Supports OSGi
9 years ago
* Supports many popular codecs ([Jackson JSON](https://github.com/FasterXML/jackson), [Avro](http://avro.apache.org/), [Smile](http://wiki.fasterxml.com/SmileFormatSpec), [CBOR](http://cbor.io/), [MsgPack](http://msgpack.org/), [Kryo](https://github.com/EsotericSoftware/kryo), [FST](https://github.com/RuedigerMoeller/fast-serialization), [LZ4](https://github.com/jpountz/lz4-java), [Snappy](https://github.com/xerial/snappy-java) and JDK Serialization)
9 years ago
* With over 900 unit tests
11 years ago
10 years ago
Projects using Redisson
================================
8 years ago
Singtel(http://singtel.com), [Setronica](http://setronica.com/), [Monits](http://monits.com/), [Brookhaven National Laboratory](http://bnl.gov/), [Netflix Dyno client] (https://github.com/Netflix/dyno), [武林Q传](http://www.nbrpg.com/), [Ocous](http://www.ocous.com/), [Invaluable](http://www.invaluable.com/), [Clover](https://www.clover.com/) , [Apache Karaf Decanter](https://karaf.apache.org/projects.html#decanter), [Atmosphere Framework](http://async-io.org/), [BrandsEye](http://brandseye.com), [Datorama](http://datorama.com/), [BrightCloud](http://brightcloud.com/)
10 years ago
9 years ago
Articles
================================
9 years ago
8 years ago
[Java data structures powered by Redis. Introduction to Redisson (pdf)](http://redisson.org/Redisson.pdf)
8 years ago
[A Look at the Java Distributed In-Memory Data Model (Powered by Redis)](https://dzone.com/articles/java-distributed-in-memory-data-model-powered-by-r)
8 years ago
[Distributed tasks Execution and Scheduling in Java, powered by Redis](https://dzone.com/articles/distributed-tasks-execution-and-scheduling-in-java)
9 years ago
[Introducing Redisson Live Objects (Object Hash Mapping)](https://dzone.com/articles/introducing-redisson-live-object-object-hash-mappi)
[Java Remote Method Invocation with Redisson](https://dzone.com/articles/java-remote-method-invocation-with-redisson)
[Java Multimaps With Redis](https://dzone.com/articles/multimaps-with-redis)
8 years ago
[Distributed lock with Redis](https://evuvatech.com/2016/02/05/distributed-lock-with-redis/)
9 years ago
9 years ago
Quick start
9 years ago
===============================
11 years ago
9 years ago
#### Maven
8 years ago
<!-- JDK 1.8+ compatible -->
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson</artifactId>
8 years ago
<version>3.0.1</version>
8 years ago
</dependency>
11 years ago
8 years ago
<!-- JDK 1.6+ compatible -->
11 years ago
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson</artifactId>
8 years ago
<version>2.5.1</version>
11 years ago
</dependency>
10 years ago
8 years ago
9 years ago
#### Gradle
8 years ago
// JDK 1.8+ compatible
8 years ago
compile 'org.redisson:redisson:3.0.1'
8 years ago
// JDK 1.6+ compatible
8 years ago
compile 'org.redisson:redisson:2.5.1'
10 years ago
9 years ago
#### Java
```java
// 1. Create config object
Config = ...
// 2. Create Redisson instance
RedissonClient redisson = Redisson.create(config);
// 3. Get object you need
RMap<MyKey, MyValue> map = redisson.getMap("myMap");
9 years ago
RLock lock = redisson.getLock("myLock");
9 years ago
9 years ago
RExecutorService executor = redisson.getExecutorService("myExecutorService");
9 years ago
9 years ago
// over 30 different objects and services ...
```
9 years ago
9 years ago
Downloads
===============================
9 years ago
8 years ago
[Redisson 3.0.1](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=org.redisson&a=redisson&v=3.0.1&e=jar),
[Redisson node 3.0.1](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=org.redisson&a=redisson-all&v=3.0.1&e=jar)
8 years ago
8 years ago
[Redisson 2.5.1](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=org.redisson&a=redisson&v=2.5.1&e=jar),
[Redisson node 2.5.1](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=org.redisson&a=redisson-all&v=2.5.1&e=jar)
10 years ago
10 years ago
### Supported by
YourKit is kindly supporting this open source project with its full-featured Java Profiler.
YourKit, LLC is the creator of innovative and intelligent tools for profiling
Java and .NET applications. Take a look at YourKit's leading software products:
<a href="http://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a> and
<a href="http://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>.