GitHub Workflow Status codecov GolangCI godoc Go Report Card gitmoji License
一款适合于快速开发业务的 Go 框架,主要是提供 API 服务。
项目中用到的设计思想和原则,满足 "高内聚、低耦合",主要遵从下面几个原则
-
- 单一职责原则
-
- 基于接口而非实现编程
-
- 依赖注入
-
- 多用组合
-
- 迪米特法则
迪米特法则: 不该有直接依赖关系的类之间,不要有依赖;有依赖关系的类之间,尽量只依赖必要的接口
- 框架路由使用 Gin 路由
- 中间件使用 Gin 框架的中间件
- 数据库组件 GORM
- 文档使用 Swagger 生成
- 配置文件解析库 Viper
- 使用 JWT 进行身份鉴权认证
- 校验器使用 validator 也是 Gin 框架默认的校验器
- 任务调度 cron
- 包管理工具 Go Modules
- 测试框架 GoConvey
- CI/CD GitHub Actions
- 使用 GolangCI-lint 进行代码检测
- 使用 make 来管理 Go 工程
- 使用 shell(admin.sh) 脚本来管理进程
- 使用 YAML 文件进行多环境配置
├── Makefile # 项目管理文件 ├── build # 编译目录 ├── cmd # 脚手架目录 ├── conf # 配置文件统一存放目录 ├── db.sql # 在部署新环境时,可以登录 MySQL 客户端,执行 source db.sql 创建数据库和表 ├── docs # Swagger 文档,执行 swag init 生成的 ├── handler # 控制器目录,用来读取输入、调用业务处理、返回结果 ├── internal # 业务目录 │ ├── cache # 基于业务封装的cache │ ├── idl # 数据结构转换 │ ├── model # 数据库 model │ ├── repository # 数据访问层 │ └── service # 业务逻辑层 ├── logs # 存放日志的目录 ├── main.go # 项目入口文件 ├── pkg # 一些封装好的 package ├── router # 路由及中间件目录 └── scripts # 存放用于执行各种构建,安装,分析等操作的脚本
直接Clone项目的方式,文件比较全
TIPS: 需要本地安装MySQL数据库和 Redis
# 下载安装,可以不用是 GOPATH git clone https://github.com/1024casts/snake # 进入到下载目录 cd snake # 生成本地环境配置文件 cp config.sample.yaml config.local.yaml # 编译 make build # 运行 ./scripts/admin.sh start
使用脚手架,仅生成基本目录d, 不包含pkg等部分公共模块目录
# 下载 go get github.com/1024casts/snake/cmd/snake cd $GOPATH/src # 使用 snake new snake-demo -d ./ # 或者 snake new github.com/foo/bar -d ./
- make help 查看帮助
- make dep 下载 Go 依赖包
- make build 编译项目
- make swag-init 生成接口文档
- make test-coverage 生成测试覆盖
- make lint 检查代码规范
- 注册
- 登录(邮箱登录,手机登录)
- 发送手机验证码(使用七牛云服务)
- 更新用户信息
- 关注/取消关注
- 关注列表
- 粉丝列表
http://localhost:8080/swagger/index.html
上传到服务器后,直接运行命令即可
./scripts/admin.sh start
如果安装了 Docker 可以通过下面命令启动应用:
# 运行 docker-compose up -d # 验证 http://127.0.0.1/health
编译并生成二进制文件
go build -o bin_snake
如果应用有多台机器,可以在编译机器进行编译,然后使用rsync同步到对应的业务应用服务器
以下内容可以整理为脚本
export GOROOT=/usr/local/go1.13.8 export GOPATH=/data/build/test/src export GO111MODULE=on cd /data/build/test/src/github.com/1024casts/snake /usr/local/go1.13.8/bin/go build -o /data/build/bin/bin_snake -mod vendor main.go rsync -av /data/build/bin/ x.x.x.x:/home/go/snake supervisorctl restart snake
这里日志目录设定为 /data/log
如果安装了 Supervisord,可以在配置文件中添加下面内容(默认:/etc/supervisor/supervisord.conf):
[program:snake] # environment= directory=/home/go/snake command=/home/go/snake/bin_snake autostart=true autorestart=true user=root stdout_logfile=/data/log/snake_std.log startsecs = 2 startretries = 2 stdout_logfile_maxbytes=10MB stdout_logfile_backups=10 stderr_logfile=/data/log/snake_err.log stderr_logfile_maxbytes=10MB stderr_logfile_backups=10
重启 Supervisord
supervisorctl restart snake
- Issue: https://github.com/1024casts/snake/issues
- QQ交流群:1074476202
MIT. See the LICENSE file for details.