# great-wall

**Repository Path**: lulihu/great-wall

## Basic Information

- **Project Name**: great-wall
- **Description**: 基于 springboot3 + kotlin + graalvm21 构建的云网关
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2023-12-11
- **Last Updated**: 2026-04-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Great Wall

> 基于 springboot3 + kotlin + graalvm21 构建的网关服务，方便个人使用，如果是企业建议使用 openresty 

## 说明

### 特性

* 完善的页面路由配置
* 丰富的路由插件
* 监控 + 日志一应俱全
* 支持自定义证书 和 [来此加密](https://letsencrypt.osfipin.com/) 证书自动续签
* 使用 graalvm 本地化构建，资源占有率极低，内存稳定在 200MB 以下

## 使用

使用以下任意一种方式启动服务后，打开浏览器输入 [http://127.0.0.1:8080](http://127.0.0.1:8080)，默认管理员账号为 `admin` 默认密码为 `123456789`，**建议生产中通过环境变量 `ADMIN_PASSWORD` 修改管理员密码**

### dcker

以下镜像版本可能非最新版本，最新版本请参考：https://hub.docker.com/r/moailaozi/great-wall/tags

```bash
// java -jar 方式运行
docker run -d -p 8080:8080 -p 443:443 -p 80:80 --name great-wall moailaozi/great-wall:bootJar

// 本地化镜像运行，使用 serial gc(串行垃圾回收器)，适合小内存应用
docker run -d -p 8080:8080 -p 443:443 -p 80:80 --name great-wall moailaozi/great-wall:latest

// 本地化镜像运行，使用 g1 gc(G1 垃圾回收器)，适合大内存高吞吐低延迟的应用
docker run -d -p 8080:8080 -p 443:443 -p 80:80 --name great-wall moailaozi/great-wall:g1gc
```

### 服务配置

当前服务支持的环境变量配置一览

| 名称                                      | 说明                                                         |
| ----------------------------------------- | ------------------------------------------------------------ |
| TLS_PORT                                  | 证书绑定的端口，默认为 443                                   |
| PORT                                      | 非证书绑定端口，默认为 80                                    |
| CONFIG_SERVER_PORT                        | 后台管理页面端口，默认为 8080                                |
| WEBSOCKET_MAX_FRAME_PAYLOAD_LENGTH        | 代理 websockt 最大帧数字节长度，默认为 6553500               |
| HTTPCLIENT_POOL_MAX_IDLE_TIME             | http 链接最大空闲时间，默认60S                               |
| HTTPCLIENT_POOL_MAX_LIFE_TIME             | http 链接最大存活时间，默认10H                               |
| HTTPCLIENT_POOL_EVICTION_INTERVAL         | http 链接存货检测时间间隔，默认 10S                          |
| ADMIN_PASSWORD                            | 管理员密码配置，**强烈建议：生产环境进行必要的修改**         |
| GREAT_WALL_MAX_MEMORY                     | 配置java最大堆内存，默认为200m，g1gc下默认为1g               |
| MAIN_SERVER_IO_SELECT_COUNT               | 选择器线程数，默认为1，用于接受请求                          |
| MAIN_SERVER_IO_WORK_COUNT                 | 工作线程数，默认为当前处理器内核数量，最小值为4，用于处理请求 |
| HTTPCLIENT_SSL_USE_INSECURE_TRUST_MANAGER | 是否信任所有客户端证书                                       |
| HTTPCLIENT_CONNECT_TIMEOUT                | 客户端请求超时时间，单位毫秒，默认值 3000                    |
| HTTP_2_ENABLED                            | 是否启用Http2，默认值为 true 开启                            |

## 二次开发

linux，mac电脑直接运行，如果是windows电脑建议在 wsl 中运行，如果不想在 wsl 中执行，则请事先配置好环境，node 18+，pnpm  8+，graal jdk 21+

```shell
# 安装初始环境
nvm install
sdk env install

# 初始化环境
nvm install
sdk env

# 编译前端项目
cd great-wall-fe &&  pnpm i && pnpm run build

# 编译后端项目
./gradlew clean bootJar -x test --no-daemon
```



## 规划

- [x] 路由支持插件配置
- [x] 支持监控
- [x] 支持静态资源映射
- [ ] 路由配置支持路由组概念
- [ ] 支持 ddns 功能
- [ ] 支持 waf 防火墙规则
- [ ] 支持一些服务发现插件，进行动态刷新路由

## 系统截图

![image-20240718105359955](./assets/image-20240718105359955.png)

![image-20240718105452969](./assets/image-20240718105452969.png)

![image-20240718105534686](./assets/image-20240718105534686.png)

![image-20240718105608910](./assets/image-20240718105608910.png)

![image-20240718105626545](./assets/image-20240718105626545.png)

![image-20240718105837280](./assets/image-20240718105837280.png)

![image-20240718105709099](./assets/image-20240718105709099.png)

![image-20240718105721332](./assets/image-20240718105721332.png)

## 使用技术

本项目使用了以下语言或框架，感谢开源

* [SpringBoot3 + SpringCloudGateway](https://spring.io/projects/spring-cloud-gateway)
* [kotlin](https://book.kotlincn.net/text/getting-started.html)
* [react](https://zh-hans.react.dev/learn)
* [shadcn ui](https://ui.shadcn.com/)
* [type script](https://www.tslang.cn/)
* [graalvm](https://www.graalvm.org/)
* [gradle](https://gradle.org/)
* [vite](https://vitejs.cn/vite3-cn/guide/)
* 等等….