Using Sorted Sets for Leaderboards in Go

Welcome to the next exciting part of our Redis-based backend system project. In this unit, we will focus on building leaderboard functionality using Redis's sorted sets with Go. Building a leaderboard is a popular use case for many applications, such as games and competitive platforms. You’ve got a good handle on managing user data from previous lessons, so let’s build on that foundation.

Let's briefly review what we’ll focus on in this unit. Our main tasks will be:

1. Adding user scores to a leaderboard: We will store user scores using Redis sorted sets.
2. Retrieving the leaderboard: We will fetch and display the top users and their scores.
3. Getting a user's rank and score: We will retrieve the ranking and score of a specific user.

Below are some key parts of the code you will be working with to perform these tasks.

package main

import (
    "context"
    "fmt"
    "github.com/redis/go-redis/v9"
)

var ctx = context.Background()

func main() {
    // Connect to Redis
    client := redis.NewClient(&redis.Options{
        Addr: "localhost:6379", // redis port
        DB:   0,                // use default DB
    })

    // Add user scores to the leaderboard
    client.ZAdd(ctx, "leaderboard", redis.Z{Score: 100, Member: "user1"})
    client.ZAdd(ctx, "leaderboard", redis.Z{Score: 200, Member: "user2"})
    client.ZAdd(ctx, "leaderboard", redis.Z{Score: 150, Member: "user3"})

    // Retrieve top users
    leaderboard, err := client.ZRevRangeWithScores(ctx, "leaderboard", 0, 2).Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(leaderboard)

    // Get user rank
    rank, err := client.ZRevRank(ctx, "leaderboard", "user3").Result()
    if err != nil {
        panic(err)
    }
    
    // Get user score
    score, err := client.ZScore(ctx, "leaderboard", "user3").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(rank, score)
}

This example demonstrates how to add a score for a user, retrieve the top scores, and fetch a user’s rank and score using Go. You are familiar with the ZAdd and ZRevRangeWithScores commands from previous lessons. These commands are used to add scores and retrieve the leaderboard, respectively.

Now let's understand the ZRevRank and ZScore commands. The ZRevRank command returns the rank of a member in a sorted set, with the highest score being ranked first. The ZScore command retrieves the score of a member in a sorted set. They both receive the set name and the member as parameters.

Now that you have an overview, let's dive into the practice section to start implementing these components. Your hands-on work will strengthen your understanding, setting you up for success in creating robust backend features.