Redis Cache Java

Redis Cache Java is a cache abstraction for the Java ecosystem that leverages enterprise Redis features like indexing and query. It provides an implementation of Spring Framework’s Cache Abstraction.

📚 Full documentation is available at https://redis-field-engineering.github.io/redis-cache-java

Repository Structure

This repository contains a demo application showcasing Redis Cache Java features:

redis-cache-java-dist/
├── demo/                    # Spring Boot demo application
│   ├── src/                # Demo source code
│   ├── build.gradle        # Demo build configuration
│   └── README.md           # Demo-specific instructions
├── infrastructure/          # Docker Compose setup
│   ├── docker-compose.yml  # Redis, Prometheus, Grafana
│   ├── prometheus/         # Prometheus configuration
│   └── grafana/            # Grafana dashboards
└── README.adoc             # This file

Quick Start

1. Start Infrastructure

cd infrastructure
docker compose up

This starts Redis, Prometheus, and Grafana.

2. Set TMDB Token

Register and create an API read-access token at themoviedb.org.

export TMDB_TOKEN=<your API read-access token>

3. Run the Demo

cd demo
./gradlew bootRun

4. Access the Application

• Demo App: http://localhost:8080

• Grafana Dashboard: http://localhost:3000/d/1 (username/password: admin/admin)

See demo/README.md for detailed instructions.

Documentation

For complete documentation including installation, usage, configuration, and features, visit:

https://redis-field-engineering.github.io/redis-cache-java

Topics covered:

• Quick Start - Complete walkthrough

• Usage - Installation and basic configuration

• Configuration - Detailed configuration options

• Async Mode - Non-blocking cache operations

• WebFlux Support - Reactive programming support

• Indexing and Querying - Search capabilities

• Client-Side Caching - Local caching

• Metrics - Monitoring and observability

Support

Redis Cache Java is supported by Redis, Inc. for enterprise-tier customers as a 'Developer Tool' under the Redis Software Support Policy. For non enterprise-tier customers we supply support for Redis Cache Java on a good-faith basis. To report bugs, request features, or receive assistance, please file an issue.

License

Redis Cache Java is licensed under the Business Source License 1.1. Copyright © 2024 Redis, Inc. See LICENSE for details.