Guble 开源项目使用教程
gublewebsocket based messaging server written in golang项目地址:https://gitcode.com/gh_mirrors/gu/guble
1. 项目目录结构及介绍
Guble 项目的目录结构如下:
guble/
├── cmd/
│ ├── guble-server/
│ │ └── main.go
│ └── guble-client/
│ └── main.go
├── config/
│ └── config.go
├── docs/
│ └── README.md
├── internal/
│ ├── api/
│ ├── auth/
│ ├── broker/
│ ├── connector/
│ ├── message/
│ ├── store/
│ └── util/
├── pkg/
│ ├── client/
│ ├── protocol/
│ └── server/
├── scripts/
│ └── build.sh
├── vendor/
├── .gitignore
├── Dockerfile
├── go.mod
├── go.sum
└── README.md
目录结构介绍
- cmd/: 包含项目的启动文件,分为
guble-server
和guble-client
两个子目录,分别对应服务端和客户端的启动文件。 - config/: 包含项目的配置文件,主要用于配置服务端和客户端的参数。
- docs/: 包含项目的文档文件,如
README.md
。 - internal/: 包含项目的内部逻辑代码,分为多个子目录,如
api
,auth
,broker
等,每个子目录对应不同的功能模块。 - pkg/: 包含项目的公共包,如
client
,protocol
,server
等。 - scripts/: 包含项目的构建脚本,如
build.sh
。 - vendor/: 包含项目的依赖包。
- .gitignore: Git 忽略文件。
- Dockerfile: Docker 构建文件。
- go.mod: Go 模块文件,定义项目的依赖。
- go.sum: Go 模块文件,记录依赖的校验和。
- README.md: 项目的主文档文件。
2. 项目启动文件介绍
Guble 项目的启动文件位于 cmd/
目录下,分为 guble-server
和 guble-client
两个部分。
服务端启动文件
- 文件路径:
cmd/guble-server/main.go
- 功能: 该文件是 Guble 服务端的启动入口,负责初始化服务端配置、启动服务端进程并监听客户端连接。
客户端启动文件
- 文件路径:
cmd/guble-client/main.go
- 功能: 该文件是 Guble 客户端的启动入口,负责初始化客户端配置、连接服务端并进行消息的发送和接收。
3. 项目配置文件介绍
Guble 项目的配置文件位于 config/
目录下,主要用于配置服务端和客户端的参数。
配置文件路径
- 文件路径:
config/config.go
配置文件内容
config.go
文件中定义了多个配置项,包括但不限于:
- ServerConfig: 服务端配置,如监听地址、端口号等。
- ClientConfig: 客户端配置,如服务端地址、连接超时时间等。
- AuthConfig: 认证配置,如认证方式、密钥等。
配置文件使用方法
在启动服务端或客户端时,可以通过命令行参数或环境变量来覆盖默认配置。例如:
# 启动服务端并指定监听地址
go run cmd/guble-server/main.go --listen=0.0.0.0:8080
# 启动客户端并指定服务端地址
go run cmd/guble-client/main.go --server=localhost:8080
通过以上配置,可以灵活地调整 Guble 服务端和客户端的行为。
gublewebsocket based messaging server written in golang项目地址:https://gitcode.com/gh_mirrors/gu/guble