{
  "id": "java-jedis",
  "title": "Redis leaderboard with Java and Jedis",
  "url": "https://redis.io/docs/latest/develop/use-cases/leaderboard/java-jedis/",
  "summary": "Implement a Redis leaderboard in Java with Jedis and sorted sets",
  "tags": [
    "docs",
    "develop",
    "stack",
    "oss",
    "rs",
    "rc"
  ],
  "last_updated": "2026-04-28T13:01:52-05:00",
  "children": [],
  "page_type": "content",
  "content_hash": "45d8ba07d506a3804735743487d54e80f5e21810cd07033e501df5db91d39fa7",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "This guide shows you how to implement a Redis-backed leaderboard in Java with the [`Jedis`](https://redis.io/docs/latest/develop/clients/jedis) client library. It uses a sorted set to store rank order, Redis hashes to store per-user metadata, and a small local web server so you can explore the leaderboard interactively in your browser."
    },
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Leaderboards are a classic Redis pattern. A sorted set stores each member together with a numeric score, and Redis maintains the ranking order automatically.\n\nThat gives you:\n\n* Fast score updates for existing users\n* Simple top `n` leaderboard queries\n* Efficient queries for entries around a specific rank position\n* Straightforward trimming to a fixed leaderboard size\n* A clean separation between rank data and richer user metadata\n\nIn this example, the leaderboard score data is stored in a sorted set called `leaderboard:demo`, and each user's metadata is stored in a hash such as `leaderboard:demo:user:player-17`."
    },
    {
      "id": "how-it-works",
      "title": "How it works",
      "role": "content",
      "text": "The flow looks like this:\n\n1. Store each user ID in a sorted set with their score\n2. Store per-user metadata in a separate Redis hash keyed by user ID\n3. Fetch the highest-ranked users with a reverse range query\n4. Fetch users around a given rank by calculating a rank window\n5. Trim the leaderboard after updates so only the top configured entries remain\n\nSeparating rank data from metadata keeps leaderboard operations efficient while still letting the application render richer profile details."
    },
    {
      "id": "installation",
      "title": "Installation",
      "role": "setup",
      "text": "Add the Jedis dependency to your project:\n\n* If you use **Maven**:\n\n  [code example]\n\n* If you use **Gradle**:\n\n  [code example]"
    },
    {
      "id": "the-java-leaderboard",
      "title": "The Java leaderboard",
      "role": "content",
      "text": "The `RedisLeaderboard` class wraps common leaderboard operations\n([source](RedisLeaderboard.java)):\n\n[code example]"
    },
    {
      "id": "data-model",
      "title": "Data model",
      "role": "content",
      "text": "The implementation uses two Redis structures:\n\n[code example]\n\nThe score data lives in the sorted set, while the user details live in hashes keyed by the same user ID.\n\nThe implementation uses:\n\n* [`ZADD`](https://redis.io/docs/latest/commands/zadd) to add or update leaderboard scores\n* [`ZRANGE`](https://redis.io/docs/latest/commands/zrange) with the `REV` option to fetch the highest-ranked members\n* [`ZREVRANK`](https://redis.io/docs/latest/commands/zrevrank) to find a user's rank from the top\n* [`ZREMRANGEBYRANK`](https://redis.io/docs/latest/commands/zremrangebyrank) to trim the lowest-ranked overflow entries\n* [`HSET`](https://redis.io/docs/latest/commands/hset) and [`HGETALL`](https://redis.io/docs/latest/commands/hgetall) to store and load user metadata\n* [`DEL`](https://redis.io/docs/latest/commands/del) to remove metadata for trimmed or deleted users"
    },
    {
      "id": "leaderboard-implementation",
      "title": "Leaderboard implementation",
      "role": "content",
      "text": "The `upsertUser()` method writes the score, updates metadata, and then trims the board if it exceeds the configured limit:\n\n[code example]\n\nTo fetch users around a rank, the implementation converts the requested rank and count into a reverse range window:\n\n[code example]\n\nJedis operations are synchronous and thread-safe when you use `JedisPool`, which manages a pool of connections internally."
    },
    {
      "id": "metadata-design",
      "title": "Metadata design",
      "role": "content",
      "text": "The leaderboard stores only user IDs and scores in the sorted set. Richer details stay in a separate per-user hash. That means the same user ID can be ranked efficiently while still exposing extra fields such as:\n\n* Display name\n* Short description\n* Team or country\n* Avatar URL\n* Other lightweight profile fields\n\nThis is a useful pattern when the ranking view and the profile view need different data shapes."
    },
    {
      "id": "running-the-demo",
      "title": "Running the demo",
      "role": "content",
      "text": "A local demo server is included to show the leaderboard in action\n([source](DemoServer.java)):\n\n[code example]\n\nThe demo provides an interactive web interface where you can:\n\n* Add or update a player score and metadata\n* Increase a player's score incrementally\n* View the top `n` players on the leaderboard\n* View the `n` players around a chosen rank\n* Change the maximum number of entries the leaderboard keeps\n* Reset the demo dataset to a known starting state\n\nThe demo assumes Redis is running on `localhost:6379` but you can specify a different host and port using the `--redis-host HOST` and `--redis-port PORT` command-line arguments. Visit `http://localhost:8080` in your browser to try it out."
    },
    {
      "id": "production-usage",
      "title": "Production usage",
      "role": "content",
      "text": "This guide uses a deliberately small local demo so you can focus on the Redis leaderboard pattern. In production, you will usually want to add more validation, tighter concurrency control, and application-specific lifecycle rules."
    },
    {
      "id": "decide-how-ties-should-behave",
      "title": "Decide how ties should behave",
      "role": "content",
      "text": "Redis sorted sets order primarily by score. When two members have the same score, Redis uses the member value as a secondary ordering rule. If your application needs a different tie-breaker, you may want to encode it in the score or store additional state."
    },
    {
      "id": "consider-how-you-expire-or-archive-old-data",
      "title": "Consider how you expire or archive old data",
      "role": "content",
      "text": "Some leaderboards are permanent, while others reset daily, weekly, or seasonally. Depending on your use case, you may want to:\n\n* Namespace keys by season or event\n* Snapshot historical results elsewhere\n* Rebuild the current leaderboard from upstream data"
    },
    {
      "id": "keep-metadata-lightweight",
      "title": "Keep metadata lightweight",
      "role": "content",
      "text": "Per-user hashes work best for small, frequently accessed profile details. Large profile documents or rarely used attributes are often better kept in another store, with Redis holding only the fields needed to render the leaderboard quickly."
    }
  ],
  "examples": [
    {
      "id": "installation-ex0",
      "language": "xml",
      "code": "<dependency>\n      <groupId>redis.clients</groupId>\n      <artifactId>jedis</artifactId>\n      <version>5.2.0</version>\n  </dependency>",
      "section_id": "installation"
    },
    {
      "id": "installation-ex1",
      "language": "groovy",
      "code": "implementation 'redis.clients:jedis:5.2.0'",
      "section_id": "installation"
    },
    {
      "id": "the-java-leaderboard-ex0",
      "language": "java",
      "code": "import java.util.Map;\n\nimport redis.clients.jedis.JedisPool;\n\npublic class Main {\n    public static void main(String[] args) {\n        JedisPool jedisPool = new JedisPool(\"localhost\", 6379);\n\n        RedisLeaderboard board = new RedisLeaderboard(\n                jedisPool,\n                \"leaderboard:demo\",\n                100\n        );\n\n        board.upsertUser(\n                \"player-1\",\n                1200,\n                Map.of(\n                        \"name\", \"Ada\",\n                        \"description\", \"Solves production incidents before breakfast.\"\n                )\n        );\n\n        board.incrementScore(\"player-1\", 25, Map.of());\n        System.out.println(board.getTop(5));\n    }\n}",
      "section_id": "the-java-leaderboard"
    },
    {
      "id": "data-model-ex0",
      "language": "text",
      "code": "leaderboard:demo\n  player-1 => 1225\n  player-2 => 1180\n  player-3 => 1105\n\nleaderboard:demo:user:player-1\n  name = Ada\n  description = Solves production incidents before breakfast.",
      "section_id": "data-model"
    },
    {
      "id": "leaderboard-implementation-ex0",
      "language": "java",
      "code": "public LeaderboardEntry upsertUser(\n        String userId,\n        double score,\n        Map<String, String> metadata\n) {\n    Map<String, String> payload = coerceMetadata(metadata);\n\n    try (Jedis jedis = jedisPool.getResource()) {\n        Transaction tx = jedis.multi();\n        tx.zadd(key, score, userId);\n        if (!payload.isEmpty()) {\n            tx.hset(metadataKey(userId), payload);\n        }\n        tx.exec();\n    }\n\n    List<String> trimmedUserIds = trimToMaxEntries();\n    LeaderboardEntry entry = getUserEntry(userId);\n    if (entry != null) {\n        entry = entry.withTrimmedUserIds(trimmedUserIds);\n    }\n    return entry;\n}",
      "section_id": "leaderboard-implementation"
    },
    {
      "id": "leaderboard-implementation-ex1",
      "language": "java",
      "code": "public List<LeaderboardEntry> getAroundRank(int rank, int count) {\n    int normalizedRank = normalizePositiveInt(rank, \"rank\");\n    int normalizedCount = normalizePositiveInt(count, \"count\");\n    long totalEntries = getSize();\n\n    if (totalEntries <= normalizedCount) {\n        return listAll();\n    }\n\n    int halfWindow = normalizedCount / 2;\n    int start = Math.max(0, normalizedRank - 1 - halfWindow);\n    int maxStart = (int) totalEntries - normalizedCount;\n    if (start > maxStart) {\n        start = maxStart;\n    }\n    int end = start + normalizedCount - 1;\n\n    try (Jedis jedis = jedisPool.getResource()) {\n        Set<Tuple> entries = jedis.zrangeWithScores(\n                key,\n                ZRangeParams.zrangeParams(start, end).rev()\n        );\n        return hydrateEntries(entries, start + 1);\n    }\n}",
      "section_id": "leaderboard-implementation"
    },
    {
      "id": "running-the-demo-ex0",
      "language": "bash",
      "code": "# Compile\njavac -cp jedis-5.2.0.jar RedisLeaderboard.java DemoServer.java\n\n# Run the demo server\njava -cp .:jedis-5.2.0.jar DemoServer",
      "section_id": "running-the-demo"
    }
  ]
}