SnowJena 开源项目教程

1. 项目介绍

SnowJena 是一个基于令牌桶算法实现的分布式无锁限流框架。它支持动态配置规则、可视化监控，并且开箱即用。SnowJena 可以完美嵌入 SpringBoot 和 SpringCloud 应用中，支持接口限流、方法限流、系统限流、IP 限流、用户限流等多种限流规则。此外，它还支持熔断降级和流量塑形，提供快速拒绝与匀速器两种限流方案。

2. 项目快速启动

2.1 环境准备

确保你已经安装了以下环境：

• Java 8 或更高版本
• Maven 3 或更高版本

2.2 添加依赖

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

<dependency>
    <groupId>com.github.onblog</groupId>
    <artifactId>snowjena-core</artifactId>
    <version>4.0.0.RELEASE</version>
</dependency>

2.3 配置限流规则

创建一个限流规则配置类：

import com.github.onblog.snowjena.core.RateLimiter;
import com.github.onblog.snowjena.core.RateLimiterFactory;
import com.github.onblog.snowjena.core.RateLimiterRule;
import com.github.onblog.snowjena.core.RateLimiterRuleBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.junit.Test;

import java.util.concurrent.TimeUnit;

public class AppTest {
    Logger logger = LoggerFactory.getLogger(getClass());

    /**
     * 本地限流
     */
    @Test
    public void test1() {
        // 1. 配置规则
        RateLimiterRule rateLimiterRule = new RateLimiterRuleBuilder()
                .setLimit(1)
                .setPeriod(1)
                .setUnit(TimeUnit.SECONDS) // 每秒令牌数为1
                .build();

        // 2. 工厂模式生产限流器
        RateLimiter limiter = RateLimiterFactory.of(rateLimiterRule);

        // 3. 使用
        while (true) {
            if (limiter.tryAcquire()) {
                logger.info("ok");
            }
        }
    }
}

2.4 运行测试

运行上述测试类，观察控制台输出，确保限流功能正常工作。

3. 应用案例和最佳实践

3.1 接口限流

在 Spring Boot 项目中，可以通过注解的方式对特定接口进行限流：

import com.github.onblog.snowjena.annotation.CurrentLimiting;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @CurrentLimiting(limit = 10, period = 1, unit = TimeUnit.SECONDS)
    @GetMapping("/api/limited")
    public String limitedApi() {
        return "This is a limited API";
    }
}

3.2 系统限流

在系统启动时，可以通过配置文件对整个系统进行限流：

snowjena:
  limit: 1000
  period: 1
  unit: SECONDS

3.3 熔断降级

在微服务架构中，可以通过 SnowJena 实现服务的熔断降级，防止因某个服务异常导致整个系统崩溃。

4. 典型生态项目

4.1 Spring Boot

SnowJena 可以完美集成到 Spring Boot 项目中，提供开箱即用的限流功能。

4.2 Spring Cloud

在 Spring Cloud 微服务架构中，SnowJena 可以作为服务间的限流工具，确保服务在高并发情况下的稳定性。

4.3 其他生态

SnowJena 还可以与其他监控工具（如 Prometheus、Grafana）集成，实现流量的实时监控和可视化。

---

通过以上步骤，你可以快速上手并使用 SnowJena 进行分布式限流。希望这篇教程对你有所帮助！