gin-vue-admin-1

思考并回答以下问题：

源码地址gitee
源码地址github

基本介绍

Gin-vue-admin是一个基于vue和gin开发的全栈前后端分离的开发基础平台，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，表单生成器，代码生成器，分页封装，多点登录拦截，资源权限，上传下载等功能。

在线预览

测试用户名：admin

测试密码：123456

使用说明

- node版本 > v16.8.3
- golang版本 >= v1.16
- IDE推荐：Goland

server项目

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

# 克隆项目
git clone https://github.com/flipped-aurora/gin-vue-admin.git
# 进入server文件夹
cd server

# 使用 go mod 并安装go依赖包
go generate

# linux编译 
go build -o server main.go 

# windows编译命令为
# go build -o server.exe main.go

# 运行二进制
./server 

# windows运行命令为 server.exe

web项目

# 进入web文件夹
cd web

# 安装依赖
npm install

# 启动web项目
npm run serve

swagger自动化API文档

安装swagger

（1）可以访问外国网站

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

（2）无法访问外国网站

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

# 如果您使用的 Go 版本是 1.13 - 1.15 需要手动设置GO111MODULE=on, 开启方式如下命令, 如果你的 Go 版本 是 1.16 ~ 最新版 可以忽略以下步骤一
# 步骤一、启用 Go Modules 功能
go env -w GO111MODULE=on 
# 步骤二、配置 GOPROXY 环境变量
go env -w GOPROXY=https://goproxy.cn,https://goproxy.io,direct

# 如果嫌弃麻烦，可以使用go generate编译前自动执行代码, 不过这个不能使用 `Goland` 或者 `Vscode` 的 命令行终端
cd server
go generate -run "go env -w .*?"

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

生成API文档

cd server
swag init

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

VSCode工作区

开发

使用VSCode打开根目录下的工作区文件gin-vue-admin.code-workspace，在边栏可以看到三个虚拟目录：backend、frontend、root。

运行/调试

在运行和调试中也可以看到三个task：Backend、Frontend、Both (Backend & Frontend)。运行Both (Backend & Frontend)可以同时启动前后端项目。

settings

在工作区配置文件中有go.toolsEnvVars字段，是用于VSCode自身的go工具环境变量。此外在多go版本的系统中，可以通过gopath、go.goroot指定运行版本。

"go.gopath": null,
"go.goroot": null,

技术选型

• 前端：用基于Vue的Element构建基础页面。
• 后端：用Gin快速搭建基础Restful风格API，Gin是一个go语言编写的Web框架。
• 数据库：采用MySql > (5.7)版本数据库引擎InnoDB，使用gorm实现对数据库的基本操作。
• 缓存：使用Redis实现记录当前活跃用户的jwt令牌并实现多点登录限制。
• API文档：使用Swagger构建自动化文档。
• 配置文件：使用fsnotify和viper 实现yaml格式的配置文件。
• 日志：使用zap 实现日志记录。

server项目结构

