一款适合于快速开发业务的Go框架,主要是提供API服务。
- 框架路由使用 gin 路由
- 中间件使用 gin 框架的中间件
- 数据库组件 gorm
- 文档使用 swagger 生成
- 配置文件解析库 viper
- 使用 JWT 进行身份鉴权认证
- 校验器 validator 也是 gin 框架默认的校验器,当前最新是v9版本
- 任务调度 cron
- 包管理工具 go module
- 测试框架 goConvey
- CI/CD Github Actions
- 使用 GolangCI-lint 进行代码检测
- 使用 make 来管理Go工程
- 使用 shell(admin.sh) 脚本来管理进程
- 使用 yaml 文件进行多环境配置
├── Makefile # 项目管理文件
├── conf # 配置文件统一存放目录
├── config # 专门用来处理配置和配置文件的Go package
├── db.sql # 在部署新环境时,可以登录MySQL客户端,执行source db.sql创建数据库和表
├── docs # swagger文档,执行 swag init 生成的
├── handler # 类似MVC架构中的C,用来读取输入,并将处理流程转发给实际的处理函数,最后返回结果
├── internal # 业务目录
│ ├── idl # 数据结构转换
│ ├── model # 数据库model
│ ├── repository # 数据访问层
│ └── service # 业务逻辑封装
├── log # 存放日志的目录
├── main.go # 项目入口文件
├── pkg # 一些封装好的package
├── router # 路由及中间件目录
└── scripts # 存放用于执行各种构建,安装,分析等操作的脚本
# 进入到自己的开发目录,下载安装即可,可以不用是 GOPATH
git clone https://github.com/1024casts/snake
TIPS: 需要本地安装数据库和redis
// 进入到下载目录
cd snake
// 生成本地环境配置文件
cp config.sample.yaml config.local.yaml
// 编译
make build
// 运行
./scripts/admin.sh start
- make help 查看帮助
- make dep 下载go依赖包
- make build 编译项目
- make swag-init 生成接口文档
- make test-coverage 生成测试覆盖
- make lint 检查代码规范
- 注册
- 登录(邮箱登录,手机登录)
- 发送手机验证码(使用七牛云服务)
- 更新用户信息
- 关注/取消关注
- 关注列表
- 粉丝列表
https://localhost:8080/swagger/index.html
上传到服务器后,直接运行命令即可
./scripts/admin.sh start
如果安装了docker可以通过下面命令启动应用:
// 运行
docker-compose up -d
// 验证
https://127.0.0.1/health
编译并生成二进制文件
go build -o bin_snake
这里日志目录设定为 /data/log
如果安装了 Supervisord,可以在配置文件中添加下面内容(默认:/etc/supervisor/supervisord.conf
):
[program:snake]
# environment=
directory=/home/go/snake
command=/home/go/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
MIT. See the LICENSE file for details.