server项目-先启动

server文件夹为Golang后端项目,需要有Golang基础,Gin框架基础

视频推荐

一步到位

server项目结构

├── api                     
│   └── v1
├── config
├── core
├── docs
├── global
│   └── response
├── initialize
├── middleware
├── model
│   ├── request
│   └── response
├── packfile
├── resource
├── router
├── service
└── utils
    └── upload

文件夹	说明	描述
`api`	api层	api层
`--v1`	v1版本接口	v1版本接口
`config`	配置包	config.yaml对应的配置结构体
`core`	核心文件	核心组件的初始化
`docs`	swagger文档目录	swagger文档目录
`global`	全局对象	全局对象
`--response`	json返回web端的统一封装	json返回web端的统一封装
`initialize`	初始化	路由,redis,gorm,验证器的初始化
`model`	模型层	模型对应数据表
`--request`	入参结构体	接收前端发送到后端的数据。
`--response`	出参结构体	返回给前端的数据结构体
`packfile`	静态文件打包	静态文件打包
`resource`	静态资源文件夹	负责存放
`router`	路由层	路由层
`service`	service层	存放业务逻辑问题
`utils`	工具包	工具函数封装
`--upload`	oss	oss接口封装

本文使用的环境

数据库选择mysql
Goland(2020.2)

1. 初始化server项目

Goland打开server文件夹
设置GOPROXY
- windows:打开File → settings → Go → Go Modules，将 Environment 项的值设置为GOPROXY=https://goproxy.io,direct
- Mac: 打开Goland→Preferences...→Go → Go Modules,将Environment项的值设置为GOPROXY=https://goproxy.io,direct
打开go.mod文件,在文件空白处鼠标右键点击Go Mod Tidy

2. config.yaml

按照 config的详细说明按需修改, V2.4.0 版本以后不需要配置mysql相关配置, 点我跳转

3. 数据库初始化

请对应版本进行观看初始化数据的方式

V2.4.0~master(最新版)

注意

mac/linux/windows 都不需要配置 server/config.yaml 的 mysql 中的 path , db-name, username ,password

1. 启动server项目与 web项目

在浏览器填写 host,port ,userName ,password ,dbName , 点击立即初始化
操作成功后会跳转到登录页面, 页面有一个操作成功的提示, 这就是初始化数据成功的标志

以下为旧版本

V2.0.0~V2.2.0

自行新建数据库，并导入server/db的qmPlus.sql

V2.3.0~V2.3.31

comfig.yaml 的mysql的账号密码配置自行修改
config.yaml 中的 system 下存在一行 need-init-data: false 将此参数设定为 true
启动项目就自动通过代码方式进行初始化数据

注意

重启项目一定一定一定要记得 need-init-data: false 将此参数设定为 false

V2.3.4~V2.3.9

配置好 server/config.yaml 的 mysql 中的 path , db-name, username ,password,其他的按需修改,我们 flipped-aurora 团队为各位使用者准备好了脚本

windows 用户

方式一(不可见错误报错):

// 开启 Go Modules模式并设置代理
go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.io,direct
直接运行 server 目录下的 initdb.bat (双击)

方式二(可见错误报错):

以server为项目打开的,打开Goland的终端

initdb.bat

linux, mac 用户

# 开启 Go Modules模式并设置代理, 已经设置的用户可跳过
go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.io,direct

# 在server项目下,先构建gva终端工具
make gva
# 使用gva进行初始化数据, 如果不使用make initdb, 使用./gva initdb也是可以的
make initdb

注意

mysql>=5.7版本的数据库，一定情况下会初始化失败，此时注意数据库编码设置为utf8-mb4，忽略掉时间0值校验，即可解决问题。使用命令行工具运行initdb，或者make可以查看到报错内容。

说明-今后都会使用gva终端工具进行初始化数据,理由如下:
V2.3.0~V2.3.31所使用的方式，有人只会改成 true ,第二次启动就忘了改为 false, 导致server项目启动失败
方便新增数据，而不需要跟以前一样修改 .sql 文件
gva终端初始化数据是通过代码+gorm的事务进行添加数据，大概率不同版本的mysql之间一些问题的，规避了字符集的问题问题而导致数据的导入失败，或者乱码问题

4. 启动server项目

完成后打开main.go, 在文件空白处鼠标右键点击运行'go build main.go',或者使用图中红色框的右边的快捷键组合进行启动项目或者打开goland的终端,输入命令go run main.go

5. 生成swagger自动化API文档

5.1 安装 swagger

可以翻墙

go get -u github.com/swaggo/swag/cmd/swag

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

# 如果您使用的 Go 版本是 1.13 及以上(推荐)
# 启用 Go Modules 功能
go env -w GO111MODULE=on 
# 配置 GOPROXY 环境变量
go env -w GOPROXY=https://goproxy.io,direct

# 使用如下命令下载swag
go get -u github.com/swaggo/swag/cmd/swag

5.2 生成API文档

cd server
swag init

执行上面的命令后，server目录下会出现docs文件夹，打开浏览器输入 http://localhost:8888/swagger/index.html，即可查看swagger文档

您可能遇到的问题

启动时报数据库启动失败，请检查是否创建qmsql数据库，或者是否是您自行配置的数据库
登录时用户名密码错误，请检查数据库文件是否导入

视频推荐#

一步到位#

Golang教学#

Gin教学#

gin-vue-admin版本更新说明#

server项目结构#

本文使用的环境#

1. 初始化server项目#

2. config.yaml#

3. 数据库初始化#

请对应版本进行观看初始化数据的方式#

V2.4.0~master(最新版)#

注意

1. 启动server项目 与 web项目#

以下为旧版本#

V2.0.0~V2.2.0#

V2.3.0~V2.3.31#

注意

V2.3.4~V2.3.9#

注意

4. 启动server项目#

5. 生成swagger自动化API文档#

5.1 安装 swagger#

5.2 生成API文档#

您可能遇到的问题

视频推荐

一步到位

Golang教学

Gin教学

gin-vue-admin版本更新说明

server项目结构

本文使用的环境

1. 初始化server项目

2. config.yaml

3. 数据库初始化

请对应版本进行观看初始化数据的方式

V2.4.0~master(最新版)

1. 启动server项目与 web项目

以下为旧版本

V2.0.0~V2.2.0

V2.3.0~V2.3.31

V2.3.4~V2.3.9

4. 启动server项目

5. 生成swagger自动化API文档

5.1 安装 swagger

5.2 生成API文档