Masla

A fully asynchronous Java API gateway, validated with millions of concurrent C-end users, supporting multiple access protocols including HTTP, HTTPS, and HTTP/2.

Performance

架构设计经历过C端100万并发流量的验证，基于nacos注册服务发现，微服务路由配置化重新设计，使用更简单。

Dependency

only dependency nacos, not dependency other compensate

Feature

🧭 服务发现（Service Discovery）

Masla API 网关当前仅支持 Nacos 作为服务注册中心。
它通过 Nacos 实现服务发现，自动感知服务的动态变更，确保请求始终路由到可用的服务实例。

---

🚦 流量控制（Traffic Control）

Masla 默认支持流量控制，基于 令牌桶算法 实现。

• 可为每个 API 单独配置限流策略
• 当前支持的是 单节点限流

---

⚡ 熔断机制（Traffic Circuit Breaking）

Masla 内置熔断机制：

• 当异常比例达到 50% 时自动触发熔断
• 熔断后流量将不再转发至异常服务
• 支持智能 自动升级 与 自动恢复

---

🔒 黑白名单（Black/White List）

支持多维度的访问控制：

• 服务级别控制，支持路径（Path）、客户端 IP、Header 参数匹配等方式
• 支持 全局黑名单 配置，统一限制不可信流量源

---

🌱 慢启动机制（Warm-up / Slow Start）

针对新加入的服务实例：

• 支持慢启动策略，流量在一段预热窗口内 逐步增加
• 类似 TCP 的慢启动机制
• 预热窗口结束后进入正常流量分发

---

🔁 负载均衡（Load Balancing）

Masla 默认提供 Round-Robin（轮询） 负载均衡策略：

• 请求将按顺序分发到所有可用实例
• 支持后续扩展其他负载均衡策略（如权重、最小连接数等）

---

❤️ 健康检查（Health Check）

• 要求服务实现 /healthcheck 接口
• Masla 会定期调用该接口，判断服务健康状态
• 可用于实现 无损下线、灰度发布、零停机部署

---

❤️ 可观测 Metrics

支持prometheus 上报，可以通过访问：http://localhost:port/actuator/prometheus 查看metric数据,port是gateway配置的端口

API指标 (masla_api_*)

所有API指标都包含以下标签:

• service_name: 应用名称
• service_id: 服务ID
• host: 主机地址

主要指标:

• masla_api_qps_total: API QPS总数
• masla_api_peak_qps_total: 峰值QPS
• masla_api_success_total: 成功请求数
• masla_api_timeout_total: 超时请求数
• masla_api_reject_total: 拒绝请求数
• masla_api_4xx_total: 4XX状态码数量
• masla_api_5xx_total: 5XX状态码数量
• masla_api_circuit_total: 熔断次数
• masla_api_flow_control_total: 流控次数
• masla_api_latency_tp50_ms: TP50延迟（毫秒）
• masla_api_latency_tp90_ms: TP90延迟（毫秒）
• masla_api_latency_tp99_ms: TP99延迟（毫秒）
• masla_api_in_bandwidth_bytes: 入站带宽（字节）
• masla_api_out_bandwidth_bytes: 出站带宽（字节）

Session指标 (masla_session_*)

• masla_session_total: 总Session数
• masla_session_https1_total: HTTP/1.1 Session数
• masla_session_https2_total: HTTP/2 Session数

Architect

Startup

1. 执行 Maven 打包命令 在项目根目录下打开终端，执行以下命令：

mvn clean package

该命令会清理之前的构建文件，并重新编译和打包项目，生成可部署的压缩包 masla-0.0.1.tar.gz（文件名根据版本号可能不同）。

2. 解压压缩包

找到打包生成的压缩包文件 masla-0.0.1.tar.gz，执行如下命令解压：

tar -zxvf masla-0.0.1.tar.gz

解压后会生成一个目录，里面包含了所有可运行的程序文件。

3. 修改 masla.sh 中的 Nacos 配置 找到和 Nacos 注册中心相关的配置项，按需修改地址、端口、命名空间等参数，确保与实际的 Nacos 服务环境匹配。

4. 配置Nacos

masla.properties 是masla gateway本身的配置文件，用来配置对外端口，线程数，等其他配置项：

• dataid: masla.properties
• Group: DEFAULT_GROUP

masla.properties 如下：

#server config
masla.server.port=6081
masla.server.backlog=10340
masla.server.maxSession=30000

masla.server.protocol.support.https=false
masla.server.processor.processorCount=10
masla.server.readTimeout=10000
masla.server.client.maxConnections=10

#server client
masla.server.client.io.work.threadCount=10
masla.server.client.io.work.slow.threadCount=2

#circuit config
masla.circuit.open.min.request.threshold=1
masla.circuit.open.trigger.second.threshold=1

接入业务的路由配置文件route.properties, 负责service的路由，限流，黑白名单的配置

• dataid: route.properties
• Group: DEFAULT_GROUP

route.properties 是gateway的路由配置文件，demo如下：

masla.gateway.routes.service.demo.name=demo
masla.gateway.routes.service.demo.pattern=^/demo/*
masla.gateway.routes.service.demo.timeout=2000
masla.gateway.routes.service.demo.filter.flowLimit.maxfreq=100
masla.gateway.routes.service.demo.filter.flowLimit.interval=1

masla.gateway.routes.service.gateway.pattern=^/gateway/*
masla.gateway.routes.service.test1.timeout=1000

#service level black filter
masla.gateway.routes.service.test1.filter.black.path=/test/xxx/sss
masla.gateway.routes.service.test1.filter.black.ip=192.168.10.1
masla.gateway.routes.service.test1.filter.black.queryString.key=RR
masla.gateway.routes.service.test1.filter.black.queryString.value=RR
masla.gateway.routes.service.test1.filter.black.header.key=RR
masla.gateway.routes.service.test1.filter.black.header.value=RR

#service level flowlimit
masla.gateway.routes.service.test1.filter.flowLimit.path=/demo/echo/test
masla.gateway.routes.service.test1.filter.flowLimit.maxfreq=1000
masla.gateway.routes.service.test1.filter.flowLimit.interval=2

#global black filter
masla.gateway.routes.global.filter.black.path=/demo/echo/test
masla.gateway.routes.global.filter.black.queryString.key=RR
masla.gateway.routes.global.filter.black.queryString.value=RR
masla.gateway.routes.global.filter.black.header.key=test
masla.gateway.routes.global.filter.black.header.value=black1

6. 启动 masla gateway

执行启动脚本启动服务：

sh run.sh start

该命令会启动 masla gateway 服务，确认启动成功后即可开始使用。

RoadMap

1. support protocol exchange http to dubbo

Ask

1. please contract weixin:gavinpeng2014,weibo@财码农