Fluffy API Gateway

Fluffy 取自Harry Potter中三头犬，是一个基于 Vert.x 5.0 的高性能 API 网关。

本项目仅供个人学习使用，不保证稳定性，且不提供任何技术支持

系统架构

graph TB
    subgraph Client["客户端"]
        B[Browser]
        M[Mobile App]
        S[Service-to-Service]
    end

    subgraph Gateway["Fluffy API Gateway"]
        HTTP[HTTP Server<br/>:8888]
        ADMIN[Admin Server<br/>:8889]

        subgraph Security["安全层"]
            SC[SecurityChecker]
            RL[RateLimiter]
            JWT[JwtHandler]
            AK[ApiKeyHandler]
        end

        subgraph Core["核心层"]
            RH[RouteHandler]
            LB[LoadBalancer]
            BC[BackendClient]
        end

        subgraph Data["数据层"]
            Cache[(Route Cache<br/>In-Memory)]
            Redis[(Redis<br/>Session/Cache)]
            MySQL[(MySQL/MariaDB<br/>Persistent)]
        end
    end

    subgraph Backend["后端服务"]
        SVC1[Service A]
        SVC2[Service B]
        SVC3[Service N]
    end

    B --> HTTP
    M --> HTTP
    S --> HTTP

    HTTP --> Security
    Security --> Core
    Core --> RH
    RH --> Cache
    RH --> LB
    LB --> BC
    BC --> SVC1
    BC --> SVC2
    BC --> SVC3

    SC --> Redis
    RL --> Redis
    RH --> MySQL
    LB --> MySQL

Loading

技术栈

组件	技术	版本
核心框架	Vert.x	5.0.10
数据库	MySQL/MariaDB	8.x
缓存	Redis	6.x
数据库客户端	vertx-mysql-client	5.0.10
缓存客户端	vertx-redis-client	5.0.10
构建工具	Maven	3.x
Java	OpenJDK	11

核心模块

模块	说明	文档
路由模块	动态路由匹配与缓存	详情
负载均衡	多策略负载均衡	详情
安全认证	JWT/API Key 认证	详情
黑白名单	访问控制	详情
限流器	Redis 滑动窗口限流	详情
断路器	服务熔断保护	详情
配置管理	配置加载与管理	详情

功能列表

• 路由管理 - 基于路径、方法的动态路由匹配
• 负载均衡 - 支持轮询、随机、加权、一致性哈希
• 安全认证 - JWT、API Key 认证
• 黑白名单 - IP、用户、API Key 维度访问控制
• 限流 - 基于 Redis 的滑动窗口限流
• 断路器 - 服务熔断保护
• 日志监控 - 异步访问日志写入数据库
• 聚合 - 多个服务响应聚合
• 金丝雀发布 - 灰度流量控制

快速开始

前置条件

• JDK 11+
• Maven 3.6+
• MySQL 8.0+
• Redis 6.x+

配置

创建 src/main/resources/application.conf 配置文件（JSON 格式）：

{
  "db": {
    "host": "localhost",
    "port": 3306,
    "database": "fluffy",
    "username": "root",
    "password": "your_password",
    "maxPoolSize": 10,
    "connectionTimeout": 30000
  },
  "redis": {
    "host": "localhost",
    "port": 6379,
    "maxPoolSize": 10,
    "timeout": 5000
  },
  "app": {
    "port": 8888,
    "adminPort": 8889
  },
  "gateway": {
    "requestTimeout": 30000,
    "maxConcurrentRequests": 10000
  }
}

构建

# 运行测试
./mvnw clean test

# 打包
./mvnw clean package

# 运行应用
./mvnw clean compile exec:java

License

MIT