├── 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
    ├── babel.config.js
    ├── Dockerfile
    ├── favicon.ico
    ├── index.html                 -- 主页面
    ├── limit.js                   -- 助手代码
    ├── package.json               -- 包管理器代码
    ├── src                        -- 源代码
    │   ├── api                    -- api 组
    │   ├── App.vue                -- 主页面
    │   ├── assets                 -- 静态资源
    │   ├── components             -- 全局组件
    │   ├── core                   -- gva 组件包
    │   │   ├── config.js          -- gva网站配置文件
    │   │   ├── gin-vue-admin.js   -- 注册欢迎文件
    │   │   └── global.js          -- 统一导入文件
    │   ├── directive              -- v-auth 注册文件
    │   ├── main.js                -- 主文件
    │   ├── permission.js          -- 路由中间件
    │   ├── pinia                  -- pinia 状态管理器，取代vuex
    │   │   ├── index.js           -- 入口文件
    │   │   └── modules            -- modules
    │   │       ├── dictionary.js
    │   │       ├── router.js
    │   │       └── user.js
    │   ├── router                 -- 路由声明文件
    │   │   └── index.js
    │   ├── style                  -- 全局样式
    │   │   ├── base.scss
    │   │   ├── basics.scss
    │   │   ├── element_visiable.scss  -- 此处可以全局覆盖 element-plus 样式
    │   │   ├── iconfont.css           -- 顶部几个icon的样式文件
    │   │   ├── main.scss
    │   │   ├── mobile.scss
    │   │   └── newLogin.scss
    │   ├── utils                  -- 方法包库
    │   │   ├── asyncRouter.js     -- 动态路由相关
    │   │   ├── btnAuth.js         -- 动态权限按钮相关
    │   │   ├── bus.js             -- 全局mitt声明文件
    │   │   ├── date.js            -- 日期相关
    │   │   ├── dictionary.js      -- 获取字典方法 
    │   │   ├── downloadImg.js     -- 下载图片方法
    │   │   ├── format.js          -- 格式整理相关
    │   │   ├── image.js           -- 图片相关方法
    │   │   ├── page.js            -- 设置页面标题
    │   │   ├── request.js         -- 请求
    │   │   └── stringFun.js       -- 字符串文件
    |   ├── view -- 主要view代码
    |   |   ├── about -- 关于我们
    |   |   ├── dashboard -- 面板
    |   |   ├── error -- 错误
    |   |   ├── example --上传案例
    |   |   ├── iconList -- icon列表
    |   |   ├── init -- 初始化数据  
    |   |   |   ├── index -- 新版本
    |   |   |   ├── init -- 旧版本
    |   |   ├── layout  --  layout约束页面 
    |   |   |   ├── aside 
    |   |   |   ├── bottomInfo     -- bottomInfo
    |   |   |   ├── screenfull     -- 全屏设置
    |   |   |   ├── setting        -- 系统设置
    |   |   |   └── index.vue      -- base 约束
    |   |   ├── login              --登录 
    |   |   ├── person             --个人中心 
    |   |   ├── superAdmin         -- 超级管理员操作
    |   |   ├── system             -- 系统检测页面
    |   |   ├── systemTools        -- 系统配置相关页面
    |   |   └── routerHolder.vue   -- page 入口页面 
    ├── vite.config.js             -- vite 配置文件
    └── yarn.lock

文件夹	说明	描述
api	api层	api层
--v1	v1版本接口	v1版本接口
config	配置包	config.yaml对应的配置结构体
core	核心文件	核心组件（zap, viper, server）的初始化
docs	swagger文档目录	swagger文档目录
global	全局对象	全局对象
initialize	初始化	router, redis, gorm, validator, timer的初始化
--internal	初始化内部函数	gorm的logger自定义，在此文件夹的函数只能由initialize层进行调用
middleware	中间件层	用于存放gin中间件代码
model	模型层	模型对应数据表
--request	入参结构体	接收前端发送到后端的数据
--response	出参结构体	返回给前端的数据结构体
packfile	静态文件打包	静态文件打包
resource	静态资源文件夹	负责存放静态文件
--excel	excel导入导出默认路径	excel导入导出默认路径
--page	表单生成器	表单生成器打包后的dist
--template	模板	模板文件夹，存放的是代码生成器的模板
router	路由层	路由层
service	service层	存放业务逻辑问题
source	source层	存放初始化数据的函数
utils	工具包	工具函数封装
--timer	timer	定时器接口封装
--upload	oss	oss接口封装

main.go

package main

import (
    "go.uber.org/zap"

    "github.com/flipped-aurora/gin-vue-admin/server/core"
    "github.com/flipped-aurora/gin-vue-admin/server/global"
    "github.com/flipped-aurora/gin-vue-admin/server/initialize"
)

//go:generate go env -w GO111MODULE=on
//go:generate go env -w GOPROXY=https://goproxy.cn,direct
//go:generate go mod tidy
//go:generate go mod download

