# ws-cloud-gateway

**Repository Path**: tech-microworld/ws-cloud-gateway

## Basic Information

- **Project Name**: ws-cloud-gateway
- **Description**: 基于 openresty + etcd 实现的网关服务
- **Primary Language**: Lua
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://wetechlab.com/ws-cloud/gateway/
- **GVP Project**: No

## Statistics

- **Stars**: 42
- **Forks**: 16
- **Created**: 2020-05-10
- **Last Updated**: 2025-08-27

## Categories & Tags

**Categories**: api-gateway

**Tags**: None

## README

# ws-cloud-gateway

基于 openresty + etcd 实现的轻量级网关服务

- gateway: <https://github.com/tech-microworld/ws-cloud-gateway>
- dashboard: <https://github.com/tech-microworld/ws-cloud-admin>

## 简介

目前市面上已经有很多网关组件，ws-cloud-gateway 的定位是比更加轻量，只保留在实践中经常使用到的组件，同时可以自定义插件，针对不用业务，定制化个性功能。

项目中参考了 [incubator-apisix](https://github.com/apache/incubator-apisix)，同时有部分代码直接引用了apisix源码。

- [![Join the chat at https://gitter.im/ws-cloud-gateway/community](https://badges.gitter.im/ws-cloud-gateway/community.svg)](https://gitter.im/ws-cloud-gateway/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) Gitter 讨论组
- [使用文档](https://tech-microworld.github.io/ws-cloud/gateway/)

## 为什么选择 ws-cloud-gateway

1. 高性能：底层使用 nginx 异步事件驱动的网络通信模型
2. 轻量、灵活：将多个微服务组件整合到一起，对服务器开销小（节省服务器成本），适合初创业务，同时后期业务规模扩大后也容易调整
3. 上手简单学习曲线低，支持自定义插件，可灵活定制个性化功能
4. 上游服务节点使用etcd管理，可以通过推模式更新节点配置
5. 无需重启服务，可实时修改参数配置
6. 支持控制面板管理

## 性能测试

travis 自动化构建服务器测试，开2个worker进程，QPS: 23459.84，平均延迟: 0.7毫秒

```bash
# wrk 测试
$ ./bin/travis-runner.sh after_success
+case_opt=after_success
+shift
+case ${case_opt} in
+after_success
+cat benchmark/out/wrk.out
Running 5s test @ http://127.0.0.1:10000/innerapi/hello
  2 threads and 16 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency   719.30us  544.56us  13.10ms   79.90%
    Req/Sec    11.78k     1.38k   15.45k    72.55%
  Latency Distribution
     50%  693.00us
     75%    0.92ms
     90%    1.29ms
     99%    2.23ms
  119636 requests in 5.10s, 35.25MB read
  Non-2xx or 3xx responses: 119636
Requests/sec:  23459.84
Transfer/sec:      6.91MB
```


## 整体架构

![整体架构](./doc/img/resty-gateway.jpg)

服务启动时，将自己的节点信息注册到etcd，包括：服务名称、ip、端口

网关服务从 etcd 监听服务节点信息，保存到缓存中，从客户端请求的url中提取服务名称，通过服务名称查找节点信息，将请求转发到后端服务


## todo

- [x] 服务发现，动态路由
- [x] 自动生成 requestId，方便链路跟踪
- [x] 控制面板
- [x] gRPC 代理
- [ ] 动态ip防火墙
- [ ] 限流器
- [ ] 用户登录认证
- [ ] 接口协议加解密
- [ ] 统一配置管理

## 控制面板

![路由管理](./doc/img/routes.jpg)

![服务节点管理](./doc/img/services.jpg)

## 鸣谢

- [incubator-apisix](https://github.com/apache/incubator-apisix)

## 作者

![作者微信](./doc/img/author-wechat.jpeg)