113 Star 878 Fork 272

张奇峰 / GinSkeleton

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
ReadME.md

这是什么?

1.这是一个基于go语言gin框架的web项目骨架,专注于前后端分离的业务场景,其目的主要在于将web项目主线逻辑梳理清晰,最基础的东西封装完善,开发者更多关注属于自己的的业务即可。
2.本项目骨架封装了以tb_users表为核心的全部功能(主要包括用户相关的接口参数验证器、注册、登录获取token、刷新token、CURD以及token鉴权等),开发者拉取本项目骨架,在此基础上就可以快速开发自己的项目。
3.本项目骨架请使用 master 分支版本即可, 该分支是最新稳定分支 .
4.本项目骨架从V1.4.00开始,要求go语言版本 >=1.15,才能稳定地使用gorm v2读写分离方案,go1.15下载地址:https://studygolang.com/dl

问题反馈

1.提交问题请在项目顶栏的issue直接添加问题,基本上都是每天处理当天上报的问题。
2.本项目优先关注 Gitee Issue 仓库的所有问题, github 太卡严重影响效率。

快速上手

// 1.安装的go语言版本最好>=1.15,只为更好的支持 `go module` 包管理.  

// 2.配置go包的代理,打开你的 goland 终端并执行以下命令(windwos系统)
    // 其他操作系统自行参见:https://goproxy.cn  
    go env -w GO111MODULE=on
    go env -w GOPROXY=https://goproxy.cn,direct

// 3.下载本项目依赖库  
    使用 goland(>=2019.3版本) 打开本项目,打开 goland 底部的 Terminal ,执行  go mod tidy 下载本项目依赖库  

// 4.还原自带数据库   
    找到`database/db_demo_mysql.sql`导入数据库,自行配置账号、密码、端口等。    

// 5.双击`cmd/(web|api|cli)/main.go`,进入代码界面,鼠标右键`run`运行本项目,首次会自动下载依赖, 片刻后即可启动.  

业务主线图

项目目录结构介绍

核心结构

交叉编译(windows直接编译出linux可执行文件)

  // goland 终端底栏打开`terminal`, 依次执行以下命令,设置编译前的参数   
  // 特别注意: 以下三个命令执行时,前后不要有空格,否则最后编译可能会报错,无法编译出最终可执行文件  
  set GOARCH=amd64
  set GOOS=linux
  set CGO_ENABLED=0   // window编译设置Cgo模块关闭,因为windows上做cgo开发太麻烦,如果引用了Cgo库库,那么请在linux环境开发、编译  
  
  // 编译出最终可执行文件,进入根目录(GinSkeleton所在目录,也就是 go.mod 所在的目录)
  // -o 指定最终编译出的文件名, cmd/(web|api|cli)/main.go 表示编译的入口文件,web|api|cli 三个目录选择其一即可  
  go build -o demo_goskeleton cmd/(web|api|cli)/main.go
  

项目骨架主线、核心逻辑

这部分主要介绍了项目初始化流程路由表单参数验证器控制器modelservice 以及 websocket 为核心的主线逻辑.
进入主线逻辑文档

测试用例路由

进入Api接口测试用例文档

开发常用模块

随着项目不断完善以下列表模块会陆续增加, 各个模块被贯穿在本项目骨架的主线中.
以下模块都是主线的服务提供者,只要掌握主线逻辑,结合以下模块,会让整个项目的操作更加流畅、简洁.

序号 功能模块 文档地址
1 全局变量(日志、gorm、配置模块、雪花算法) 清单一览
2 表单参数验证器语法 validator
3 消息队列 rabbitmq文档
4 cli命令 cobra文档
5 goCurl、httpClient httpClient客户端
6 websocket js客户端 websocket服务端
7 aop切面编程 Aop切面编程
8 redis redis使用示例
9 gorm_v2 CURD 操作精华版 gorm+ginskeleton 精华
10 gorm_v2操作(mysql、sqlserver、postgreSql) gorm v2 更多测试用例
11 gorm_v2 Scan Find函数查询结果一键树形化 sql结果树形化反射扫描器
12 日志记录 zap高性能日志
13 项目日志对接到 elk 服务器 elk 日志顶级解决方案
14 验证码(captcha)以及验证码中间件 验证码使用详情
15 nginx配置(https、负载均衡) nginx配置详情
16 主线解耦 对验证器与控制器进行解耦
17 Casbin 接口访问权限管控 Casbin使用介绍

项目上线后,运维方案(基于docker)

序号 运维模块 文档地址
1 linux服务器 详情
2 mysql 详情
3 redis 详情
4 nginx 详情
5 go应用程序 详情
6 supervisor进程守护 详情

并发测试

点击查看详情

性能分析报告

1.开发之初,我们的目标就是追求极致的高性能,因此在项目整体功能越来越趋于完善之时,我们现将进行一次全面的性能分析评测.
2.通过执行相关代码, 跟踪 cpu 耗时 和 内存占用 来分析各个部分的性能,CPU耗时越短性、内存占用越低能越优秀,反之就比较垃圾.