// @title                       Swagger Example API
// @version                     0.0.1
// @description                 This is a sample Server pets
// @securityDefinitions.apikey  ApiKeyAuth
// @in                          header
// @name                        x-token
// @BasePath                    /
func main() {
    global.GVA_VP = core.Viper() // 初始化Viper
    initialize.OtherInit()
    global.GVA_LOG = core.Zap() // 初始化zap日志库
    zap.ReplaceGlobals(global.GVA_LOG)
    global.GVA_DB = initialize.Gorm() // gorm连接数据库
    initialize.Timer()
    initialize.DBList()
    if global.GVA_DB != nil {
        initialize.RegisterTables() // 初始化表
        // 程序结束前关闭数据库链接
        db, _ := global.GVA_DB.DB()
        defer db.Close()
    }
    core.RunWindowsServer()
}

Dockerfile

FROM golang:alpine as builder

WORKDIR /go/src/github.com/flipped-aurora/gin-vue-admin/server
COPY . .

RUN go env -w GO111MODULE=on \
    && go env -w GOPROXY=https://goproxy.cn,direct \
    && go env -w CGO_ENABLED=0 \
    && go env \
    && go mod tidy \
    && go build -o server .

FROM alpine:latest

LABEL MAINTAINER="SliverHorn@sliver_horn@qq.com"

WORKDIR /go/src/github.com/flipped-aurora/gin-vue-admin/server

COPY --from=0 /go/src/github.com/flipped-aurora/gin-vue-admin/server/server ./
COPY --from=0 /go/src/github.com/flipped-aurora/gin-vue-admin/server/resource ./resource/
COPY --from=0 /go/src/github.com/flipped-aurora/gin-vue-admin/server/config.docker.yaml ./

EXPOSE 8888
ENTRYPOINT ./server -c config.docker.yaml

config.yaml

# github.com/flipped-aurora/gin-vue-admin/server Global Configuration

# jwt configuration
jwt:
  signing-key: qmPlus
  expires-time: 7d
  buffer-time: 1d
  issuer: qmPlus
# zap logger configuration
zap:
  level: info
  format: console
  prefix: "[github.com/flipped-aurora/gin-vue-admin/server]"
  director: log
  show-line: true
  encode-level: LowercaseColorLevelEncoder
  stacktrace-key: stacktrace
  log-in-console: true

# redis configuration
redis:
  db: 0
  addr: 127.0.0.1:6379
  password: ""

# email configuration
email:
  to: xxx@qq.com
  port: 465
  from: xxx@163.com
  host: smtp.163.com
  is-ssl: true
  secret: xxx
  nickname: test

# system configuration
system:
  env: public # Change to "develop" to skip authentication for development mode
  addr: 8888
  db-type: mysql
  oss-type: local # 控制oss选择走本地还是 七牛等其他仓 自行增加其他oss仓可以在 server/utils/upload/upload.go 中 NewOss函数配置
  use-redis: false # 使用redis
  use-multipoint: false
  # IP限制次数 一个小时15000次
  iplimit-count: 15000
  #  IP限制一个小时
  iplimit-time: 3600
  #  路由全局前缀
  router-prefix: ""

# captcha configuration
captcha:
  key-long: 6
  img-width: 240
  img-height: 80
  open-captcha: 0 # 0代表一直开启，大于0代表限制次数
  open-captcha-timeout: 3600 # open-captcha大于0时才生效

# mysql connect configuration
# 未初始化之前请勿手动修改数据库信息！！！如果一定要手动初始化请看（https://gin-vue-admin.com/docs/first_master）
mysql:
  path: ""
  port: ""
  config: ""
  db-name: ""
  username: ""
  password: ""
  max-idle-conns: 10
  max-open-conns: 100
  log-mode: ""
  log-zap: false

# pgsql connect configuration
# 未初始化之前请勿手动修改数据库信息！！！如果一定要手动初始化请看（https://gin-vue-admin.com/docs/first_master）
pgsql:
  path: ""
  port: ""
  config: ""
  db-name: ""
  username: ""
  password: ""
  max-idle-conns: 10
  max-open-conns: 100
  log-mode: ""
  log-zap: false
