Golang: gin

时间：2023-12-01 本站点击：0

gin-vue-admin基于gin+vue搭建的后台管理系统框架，集成jwt鉴权，权限管理，动态路由，分页封装，多点登录拦截，资源权限，上传下载，代码生成器，表单生成器，通用工作流等基础功能，五分钟一套CURD前后端代码，目前已支持VUE3，欢迎issue和pr~

gitee地址: https://gitee.com/pixelmax/gin-vue-admin

github地址: https://github.com/flipped-aurora/gin-vue-admin

插件仓库以及开发规范:https://github.com/flipped-aurora/gva-plugins

审批流分支: https://github.com/flipped-aurora/gin-vue-admin/tree/gva_workflow

先说下启动代码会遇到的问题

D:\nodejs\node_global\webpack.ps1，因为在此系统上禁止运行脚本...

今天在开发中使用到了 yarn，之前全局安装了yarn，并且在 cmd 中也可以正常使用，但是在VS Code中报出了错误。如下信息：

无法加载文件D:\nodejs\node_global\webpack.ps1，因为在此系统上禁止运行脚本，有关详细信息，请参阅https:/go.microsoft.com/fwlink/?LinkID=135170

解决方案：

首先以管理员的身份运行 VS Code .

在终端执行 get-ExecutionPolicy,打印显示出 Restricted,表示禁止状态.

接下来在终端执行 set-executionpolicy remotesigned -s currentuser

在此输入 get-ExecutionPolicy查看，显示 RemoteSigned.

之后再使用yarn install 时，就不会再出现如上所述的问题了，出现其他同样类似情况也是同样的解决方案。

#进入web文件夹cdweb#安装依赖cnpminstall||npminstall#启动web项目npmrunserve

好，进入正文啦::::

项目文档

在线文档 : https://www.gin-vue-admin.com

初始化

从环境到部署教学视频

开发教学 (贡献者: LLemonGreen And Fann)

重要提示

1.本项目从起步到开发到部署均有文档和详细视频教程

2.本项目需要您有一定的golang和vue基础

3.您完全可以通过我们的教程和文档完成一切操作，因此我们不再提供免费的技术服务，如需服务请进行付费支持

1. 基本介绍

1.1 项目介绍

Gin-vue-admin是一个基于 vue 和 gin 开发的全栈前后端分离的开发基础平台，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，表单生成器，代码生成器等功能，提供多种示例文件，让您把更多时间专注在业务开发上。

在线预览: http://demo.gin-vue-admin.com

测试用户名：admin

测试密码：123456

1.2 贡献指南

Hi! 首先感谢你使用 gin-vue-admin。

Gin-vue-admin 是一套为快速研发准备的一整套前后端分离架构式的开源框架，旨在快速搭建中小型项目。

Gin-vue-admin 的成长离不开大家的支持，如果你愿意为 gin-vue-admin 贡献代码或提供建议，请阅读以下内容。

1.2.1 Issue 规范

issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。如果你在使用时产生了疑问，请到 Slack 或 Gitter 里咨询。

在提交 issue 之前，请搜索相关内容是否已被提出。

1.2.2 Pull Request 规范

请先 fork 一份到自己的项目下，不要直接在仓库下建分支。

commit 信息要以[文件名]: 描述信息 的形式填写，例如 README.md: fix xxx bug。

确保 PR 是提交到 develop 分支，而不是 master 分支。

如果是修复 bug，请在 PR 中给出描述信息。

合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并。

2. 使用说明

-node版本>v12.18.3-golang版本>=v1.16-IDE推荐：Goland-初始化项目：不同版本数据库初始化不通参见https://www.gin-vue-admin.com/docs/first_master-替换掉项目中的七牛云公钥，私钥，仓名和默认url地址，以免发生测试文件数据错乱

2.1 server项目

使用 Goland 等编辑工具，打开server目录，不可以打开 gin-vue-admin 根目录

#克隆项目gitclonehttps://github.com/flipped-aurora/gin-vue-admin.git#进入server文件夹cdserver#使用gomod并安装go依赖包gogenerate#编译gobuild-oservermain.go(windows编译命令为gobuild-oserver.exemain.go)#运行二进制./server(windows运行命令为server.exe)

2.2 web项目

#进入web文件夹cdweb#安装依赖cnpminstall||npminstall#启动web项目npmrunserve

2.3 swagger自动化API文档

2.3.1 安装 swagger

（1）可以访问外国网站

goget-ugithub.com/swaggo/swag/cmd/swag

（2）无法访问外国网站

由于国内没法安装 go.org/x 包下面的东西，推荐使用 goproxy.cn 或者 goproxy.io

