Redis Cache module for Play framework
This version supports Play framework 2.7.x with JDK 8 and both Scala 2.11, Scala 2.12 and Scala 2.13.
For previous versions see older releases.
About the Project
Besides the compatibility with all Play's cache APIs, it introduces more evolved API providing lots of handful operations. Besides the basic methods such as
remove, it provides more convenient methods such as
invalidate and much more.
The implementation builds on the top of Akka actor system, it is completely non-blocking and asynchronous under the hood, though it also provides blocking APIs to ease the use. Furthermore, the library supports several configuration providers to let you easily use
play-redis on localhost, Heroku, as well as on your premise.
- synchronous and asynchronous APIs
- implements standard APIs defined by Play's
- support of named caches
- works with Guice as well as compile-time DI
- getOrElse and getOrFuture operations easing the use
- wildcards in remove operation
- support of collections: sets, lists, and maps
- increment and decrement operations
- eager and lazy invocation policies waiting or not waiting for the result
- several recovery policies and possibility of further customization
- support of several configuration sources
- static in the configuration file
- from the connection string optionally in the environmental variable
- custom implementation of the configuration provider
- support of standalone, cluster, and sentinel modes
- build on the top of Akka actors and serializers, agnostic to the serialization mechanism
- for simplicity, it uses deprecated Java serialization by default
- it is recommended to use Kryo library or any other mechanism
This library delivers a single module with following implementations of the API. While the core of the framework is fully non-blocking, most of the provided facades are only blocking wrappers.
CacheAsyncApi provides extended API to work with Redis and enables non-blocking connection providing results through
scala.concurrent.Future. Second, the
CacheApi is a thin blocking wrapper around the asynchronous implementation. Third, there are other implementations supporting contemporary versions of the
CacheApis bundled within Play framework. Finally,
play-redis also supports Java version of the API, though it is primarily designed for and more efficient with Scala.
Documentation and Getting Started
To use this module:
- Add this library into your project and expose APIs
- See the configuration options
- Browse examples of use
If you come from older version, you might check the Migration Guide
To ease the initial learning, there are several sample projects intended to demonstrate the most common configurations. Feel free to study, copy or fork them to better understand the
Getting Started is a very basic example showing the minimal configuration required to use the redis cache
Named Caches is the advanced example with custom recovery policy and multiple named caches.
EhCache and Redis shows a combination of both caching provides used at once. While the EhCache is bound to unqualified APIs, the Redis cache uses named APIs.
How to add the module into the project
To your SBT
build.sbt add the following lines:
// enable Play cache API (based on your Play version) libraryDependencies += play.sbt.PlayImport.cacheApi // include play-redis library libraryDependencies += "com.github.karelcemus" %% "play-redis" % "2.5.0"
|2.6.x||2.3.0||see here (Migration Guide)|
If you encounter any issue, have a feature request, or just like this library, please feel free to report it or contact me.
For the list of changes and migration guide please see the Changelog.
The library does not enable the redis module by default. It is to avoid conflict with Play's default EhCache and let the user define when use Redis. This allows you to use EhCache in your dev environment and Redis in production. You can also combine the modules using named caches.