shield-ratelimiter 开源项目使用教程

shield-ratelimiter 开源项目使用教程

shield-ratelimter基于Redis的分布式限流组件，注解支持项目地址:https://gitcode.com/gh_mirrors/sh/shield-ratelimter

1. 项目介绍

shield-ratelimiter 是一个基于 Redis 的分布式限流组件，旨在帮助开发者在分布式系统中有效控制接口的访问频率，防止因并发量突增导致的服务过载或系统宕机。该项目通过注解的方式简化了限流功能的集成，支持 Spring 框架，并且提供了灵活的配置选项。

2. 项目快速启动

2.1 环境准备

• JDK 1.8 或更高版本
• Redis 服务
• Maven 或 Gradle

2.2 引入依赖

在项目的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.github.TaXueWWL</groupId>
    <artifactId>shield-ratelimiter</artifactId>
    <version>1.0.0</version>
</dependency>

2.3 配置 Redis

在 application.properties 或 application.yml 中配置 Redis 连接信息：

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

2.4 使用注解进行限流

在需要限流的方法上添加 @RateLimiter 注解：

import com.github.TaXueWWL.shield.ratelimiter.annotation.RateLimiter;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @RateLimiter(limitTimes = 10, limitTimeout = 60)
    @GetMapping("/api/limited")
    public String limitedApi() {
        return "This is a limited API";
    }
}

2.5 启动项目

启动 Spring Boot 应用，访问 /api/limited 接口，系统会根据配置的限流规则进行访问控制。

3. 应用案例和最佳实践

3.1 应用案例

假设有一个电商网站，用户在秒杀活动中频繁请求某个商品的库存信息。为了避免因高并发导致的数据库压力过大，可以在查询库存的方法上添加 @RateLimiter 注解，限制每秒的请求次数。

@RateLimiter(limitTimes = 5, limitTimeout = 1)
@GetMapping("/api/stock")
public int getStock(String productId) {
    // 查询库存逻辑
}

3.2 最佳实践

• 合理配置限流参数：根据业务需求和服务器的承载能力，合理设置 limitTimes 和 limitTimeout 参数。
• 结合熔断机制：在限流的基础上，可以结合熔断机制，进一步提高系统的稳定性。
• 监控与日志：通过日志和监控工具，实时观察限流效果，及时调整限流策略。

4. 典型生态项目

• Spring Boot：shield-ratelimiter 与 Spring Boot 无缝集成，简化了限流功能的实现。
• Redis：作为限流的核心组件，Redis 提供了高效的键值存储和过期机制，适合用于分布式限流场景。
• Sentinel：阿里开源的熔断降级组件，可以与 shield-ratelimiter 结合使用，进一步提升系统的健壮性。

通过以上步骤，您可以快速上手并使用 shield-ratelimiter 项目，为您的分布式系统添加高效的限流功能。

shield-ratelimter基于Redis的分布式限流组件，注解支持项目地址:https://gitcode.com/gh_mirrors/sh/shield-ratelimter