Sentinel-CPP 项目教程

Sentinel-CPP 项目教程

sentinel-cppC++ implementation of Sentinel项目地址:https://gitcode.com/gh_mirrors/se/sentinel-cpp

1. 项目的目录结构及介绍

Sentinel-CPP 项目的目录结构如下：

sentinel-cpp/
├── CMakeLists.txt
├── LICENSE
├── README.md
├── bazel/
├── examples/
│   └── sentinel-cpp/
│       └── sentinel_basic_qps_limit/
├── include/
│   └── sentinel/
├── src/
│   └── sentinel/
└── tests/
    └── sentinel/

目录介绍

• CMakeLists.txt: 用于构建项目的 CMake 配置文件。
• LICENSE: 项目许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目说明文档。
• bazel/: 包含 Bazel 构建文件的目录。
• examples/: 包含示例代码的目录，如 sentinel_basic_qps_limit 示例。
• include/sentinel/: 包含项目头文件的目录。
• src/sentinel/: 包含项目源代码的目录。
• tests/sentinel/: 包含测试代码的目录。

2. 项目的启动文件介绍

项目的启动文件通常位于 examples 目录下。以 sentinel_basic_qps_limit 为例，其启动文件为：

// examples/sentinel-cpp/sentinel_basic_qps_limit/main.cpp

#include <iostream>
#include "sentinel/Sentinel.h"

int main() {
    // 初始化 Sentinel
    sentinel::init();

    // 设置 QPS 限制
    sentinel::setQpsLimit("example_resource", 10);

    // 模拟请求
    for (int i = 0; i < 20; ++i) {
        if (sentinel::tryAcquire("example_resource")) {
            std::cout << "Request allowed" << std::endl;
        } else {
            std::cout << "Request denied" << std::endl;
        }
    }

    return 0;
}

启动文件介绍

• 初始化 Sentinel: 调用 sentinel::init() 初始化 Sentinel。
• 设置 QPS 限制: 调用 sentinel::setQpsLimit("example_resource", 10) 设置资源 example_resource 的 QPS 限制为 10。
• 模拟请求: 通过循环模拟请求，调用 sentinel::tryAcquire("example_resource") 检查请求是否被允许。

3. 项目的配置文件介绍

Sentinel-CPP 项目的配置文件通常位于项目的根目录或 src 目录下。配置文件的格式可以是 JSON、YAML 或其他格式。以下是一个示例配置文件：

{
    "sentinel": {
        "log_level": "info",
        "rules": [
            {
                "resource": "example_resource",
                "limitApp": "default",
                "grade": 1,
                "count": 10,
                "strategy": 0
            }
        ]
    }
}

配置文件介绍

• log_level: 日志级别，可选值为 debug, info, warn, error。
• rules: 限流规则列表。
  • resource: 资源名称。
  • limitApp: 限制的应用名称。
  • grade: 限流模式，1 表示 QPS 模式。
  • count: 限流阈值。
  • strategy: 限流策略，0 表示直接拒绝。

以上是 Sentinel-CPP 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 Sentinel-CPP 项目。

sentinel-cppC++ implementation of Sentinel项目地址:https://gitcode.com/gh_mirrors/se/sentinel-cpp