SnowJena 项目使用教程

1. 项目目录结构及介绍

SnowJena 是一个基于令牌桶算法实现的分布式无锁限流框架。以下是项目的目录结构及其介绍：

SnowJena/
├── snowjena-spring-boot-starter/
├── snowjena-common/
├── snowjena-core/
├── snowjena-monitor/
├── snowjena-ticket-server/
├── spring-boot-demo/
├── .gitattributes
├── .gitignore
├── CN_README.md
├── EN_README.md
├── LICENSE
├── README.md
├── _config.yml
└── pom.xml

• snowjena-spring-boot-starter: Spring Boot 启动器模块，用于快速集成 SnowJena 到 Spring Boot 项目中。
• snowjena-common: 公共模块，包含一些通用的工具类和配置。
• snowjena-core: 核心模块，实现了令牌桶算法和限流逻辑。
• snowjena-monitor: 监控模块，提供可视化监控功能。
• snowjena-ticket-server: 令牌服务器模块，用于管理令牌的生成和分发。
• spring-boot-demo: Spring Boot 示例项目，展示了如何使用 SnowJena 进行限流。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CN_README.md: 中文项目介绍文档。
• EN_README.md: 英文项目介绍文档。
• LICENSE: 项目许可证文件。
• README.md: 项目主介绍文档。
• _config.yml: 项目配置文件。
• pom.xml: Maven 项目配置文件。

2. 项目启动文件介绍

SnowJena 项目的主要启动文件位于 spring-boot-demo 模块中。以下是启动文件的介绍：

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");
            }
        }
    }
}

• AppTest.java: 这是一个示例测试类，展示了如何在本地环境中使用 SnowJena 进行限流。通过配置 RateLimiterRule 和使用 RateLimiterFactory 创建限流器，可以实现对请求的限流控制。

3. 项目的配置文件介绍

SnowJena 项目的配置文件主要包括 pom.xml 和 _config.yml。以下是这些配置文件的介绍：

pom.xml

pom.xml 是 Maven 项目的配置文件，定义了项目的依赖、插件和其他构建配置。以下是 pom.xml 的部分内容：

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

• 依赖配置: 通过 dependency 标签定义了项目所需的依赖，例如 snowjena-core 模块。

_config.yml

_config.yml 是项目的配置文件，用于定义项目的全局配置。以下是 _config.yml 的部分内容：

# 项目配置
project:
  name: SnowJena
  version: 4.0.0.RELEASE
  description: 基于令牌桶算法实现的分布式无锁限流框架

• 项目配置: 定义了项目的名称、版本和描述等信息。

通过以上配置文件，可以对 SnowJena 项目进行灵活的配置和管理。