DuckyGo (基于gin+gorm搭建的快速高效稳定同时支持Session和Jwt的web restful api)

项目基于MIT协议，任何人可以进行修改并发布，如果本项目你发现有任何BUG，欢迎提交PullRequest 🔥

• DuckyGo-MVC(模板语言和Django一模一样): 基于Gin+Pongo2gin+Gorm的MVC开发框架
• DuckyGo参考视频: 使用DuckyGo进行快速Restful API开发

特别感谢 😋

感谢JetBrains提供IDE.

目的 🌟

本项目采用了一系列Golang中比较流行的组件，可以以本项目为基础快速搭建Restful Web API

说明

响应序列化:

任何一个json返回值，都是以serializer.Response进行序列化出来
最后在api(controll)层c.JSON返回的时候加.Result() 进行加TimeStamp

• 本项目自带Python写的接口测试, 在根目录下的DuckyGoTest.py, 按照自己需求更改即可流畅的完成测试~

特色 💙

本项目已经整合了许多开发API所必要的组件：

1. Gin: 轻量级Web框架，自称路由速度是golang最快的.
2. GORM: ORM工具。本项目需要配合Mysql使用.
3. Gin-Session: Gin框架提供的Session操作工具.
4. Go-Redis: Golang Redis客户端.
5. godotenv: 开发环境下的环境变量工具，方便使用环境变量.
6. Gin-Cors: Gin框架提供的跨域中间件.
7. Jwt-Go: Golang JWT认证组件
8. AMPQ: Golang RabbitMQ客户端
9. 实现了国际化i18n的一些基本功能. (详细在API层调用, conf/下有配置文件)
10. 本项目自动选择内存或者是Redis来保存用户Session登陆状态.
11. 使用Redis-list实现了内部消息队列,发送邮件可实现完全异步发送.
12. 同时实现了session和jwt验证， 让用户可以自己选择而不用自己造轮子.

本项目已经预先实现了一些常用的代码方便参考和复用:

1. 创建了用户模型
2. 实现了/api/v1/user/register用户注册接口
3. 实现了/api/v1/user/login用户登录接口
4. 实现了/api/v1/user/me用户资料接口(需要登录后获取session)
5. 实现了/api/v1/user/logout用户登出接口(需要登录后获取session)
6. 实现了/api/v1/user/changepassword用户修改密码接口(需要登录后获取session)
7. 实现了/api/v2/user/register用户注册接口(和v1基本一样)
8. 实现了/api/v2/user/login用户登录接口(获得jwtToken, 无状态)
9. 实现了/api/v2/user/me用户个人信息接口(传递token验证身份, 无状态)
10. 实现了/api/v2/user/changepassword用户修改密码接口(传递token验证身份, 无状态)
11. 实现了/api/v2/user/logout用户注销接口(传递token, 并且将token存入黑名单, 无状态)

本项目已经预先创建了一系列文件夹划分出下列模块:

1. api文件夹就是MVC框架的controller，负责协调各部件完成任务
2. model文件夹负责存储数据库模型和数据库操作相关的代码
3. service负责处理比较复杂的业务，把业务代码模型化可以有效提高业务代码的质量（比如用户注册，充值，下单等）
4. serializer储存通用的json模型，把model得到的数据库模型转换成api需要的json对象, 以及定义API的Code值
5. cache负责redis, RabbitMQ缓存相关的代码
6. auth权限控制文件夹
7. util一些小工具, 目前有randomString、Logger、SendEmail
8. conf放一些静态存放的配置文件，其中locales内放置翻译相关的配置文件
9. log放生成的日志文件，第一次使用需要双击运行一下bat文件生成log文件.

LOG_LEVEL说明 💜

第一次使用要先运行log文件夹下的bat批处理，用来生成记录log所需要的log文件.

当设置LOG_LEVEL设置为ERROR
就只会显示 error panic

当设置LOG_LEVEL设置为WARNING
就只会显示 warning error panic

当设置LOG_LEVEL设置为INFO
就只会显示 info warning error panic

当设置LOG_LEVEL设置为DEBUG
则全部显示

Godotenv 💛

项目在启动的时候依赖以下环境变量，但是在也可以在项目根目录创建.env文件设置环境变量便于使用(建议开发环境使用)

MYSQL_DSN="db_user:[email protected](127.0.0.1:3306)/db_name?charset=utf8&parseTime=True&loc=Local" # Mysql连接配置
RABBITMQ_DSN="amqp://mq_user:[email protected]:5672/virtual_host"                             # RabbitMQ连接配置 默认没有开启
REDIS_ADDR="127.0.0.1:6379" # Redis端口和地址
REDIS_PW=""                 # Redis连接密码
REDIS_DB=""                 # Redis库从0到10，不填即为0
SESSION_SECRE=""            # Seesion密钥     (切记不能泄露！！)
JWT_SECRET_KEY=""           # JWT密钥配置      (切记不能泄露！！)
GIN_MODE="debug"            # 设置gin的运行模式，有 debug 和 release
LOG_LEVEL="ERROR"           # 设置为ERROR基本不会记录log 设置为DEBUG则会详细记录每次请求
RIM="notuse"                # 设置为use的时候会启动mysql之类的连接，非设置为notuse就会关闭mysql连接
V1="on"                     # 是否启动v1 (Session-Cookie身份验证)
V2="off"                    # 是否启动v2 (JWT-Token身份验证)

Windows安装MySQL和Redis麻烦?😶 你可以使用Docker啊！😎

• 快速起Redis: docker run -di --name redis -p 6379:6379 redis
• 快速起MySQL: docker run -di --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=yourpassword mysql

因为启动容器指定了--name, 后续可以使用docker start|stop redis|mysql 来进行开启或者关闭.

如需要使用navicat等工具管理MySQL，可能会出现报错等情况：😵

docker exec -it mysql /bin/bash    # 打开mysql bash交互
mysql -u root -p                   # 进入mysql交互
ALTER USER 'root'@'%' IDENTIFIED BY 'password' PASSWORD EXPIRE NEVER;            # 更改加密方式
ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'yourpassword';   # 更改密码
FLUSH PRIVILEGES;                                                                # 刷新

Go Mod 💚

本项目使用Go Mod管理依赖。

go mod init DuckyGo
export GOPROXY=http://mirrors.aliyun.com/goproxy/
go run main.go // 自动安装

运行 💗

go run main.go

项目运行后启动在8000端口（可以修改，参考gin文档)
本项目修改端口请查看main.go

编译 ❗️

go build main.go

Docker运行:

docker build -t duckygo:release .

docker run -di --name duckygo -p 8000:8000 duckygo:release

如需交叉编译请看这里