#如果您使用的Go版本是1.13-1.15需要手动设置GO111MODULE=on,开启方式如下命令,如果你的Go版本是1.16~最新版可以忽略以下步骤一#步骤一、启用GoModules功能goenv-wGO111MODULE=on#步骤二、配置GOPROXY环境变量goenv-wGOPROXY=https://goproxy.cn,https://goproxy.io,direct#如果嫌弃麻烦,可以使用gogenerate编译前自动执行代码,不过这个不能使用`Goland`或者`Vscode`的命令行终端cdservergogenerate-run"goenv-w.*?"#使用如下命令下载swaggoget-ugithub.com/swaggo/swag/cmd/swag

2.3.2 生成API文档

cdserverswaginit

执行上面的命令后，server目录下会出现docs文件夹里的 docs.go, swagger.json, swagger.yaml 三个文件更新，启动go服务之后, 在浏览器输入 http://localhost:8888/swagger/index.html 即可查看swagger文档

3. 技术选型

前端：用基于 Vue 的 Element 构建基础页面。

后端：用 Gin 快速搭建基础restful风格API，Gin 是一个go语言编写的Web框架。

数据库：采用MySql(5.6.44)版本，使用 gorm 实现对数据库的基本操作。

缓存：使用Redis实现记录当前活跃用户的jwt令牌并实现多点登录限制。

API文档：使用Swagger构建自动化文档。

配置文件：使用 fsnotify 和 viper 实现yaml格式的配置文件。

日志：使用 zap 实现日志记录。

4. 项目架构

4.1 系统架构图

4.2 前端详细设计图（提供者:baobeisuper）

4.3 目录结构

├──server├──api(api层)│└──v1(v1版本接口)├──config(配置包)├──core(核心文件)├──docs(swagger文档目录)├──global(全局对象)├──initialize(初始化)│└──internal(初始化内部函数)├──middleware(中间件层)├──model(模型层)│├──request(入参结构体)│└──response(出参结构体)├──packfile(静态文件打包)├──resource(静态资源文件夹)│├──excel(excel导入导出默认路径)│├──page(表单生成器)│└──template(模板)├──router(路由层)├──service(service层)├──source(source层)└──utils(工具包)├──timer(定时器接口封装)└──upload(oss接口封装)└─web（前端文件）├─public（发布模板）└─src（源码包）├─api（向后台发送ajax的封装层）├─assets（静态文件）├─components（组件）├─router（前端路由）├─store（vuex状态管理仓）├─style（通用样式文件）├─utils（前端工具库）└─view（前端页面）

5. 主要功能

权限管理：基于jwt和casbin实现的权限管理。

文件上传下载：实现基于七牛云, 阿里云, 腾讯云 的文件上传操作(请开发自己去各个平台的申请对应 token 或者对应key)。

分页封装：前端使用 mixins 封装分页，分页方法调用 mixins 即可。

用户管理：系统管理员分配用户角色和角色权限。

角色管理：创建权限控制的主要对象，可以给角色分配不同api权限和菜单权限。

菜单管理：实现用户动态菜单配置，实现不同角色不同菜单。

api管理：不同用户可调用的api接口的权限不同。

配置管理：配置文件可前台修改(在线体验站点不开放此功能)。

条件搜索：增加条件搜索示例。

restful示例：可以参考用户管理模块中的示例API。

前端文件参考: web/src/view/superAdmin/api/api.vue

后台文件参考: server/router/sys_api.go

多点登录限制：需要在config.yaml中把system中的use-multipoint修改为true(需要自行配置Redis和Config中的Redis参数，测试阶段，有bug请及时反馈)。

分片长传：提供文件分片上传和大文件分片上传功能示例。

表单生成器：表单生成器借助 @form-generator 。

代码生成器：后台基础逻辑以及简单curd的代码生成器。

6. 知识库

6.1 团队博客

https://www.yuque.com/flipped-aurora
内有前端框架教学视频。如果觉得项目对您有所帮助可以添加我的个人微信:shouzi_1994，欢迎您提出宝贵的需求。

6.2 教学视频

（1）手把手教学视频

https://www.bilibili.com/video/BV1Rg411u7xH/

（2）后端目录结构调整介绍以及使用方法

https://www.bilibili.com/video/BV1x44y117TT/

（3）golang基础教学视频

bilibili：https://space.bilibili.com/322210472/channel/detail?cid=108884

（4）gin框架基础教学

bilibili：https://space.bilibili.com/322210472/channel/detail?cid=126418&ctype=0

（5）gin-vue-admin 版本更新介绍视频