通过CPU的耗时来分析相关代码段的性能

序号 分析对象 文档地址
1 项目骨架主线逻辑 主线分析报告
2 操作数据库代码段 操作数据库代码段分析报告

通过内存占用来分析相关代码段的性能

序号 分析对象 文档地址
1 操作数据库代码段 操作数据库代码段

FAQ 常见问题汇总

点击查看详情

GinSkeleton-Admin 后台系统

1.本系统是基于 GinSkeleton(v1.5.10) + Iview(v4.5.0) 开发而成的企业级项目后台骨架.
2.在线演示系统相比本地运行的版本收缩了修改、删除 数据的权限.
预览图

在线演示系统: GinSkeleton-Admin

admin 后端仓库

admin 前端仓库

主线版本更新日志

V 1.5.17 2021-06-06

  • 新增、更新
    1.sqlserver 数据库对应的用户模型,参见 app/model/users_for_sqlserver.txt.
    2.更新 database/db_demo_sqlserver.sql 数据库、表创建命令.
  • 修复
    1.修正常量定义处日期格式单词书写错误问题.

V 1.5.16 2021-05-28

  • 新增
    1.增加验证码中间件以及使用介绍.

V 1.5.15 2021-05-11

  • 完善
    1.文件上传后自动创建目录时,目录权限由(0666)调整为:os.ModePerm(0777),解决可能遇到的权限问题 .
    2.cobra 文档增加创建子命令的示例链接.

V 1.5.14 2021-04-28

  • 完善
    1.更新 rabbitMq 排版
    2.更新 websocket 文档

V 1.5.13 2021-04-27

  • 完善
    1.表单参数验证器注册文件拆分为:api、web,当项目较大时,尽可能保持逻辑清晰、简洁.
    3.完善细节,避免mysql 函数 FROM_UNIXTIME 参数最大只能支持21亿的局限.
    3.核心依赖包升级至最新版.

V 1.5.12 2021-04-20

  • 完善
    1.app/model/users 增加注释,主要是主线版本操作数据库大量使用了原生sql,注释主要增加了 gorm_v2 自带语法操作数据库的链接地址.
    2.代码中涉及到的分页语法(limit offset,limit),参数 offset,limit 统一调整为 int 型,解决mysql8.x系列高版本的数据库不支持浮点型的问题.

V 1.5.11 2021-04-02

  • 变更 1.app/model/BaseModel 文件中,UseDbConn 函数名首字符调整为大写,方便创建更多的子级目录.
  • 更新
    1.日志(nginx 的access.log)对接到 ELK 日志管理中心,相关文档更新,增加了ip转 经纬度功能,方便展示用户在世界地图的分布.
    2.针对上一条,补充了日志展示的整体效果图

V 1.5.10 2021-03-23

  • 完善
    1.form表单参数验证器完成验证后, 自动为上下文绑定三个键:created_at、updated_at、deleted_at ,相关值均为请求时的日期时间.
    2.baseModel 中 created_at、updated_at 修改为 string 类型,方便从上下文自动绑定对应的键值到 model .
    3.用户每次登录后,tb_users 表,登陆次数字段+1 .
    4.nginx 部署文档修正一处缺少单引号的错误.
    5.gorm 操作数据库精华版文档更新.
    6.删除其他小部分无关代码.
    7.增加自动创建连接功能,只为更好地处理静态资源.
    8.文件上传代码配置项增加部分参数,代码同步升级.
    9.GinSkeleton-Admin 系统同步发布.

V 1.5.00 2021-03-10

  • 新增
    1.为即将发布的 GinSkeleton-Admin 系统增加了基础支撑模块:casbin模块、gorm_v2 操作精华版文档,参见常用开发模块列表.
    2.token模块引用的部分常量值调整到配置文件.
    3.调整token校验中间件和casbin中间件名称.
    4.主线版本本次更新并不是很多,今后主线版本将依然保持简洁,后续的新功能模块都将以包的形式引入和调用.
    5.更多企业级的功能将在后续推出的 GinSkeleton-Admin 展现,欢迎关注本项目,反馈使用意见.

V 1.1.xx - 1.4.xx 版本日志

1.历史日志

感谢 jetbrains 为本项目提供的 goland 激活码

https://www.jetbrains.com/

Comments ( 83 )

Sign in for post a comment

About

基于go语言gin框架封装的web项目骨架 ↓↓↓ 在线文档 ↓↓↓ (gin框架QQ群:273078549) V1.4.00版本后要求go语言版本>=1.15 spread retract
Cancel

Releases (24)

All

GinSkeleton

Contributors

All

Activities

load more
can not load any more
Go
1
https://gitee.com/daitougege/GinSkeleton.git
git@gitee.com:daitougege/GinSkeleton.git
daitougege
GinSkeleton
GinSkeleton
master

Search