重学SpringBoot3-集成Redis（十三）之点排行榜实现

在现代应用程序中，排行榜功能经常被用来展示用户的成绩或表现。使用 Redis 来实现排行榜是一个常见且高效的模式，因为 Redis 提供了丰富的数据结构和高性能的读写能力。本篇文章将介绍如何在 Spring Boot 3 中集成 Redis 来实现一个简单的点排行榜。

一、环境准备

首先，确保你已经在项目中添加了 Redis 相关的依赖。在 pom.xml 中添加如下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

然后在 application.properties 文件中配置 Redis 连接信息：

spring.redis.host=localhost
spring.redis.port=6379

二、创建排行榜服务

接下来，我们创建一个排行榜服务 LeaderboardService，用于管理排行榜的逻辑。我们将使用 Redis 的有序集合（Sorted Set）特性来实现。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

import java.util.Set;

@Service
public class LeaderboardService {

    private final RedisTemplate<String, Object> redisTemplate;

    @Autowired
    public LeaderboardService(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    private final String LEADERBOARD_KEY = "leaderboard";

    // 添加用户得分
    public void addScore(String username, double score) {
        redisTemplate.opsForZSet().incrementScore(LEADERBOARD_KEY, username, score);
    }

    // 获取排行榜前N名
    public Set<Object> getTopN(int n) {
        return redisTemplate.opsForZSet().reverseRange(LEADERBOARD_KEY, 0, n - 1);
    }

    // 获取用户的分数
    public Double getUserScore(String username) {
        return redisTemplate.opsForZSet().score(LEADERBOARD_KEY, username);
    }
}

三、创建控制器

创建一个控制器 LeaderboardController，通过 RESTful 接口暴露排行榜功能。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.Set;

@RestController
@RequestMapping("/api/leaderboard")
public class LeaderboardController {

    private final LeaderboardService leaderboardService;

    @Autowired
    public LeaderboardController(LeaderboardService leaderboardService) {
        this.leaderboardService = leaderboardService;
    }

    @PostMapping("/add")
    public ResponseEntity<String> addScore(@RequestParam String username, @RequestParam double score) {
        leaderboardService.addScore(username, score);
        return ResponseEntity.ok("Score added successfully.");
    }

    @GetMapping("/top/{n}")
    public ResponseEntity<Set<Object>> getTopN(@PathVariable int n) {
        Set<Object> topUsers = leaderboardService.getTopN(n);
        return ResponseEntity.ok(topUsers);
    }

    @GetMapping("/score/{username}")
    public ResponseEntity<Double> getUserScore(@PathVariable String username) {
        Double score = leaderboardService.getUserScore(username);
        return ResponseEntity.ok(score);
    }
}

四、测试接口

启动 Spring Boot 应用后，你可以通过 Postman 或者其他 API 测试工具来测试我们的排行榜功能。

1. 添加分数

使用 POST 请求添加用户得分： POST /api/leaderboard/add?username=user1&score=10

1. 获取前 N 名

使用 GET 请求来获取前 5 名用户： GET /api/leaderboard/top/5

1. 获取用户分数

使用 GET 请求来获取特定用户的分数： GET /api/leaderboard/score/user1

五、总结

本文简要介绍了如何在 Spring Boot 3 中集成 Redis，并实现一个简单的点排行榜，通过 Redis 的有序集合来存储和管理排行榜数据。这种实现方式不仅效率高，还能轻松扩展以适应未来的需求。在实际开发中，你可以根据业务的复杂度进一步优化和扩展排行榜的功能。希望本文能对你有所帮助！