ginApi是一个基于gin开发的框架，集成了api签名、鉴权、全链路日志追踪，减少在项目中重复造轮子
通过logid可以追踪一次http请求的日志，logid均在接口中返回
日志是按照小时切割，接口中请求和返回的数据均通过中间件loggerMiddleware.go自动记录，mysql的操作sql语句也自动记录
例如：用户请求登录/api/user/login
统一返回标准数据结构
{
"code": 1,
"msg": "success",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySWQiOjEsImV4cCI6MTY4NDM0Mzk1NSwiaXNzIjoiYWRtaW4ifQ.x7JtRrsWUehL1helcv2Ll9CPJ8Ov1qyoCCt_dJuAO_0"
},
"logid": "33666c1ef0d54fcfa73b409cc2285c5e",
"timestamp": 1684336755
}
logid查询日志id timestamp当时时间戳 进入的日志目录，根据返回的logidcd79e47c610343cbb3345c8603e7dacd查找，一次http请求的日志
[root@localhost 202209]# cd logs/202209
[root@localhost 202209]# grep cd79e47c610343cbb3345c8603e7dacd 2022090312.log
2022/09/03 12:11:42 logid[cd79e47c610343cbb3345c8603e7dacd] url[/api/user/login?sign=f9e9eb19af3aa19f0fe83bc5b43742c9ec65dc57] ip[127.0.0.1] method[POST] post_data[] body[{"username": "zhangsan", "password": "123456", "token": "A5tvtvTZR56Vekj8K7V71I25OpVuQ8jg"}]
2022/09/03 12:11:42 logid[cd79e47c610343cbb3345c8603e7dacd] url[/api/user/login?sign=f9e9eb19af3aa19f0fe83bc5b43742c9ec65dc57] signPre[abc123{"username": "zhangsan", "password": "123456", "token": "A5tvtvTZR56Vekj8K7V71I25OpVuQ8jg"}abc123]
2022/09/03 12:11:42 logid[cd79e47c610343cbb3345c8603e7dacd] mysql[SELECT * FROM `user` WHERE username='zhangsan' ORDER BY `user`.`id` LIMIT 1] time[9.4602] filePath[D:/www/go/ginApi/Service/UserService.go:130]
2022/09/03 12:11:42 logid[cd79e47c610343cbb3345c8603e7dacd] url[/api/user/login?sign=f9e9eb19af3aa19f0fe83bc5b43742c9ec65dc57] response[{"code":1,"data":{"token":"PqrUdnsC0kE7VARhqoMGY5Jm4zwkfixr"},"logid":"cd79e47c610343cbb3345c8603e7dacd","msg":"success"}]
┌ common (公共模块)
│ ├── enum (枚举)
│ ├── myLogger (自定义日志)
│ ├── tools (工具文件)
│ ├── response (定义的统一返回json结构体)
│ ├── config (获取配置的方法)
│ └── jwt (jwt)
├── config (配置文件)
├── controller (控制器)
│ ├── admin (后台控制器)
│ └── api (api控制器)
├── logs (日志目录)
├── middleware (中间件)
│ ├── checkJwtMiddleware.go (校验jwt中间件)
│ ├── checkSignMiddleware.go (签名中间件)
│ ├── checkTokenMiddleware.go (校验token中间件)
│ └── loggerMiddleware.go (日志中间件)
├── models (中间件层)
│ ├── mysql.go (mysql model)
│ ├── orderModel.go (订单 model)
│ ├── userModel.go (用户 model)
│ ├── phoneModel.go (手机号码 model)
│ └── redis.go (redis model)
├── routers (路由)
│ ├── adminRouter.go (后台路由)
│ ├── apiRouter.go (api路由)
│ ├── websocketRouter.go (websocket路由)
│ └── router.go.go (路由)
├── proto (protobuf grpc的demo)
│ ├── goodsService (生成商品的grpc服务)
│ ├── orderService (生成订单的grpc服务)
│ ├── goods.proto (定义商品的grpc服务)
│ └── order.proto (定义订单的grpc服务)
├── service (服务层)
├── static (静态资源)
│ ├── css (css文件)
│ ├── image (图片文件)
│ └── js (js文件)
└── template (路由层)
└── Admin (后台模板文件)
- golang版本 >= v1.16
- IDE推荐：Goland
使用 Goland 等编辑工具
# 克隆项目
git clone https://github.com/mjy191/ginApi.git
# 进入gitApi文件夹
cd gitApi
# 配置代理防止无法下载依赖包
go env -W GOPROXY=https://goproxy.cn,https://goproxy.io,direct
# 使用 go mod 并安装go依赖包
go mod tidy
# 编译
go build -o server main.go (windows编译命令为go build -o server.exe main.go )
# 运行二进制
./server (windows运行命令为 server.exe)