oracle:
  path: ""
  port: ""
  config: ""
  db-name: ""
  username: ""
  password: ""
  max-idle-conns: 10
  max-open-conns: 100
  log-mode: ""
  log-zap: false
mssql:
  path: ""
  port: ""
  config: ""
  db-name: ""
  username: ""
  password: ""
  max-idle-conns: 10
  max-open-conns: 100
  log-mode: ""
  log-zap: false
db-list:
  - disable: true # 是否禁用
    type: "" # 数据库的类型,目前支持mysql、pgsql、mssql、oracle
    alias-name: "" # 数据库的名称,注意: alias-name 需要在db-list中唯一
    path: ""
    port: ""
    config: ""
    db-name: ""
    username: ""
    password: ""
    max-idle-conns: 10
    max-open-conns: 100
    log-mode: ""
    log-zap: false

# local configuration
local:
  path: uploads/file
  store-path: uploads/file

# autocode configuration
autocode:
  transfer-restart: true
  # root 自动适配项目根目录
  # 请不要手动配置,他会在项目加载的时候识别出根路径
  root: ""
  server: /server
  server-plug: /plugin/%s
  server-api: /api/v1/%s
  server-initialize: /initialize
  server-model: /model/%s
  server-request: /model/%s/request/
  server-router: /router/%s
  server-service: /service/%s
  web: /web/src
  web-api: /api
  web-form: /view
  web-table: /view

# qiniu configuration (请自行七牛申请对应的 公钥 私钥 bucket 和 域名地址)
qiniu:
  zone: ZoneHuaDong
  bucket: ""
  img-path: ""
  use-https: false
  access-key: ""
  secret-key: ""
  use-cdn-domains: false

# aliyun oss configuration
aliyun-oss:
  endpoint: yourEndpoint
  access-key-id: yourAccessKeyId
  access-key-secret: yourAccessKeySecret
  bucket-name: yourBucketName
  bucket-url: yourBucketUrl
  base-path: yourBasePath

# tencent cos configuration
tencent-cos:
  bucket: xxxxx-10005608
  region: ap-shanghai
  secret-id: your-secret-id
  secret-key: your-secret-key
  base-url: https://gin.vue.admin
  path-prefix: github.com/flipped-aurora/gin-vue-admin/server

# aws s3 configuration (minio compatible)
aws-s3:
  bucket: xxxxx-10005608
  region: ap-shanghai
  endpoint: ""
  s3-force-path-style: false
  disable-ssl: false
  secret-id: your-secret-id
  secret-key: your-secret-key
  base-url: https://gin.vue.admin
  path-prefix: github.com/flipped-aurora/gin-vue-admin/server

# huawei obs configuration
hua-wei-obs:
  path: you-path
  bucket: you-bucket
  endpoint: you-endpoint
  access-key: you-access-key
  secret-key: you-secret-key

# excel configuration
excel:
  dir: ./resource/excel/

# timer task db clear table
Timer:
  start: true
  spec: "@daily" # 定时任务详细配置参考 https://pkg.go.dev/github.com/robfig/cron/v3
  detail:
    - tableName: sys_operation_records
      compareField: created_at
      interval: 2160h
    - tableName: jwt_blacklists
      compareField: created_at
      interval: 168h

# 跨域配置
# 需要配合 server/initialize/router.go -> `Router.Use(middleware.CorsByRules())` 使用
cors:
  mode: strict-whitelist # 放行模式: allow-all, 放行全部; whitelist, 白名单模式, 来自白名单内域名的请求添加 cors 头; strict-whitelist 严格白名单模式, 白名单外的请求一律拒绝
  whitelist:
    - allow-origin: example1.com
      allow-headers: Content-Type,AccessToken,X-CSRF-Token, Authorization, Token,X-Token,X-User-Id
      allow-methods: POST, GET
      expose-headers: Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type

      allow-credentials: true # 布尔值
    - allow-origin: example2.com
      allow-headers: content-type
      allow-methods: GET, POST
      expose-headers: Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type
      allow-credentials: true # 布尔值