https://github.com/fishjar/gin-boilerplate
基于 `Gin` 封装的样板项目
https://github.com/fishjar/gin-boilerplate
Last synced: 4 months ago
JSON representation
基于 `Gin` 封装的样板项目
- Host: GitHub
- URL: https://github.com/fishjar/gin-boilerplate
- Owner: fishjar
- License: mit
- Created: 2020-08-08T13:01:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-02T15:19:45.000Z (over 5 years ago)
- Last Synced: 2024-06-20T13:33:08.604Z (almost 2 years ago)
- Language: Go
- Size: 90.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gin boilerplate
基于 `Gin` 封装的样板项目
## 项目特性
- 基础框架 `gin`： github.com/gin-gonic/gin
- 跨域中间件：github.com/gin-contrib/cors
- 数据库 orm 框架 `gorm`： github.com/jinzhu/gorm
- 自动创建表，插入初始数据
- 支持事务及原始 SQL 查询
- 支持查询缓存（待优化）：github.com/8treenet/gcache
- 多环境配置（yml 文件）依赖包：github.com/jinzhu/configor
- `jwt` 登录验证功能，依赖包：github.com/dgrijalva/jwt-go
- 认证数据缓存在 redis
- 可依据路由配置角色权限校验
- 模型定义中 `validator.v8` 校验： godoc.org/gopkg.in/go-playground/validator.v8
- `swagger` 文档生成及访问：github.com/go-openapi/swag
- 访问支持 BasicAuth
- 日志依赖包：github.com/sirupsen/logrus
- 日志分割：github.com/lestrrat-go/file-rotatelogs
- `redis` 依赖包：github.com/go-redis/redis/v7
- 单文件/多文件上传功能
- 文件名 hash 处理
- 如果是图片，自动生成缩略图，依赖包：github.com/disintegration/imaging
- 分布式任务队列：github.com/hibiken/asynq
- 基于 redis
- 定时任务：github.com/robfig/cron
- 分布式业务锁：github.com/bsm/redislock
- 基于 redis
- 基于 docker 部署
- 每个模型实现 8 个基本接口
- 分页查询（GET）
- 单条查询（GET）
- 创建单条（POST）
- 更新单条（PATCH）
- 删除单条（DELETE）
- 查询或创建单条（POST）
- 批量更新（PATCH）
- 批量删除（DELETE）
## 目录结构
```sh
├── config # 配置文件目录
│ ├── config.development.yml # 开发环境配置
│ ├── config.go
│ ├── config.production.yml # 生产环境配置
│ └── config.yml # 默认配置
├── crons
│ ├── crons.go
│ └── jobs.go
├── db
│ ├── db.go
│ └── redis.go
├── docker-compose-alpine.yml
├── docker-compose-go-alpine.yml
├── docker-compose-mysql.yml
├── docker-compose-redis.yml
├── docker-compose.yml
├── Dockerfile
├── Dockerfile-alpine
├── Dockerfile-go-alpine
├── docs
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── go.mod
├── go.sum
├── handler
│ ├── auth.go
│ ├── group.go
│ ├── login.go
│ ├── menu.go
│ ├── pong.go
│ ├── role.go
│ ├── upload.go
│ ├── user.go
│ └── usergroup.go
├── LICENSE
├── locker
│ └── locker.go
├── logger
│ └── logger.go
├── main.go
├── middleware
│ ├── jwt.go
│ ├── req.go
│ └── role.go
├── model
│ ├── auth.go
│ ├── base.go
│ ├── group.go
│ ├── menu.go
│ ├── role.go
│ ├── user.go
│ └── usergroup.go
├── README.md
├── router
│ ├── router.go
│ └── server.go
├── script
│ ├── initdb.go
│ ├── migrate.go
│ └── script.go
├── service
│ ├── auth.go
│ ├── file.go
│ ├── jwt.go
│ ├── redis.go
│ ├── service.go
│ └── user.go
├── tasks
│ ├── client.go
│ ├── new.go
│ ├── process.go
│ ├── server.go
│ └── tasks.go
├── tmp
│ ├── db # sqlite数据库文件目录
│ ├── log # 日志保存目录
│ └── upload # 上传文件目录
└── utils
├── sign.go
└── utils.go
```
## 开发指引
```sh
# 确保已安装go，及$GOPATH环境变量已配置
# Go 1.13 and above
go version
echo $GOPATH
# 设置代理
go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct
# 创建并进入目录
mkdir -p $GOPATH/src/github.com/fishjar/gin-boilerplate && cd "$_"
# 克隆项目
git clone https://github.com/fishjar/gin-boilerplate.git .
# 确认配置文件(尤其数据库相关配置)
vi config/config.go
vi config/config.yml
vi config/config.development.yml
# 如有需要，运行下列命令启动一个mysql数据库服务
docker-compose -f docker-compose-mysql.yml up -d
# 如有需要，启动redis
docker-compose -f docker-compose-redis.yml up -d
# 安装依赖
go get
# 生成Swagger文档
swag init
# 开发启动
go run main.go
# 访问swagger文档
http://localhost:4000/swagger/index.html
# 测试：登录
curl -X POST http://localhost:4000/admin/account/login \
-H "Content-Type: application/json" \
-d '{"username":"gabe","password":"123456"}' | python -m json.tool
# 测试：查询记录，注意替换为实际值
curl http://localhost:4000/admin/users \
-H "Authorization: Bearer " | python -m json.tool
```
## 部署指引
### 方案一
完整的 `golang` 镜像中编译运行
```sh
docker-compose -f docker-compose.yml up -d
```
### 方案二
`golang:alpine` 镜像中编译运行
```sh
docker-compose -f docker-compose-go-alpine.yml up -d
```
### 方案三（镜像最小）
本地编译，`alpine:latest` 镜像中运行
```sh
# 本地编译
GOOS=linux GOARCH=amd64 go build
# 或？
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build
# docker 启动
docker-compose -f docker-compose-alpine.yml up -d
```
## TODO or 存在问题
- 返回数据结构待整理
- 统一定义错误码
- 数据缓存，ES？redis？
- 目前基于 orm 的 redis 数据缓存，连表查询不理想，待封装新的缓存机制
- 日志搜集，ES？
- 模型定义时为了插入 `null` 值，字段类型必须使用指针
- 如果使用`database/sql`或`github.com/guregu/null`包，则导致 `validator.v8` 数据校验失效
- 结构体转 json，忽略部分字段， tags 的方式貌似无效，待研究
- 时间字段格式化，待研究
- Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc:"1"`
- 基于 `binding` tags 的校验有些简陋，待优化
- 只读字段校验，待研究
- 批量更新时 model 的 Hooks 不会运行
- 任务队列可视化管理问题