一款适合于快速开发业务的 Go 框架，可快速构建 API 服务 或 Web 网站。
Pro Tip: 每个目录下基本都有 README，可以让框架使用起来更轻松 ^_^
框架中用到的设计思想和原则，尽量满足 "高内聚、低耦合"，主要遵从下面几个原则
-
- 单一职责原则
-
- 基于接口而非实现编程
-
- 依赖注入
-
- 多用组合
-
- 迪米特法则
迪米特法则: 不该有直接依赖关系的类之间，不要有依赖；有依赖关系的类之间，尽量只依赖必要的接口
- 框架路由使用 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 # 项目管理文件
├── api # grpc客户端和Swagger 文档
├── cmd # 脚手架目录
├── config # 配置文件统一存放目录
├── docs # 框架相关文档
├── internal # 业务目录
│ ├── cache # 基于业务封装的cache
│ ├── handler # http 接口
│ ├── middleware # 自定义中间件
│ ├── model # 数据库 model
│ ├── dao # 数据访问层
│ ├── ecode # 业务自定义错误码
│ ├── routers # 业务路由
│ ├── server # http server 和 grpc server
│ └── service # 业务逻辑层
├── logs # 存放日志的目录
├── main.go # 项目入口文件
├── pkg # 公共的 package
├── test # 单元测试依赖的配置文件，主要是供docker使用的一些环境配置文件
└── scripts # 存放用于执行各种构建，安装，分析等操作的脚本直接Clone项目的方式，文件比较全
TIPS: 需要本地安装MySQL数据库和 Redis
# 下载安装，可以不用是 GOPATH
git clone https://github.com/oliver258/eagle
# 进入到下载目录
cd eagle
# 编译
make build
# 运行
./scripts/admin.sh start使用脚手架，仅生成基本目录, 不包含pkg等部分公共模块目录
# 下载
go get github.com/oliver258/eagle/cmd/eagle
export GO111MODULE=on
# 或者在.bashrc 或 .zshrc中加入
# source .bashrc 或 source .zshrc
# 使用
eagle new eagle-demo
# 或者
eagle new github.com/foo/bar- make help 查看帮助
- make dep 下载 Go 依赖包
- make build 编译项目
- make gen-docs 生成接口文档
- make test-coverage 生成测试覆盖
- make lint 检查代码规范
- 图片上传(支持本地、七牛)
- 短信验证码(支持七牛)
- 注册
- 登录(邮箱登录，手机登录)
- 发送手机验证码(使用七牛云服务)
- 更新用户信息
- 关注/取消关注
- 关注列表
- 粉丝列表
http://localhost:8080/swagger/index.html
遵循: Uber Go 语言编码规范
上传到服务器后，直接运行命令即可
./scripts/admin.sh start如果安装了 Docker 可以通过下面命令启动应用：
# 运行
docker-compose up -d
# 验证
http://127.0.0.1/health编译并生成二进制文件
go build -o bin_eagle如果应用有多台机器，可以在编译机器进行编译，然后使用rsync同步到对应的业务应用服务器
以下内容可以整理为脚本
export GOROOT=/usr/local/go1.13.8
export GOPATH=/data/build/test/src
export GO111MODULE=on
cd /data/build/test/src/github.com/oliver258/eagle
/usr/local/go1.13.8/bin/go build -o /data/build/bin/bin_eagle -mod vendor main.go
rsync -av /data/build/bin/ x.x.x.x:/home/go/eagle
supervisorctl restart eagle这里日志目录设定为 /data/log
如果安装了 Supervisord，可以在配置文件中添加下面内容(默认：/etc/supervisor/supervisord.conf)：
[program:eagle]
# environment=
directory=/home/go/eagle
command=/home/go/eagle/bin_eagle
autostart=true
autorestart=true
user=root
stdout_logfile=/data/log/eagle_std.log
startsecs = 2
startretries = 2
stdout_logfile_maxbytes=10MB
stdout_logfile_backups=10
stderr_logfile=/data/log/eagle_err.log
stderr_logfile_maxbytes=10MB
stderr_logfile_backups=10重启 Supervisord
supervisorctl restart eagle- Issue: https://github.com/oliver258/eagle/issues
- QQ交流群：1074476202
- Gitter: https://gitter.im/oliver258/eagle
- 微信交流群
eagle 项目一直以来都是在 JetBrains 公司旗下的 GoLand 集成开发环境中进行开发，基于 free JetBrains Open Source license(s) 正版免费授权，在此表达我的谢意。
MIT. See the LICENSE file for details.