2021-11-03 09:15:54 +08:00
# 目录
- [goweb-gin-demo ](#goweb-gin-demo )
- [web框架gin ](#web框架gin )
2021-11-03 09:17:55 +08:00
- [特性 ](#特性 )
2021-11-03 09:15:54 +08:00
- [服务创建及启动 ](#服务创建及启动 )
- [gorm ](#gorm )
- [概述 ](#概述 )
- [模型定义 ](#模型定义 )
- [连接数据库 ](#连接数据库 )
- [连接池 ](#连接池 )
- [CRUD ](#crud )
- [基本操作 ](#基本操作 )
- [创建钩子 ](#创建钩子 )
- [通过Swagger测试接口, 中文文档 ](#通过swagger测试接口-中文文档 )
- [验证码获取及校验 ](#验证码获取及校验 )
- [获取菜单项 ](#获取菜单项 )
- [使用casbin 控制权限 ](#使用casbin-控制权限 )
- [文件上传及下载 ](#文件上传及下载 )
- [代码自动生成 ](#代码自动生成 )
- [反射reflect ](#反射reflect )
- [GoWeb 发布 ](#goweb-发布 )
- [疑问及拓展 ](#疑问及拓展 )
2021-11-03 09:17:55 +08:00
- [为什么函数或方法中变量名很多都是大写字母开始的? ](#为什么函数或方法中变量名很多都是大写字母开始的 )
- [unsupported Scan, storing driver.Value type []uint8 into type *time.Time](#unsupported-scan-storing-drivervalue-type-uint8-into-type-timetime)
- [Error 1075: Incorrect table definition; there can be only one auto column and it must be defined as a key ](#error-1075-incorrect-table-definition-there-can-be-only-one-auto-column-and-it-must-be-defined-as-a-key )
- [查看http请求详情 ](#查看http请求详情 )
2021-11-03 09:15:54 +08:00
2021-10-27 15:24:25 +08:00
# goweb-gin-demo
2021-11-01 18:19:42 +08:00
go web脚手架, [数据库及表结构 ](./resource/sql/weekly_report.sql )
2021-10-29 14:39:50 +08:00
2021-11-03 09:15:54 +08:00
# [web框架gin](https://gin-gonic.com/zh-cn/docs/introduction/)
[中文参考文档 ](https://www.kancloud.cn/shuangdeyu/gin_book/949411 )
2021-10-29 14:39:50 +08:00
## 特性
2021-11-02 17:48:39 +08:00
- 快速
2021-10-29 14:39:50 +08:00
基于 Radix 树的路由，小内存占用。没有反射。可预测的 API 性能。
2021-11-02 17:48:39 +08:00
- 支持中间件
2021-10-29 14:39:50 +08:00
传入的 HTTP 请求可以由一系列中间件和最终操作来处理。 例如： ， ， ，
2021-11-02 17:48:39 +08:00
- Crash 处理
2021-10-29 14:39:50 +08:00
Gin 可以 catch 一个发生在 HTTP 请求中的 panic 并 recover 它。这样，你的服务器将始终可用。例如，你可以向 Sentry 报告这个 panic！
2021-11-02 17:48:39 +08:00
- JSON 验证
2021-10-29 14:39:50 +08:00
Gin 可以解析并验证请求的 JSON，
2021-11-02 17:48:39 +08:00
- 路由组
2021-10-29 14:39:50 +08:00
更好地组织路由。是否需要授权，不同的 API 版本…… 此外，这些组可以无限制地嵌套而不会降低性能。
2021-11-02 17:48:39 +08:00
- 错误管理
2021-10-29 14:39:50 +08:00
Gin 提供了一种方便的方法来收集 HTTP 请求期间发生的所有错误。最终，中间件可以将它们写入日志文件，数据库并通过网络发送。
2021-11-02 17:48:39 +08:00
- 内置渲染
2021-10-29 14:39:50 +08:00
Gin 为 JSON，
2021-11-02 17:48:39 +08:00
- 可扩展性
2021-10-29 14:39:50 +08:00
新建一个中间件非常简单，去查看 [示例代码 ](https://gin-gonic.com/zh-cn/docs/examples/ ) 吧。
## 服务创建及启动
[官方demo ](https://gin-gonic.com/zh-cn/docs/quickstart/ )
把ping映射在参数为(c *gin.Context)的方法
```
package main
import "github.com/gin-gonic/gin"
func main() {
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "pong",
})
})
r.Run() // 监听并在 0.0.0.0:8080 上启动服务
}
```
endless 创建服务
```
func main() {
mux1 := mux.NewRouter()
mux1.HandleFunc("/hello", handler).
Methods("GET")
srv := endless.NewServer("localhost:4244", mux1)
srv.SignalHooks[endless.PRE_SIGNAL][syscall.SIGUSR1] = append(
srv.SignalHooks[endless.PRE_SIGNAL][syscall.SIGUSR1],
preSigUsr1)
srv.SignalHooks[endless.POST_SIGNAL][syscall.SIGUSR1] = append(
srv.SignalHooks[endless.POST_SIGNAL][syscall.SIGUSR1],
postSigUsr1)
err := srv.ListenAndServe()
if err != nil {
log.Println(err)
}
log.Println("Server on 4244 stopped")
os.Exit(0)
}
```
2021-11-02 17:48:39 +08:00
# [gorm](https://gorm.io/zh_CN/docs/index.html)
## 概述
- 全功能 ORM
- 关联 (Has One， ， ， ， ，
- Create， ， ， ，
- 支持 Preload、Joins 的预加载，
- 事务， ， ，
- Context、预编译模式、DryRun 模式DryRun 模式
- 批量插入， ， ，
- SQL 构建器， ， ， ， ，
- 复合主键，索引，约束
- Auto Migration
- 自定义 Logger
- 灵活的可扩展插件 API： （ ， ） ： （ ，
- 每个特性都经过了测试的重重考验
- 开发者友好
## 模型定义
```
type User struct {
ID uint
Name string
Email *string
Age uint8
Birthday *time.Time
MemberNumber sql.NullString
ActivatedAt sql.NullTime
CreatedAt time.Time
UpdatedAt time.Time
}
```
GORM 使用结构体名的 蛇形命名 作为表名。对于结构体 User， ，
您可以实现 Tabler 接口来更改默认表名，例如：
```
type Tabler interface {
TableName() string
}
// TableName 会将 User 的表名重写为 `profiles`
func (User) TableName() string {
return "profiles"
}
```
您可以使用 Table 方法临时指定表名，例如：
```
// 根据 User 的字段创建 `deleted_users` 表
db.Table("deleted_users").AutoMigrate(& User{})
// 从另一张表查询数据
var deletedUsers []User
db.Table("deleted_users").Find(& deletedUsers)
// SELECT * FROM deleted_users;
db.Table("deleted_users").Where("name = ?", "jinzhu").Delete(& User{})
// DELETE FROM deleted_users WHERE name = 'jinzhu';
```
## 连接数据库
```
import (
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
func main() {
// 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情
dsn := "user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4& parseTime=True& loc=Local"
db, err := gorm.Open(mysql.Open(dsn), & gorm.Config{})
}
```
2021-10-29 14:39:50 +08:00
2021-11-02 17:48:39 +08:00
### 连接池
GORM 使用 database/sql 维护连接池
```
sqlDB, err := db.DB()
// SetMaxIdleConns 设置空闲连接池中连接的最大数量
sqlDB.SetMaxIdleConns(10)
// SetMaxOpenConns 设置打开数据库连接的最大数量。
sqlDB.SetMaxOpenConns(100)
// SetConnMaxLifetime 设置了连接可复用的最大时间。
sqlDB.SetConnMaxLifetime(time.Hour)
```
## CRUD
### 基本操作
```
# 创建记录
user := User{Name: "Jinzhu", Age: 18, Birthday: time.Now()}
result := db.Create(& user) // 通过数据的指针来创建
user.ID // 返回插入数据的主键
result.Error // 返回 error
result.RowsAffected // 返回插入记录的条数
----------------------------------------------------------------------
# 查询
// 获取第一条记录（主键升序）
db.First(& user)
// SELECT * FROM users ORDER BY id LIMIT 1;
// 获取一条记录，没有指定排序字段
db.Take(& user)
// SELECT * FROM users LIMIT 1;
// 获取最后一条记录（主键降序）
db.Last(& user)
// SELECT * FROM users ORDER BY id DESC LIMIT 1;
----------------------------------------------------------------------
# 更新
user.Name = "jinzhu 2"
user.Age = 100
db.Save(& user)
// UPDATE users SET name='jinzhu 2', age=100, birthday='2016-01-01', updated_at = '2013-11-17 21:34:10' WHERE id=111
----------------------------------------------------------------------
# 删除
// Email 的 ID 是 `10`
db.Delete(& email)
// DELETE from emails where id = 10;
// 带额外条件的删除
db.Where("name = ?", "jinzhu").Delete(& email)
// DELETE from emails where id = 10 AND name = "jinzhu";
----------------------------------------------------------------------
```
### 创建钩子
GORM 允许用户定义的钩子有 BeforeSave, BeforeCreate, AfterSave, AfterCreate 创建记录时将调用这些钩子方法，请参考 Hooks 中关于生命周期的详细信息
```
func (u *User) BeforeCreate(tx *gorm.DB) (err error) {
u.UUID = uuid.New()
if u.Role == "admin" {
return errors.New("invalid role")
}
return
}
```
# 通过Swagger测试接口, [中文文档](https://github.com/swaggo/swag/blob/master/README_zh-CN.md)
2021-10-29 14:39:50 +08:00
[官方地址 ](https://github.com/swaggo ) ,其中包含`swag`可执行程序和`gin-swagger`go web模块, [使用手册 ](https://github.com/swaggo/gin-swagger )
2021-11-01 18:19:42 +08:00
查看地址为: **http://IP:8888/swagger/index.html**
2021-10-29 14:39:50 +08:00
```
// @BasePath /api/v1
// PingExample godoc
// @Summary ping example
// @Schemes
// @Description do ping
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK,"helloworld")
}
```
生成文档`swag init`
```
docs/
├── docs.go
├── swagger.json
└── swagger.yaml
```
2021-10-29 14:44:41 +08:00
> 需要注意把docs文件夹导入到代码中 `import "goweb-gin-demo/docs"`
2021-10-29 14:39:50 +08:00
2021-10-31 21:59:08 +08:00
- **如何获取到方法的注释呢?**
2021-10-29 14:39:50 +08:00
# 验证码获取及校验
首选通过`/base/captcha`获取验证码,其中包含验证码图片地址:`data:image/png;...`
```
{
}
```
在用户登录时，请求的数据为:
```
{
"username": "admin",
"password": "123456",
"captcha": "153842",
"captchaId": "hrzSvHSdGo4Emm9oG9OY"
}
```
携带着验证码及验证码的Id, 框架通过Id去匹配输入的验证码。
登录城后后返回信息:
```
{
}
```
2021-11-01 18:19:42 +08:00
jwt token
< br >
< div align = center >
< img src = "./resource/md_res/jwt.png" width = "60%" height = "60%" title = "JWT Token" > < / img >
< / div >
< br >
**用户-角色权限-菜单项|API|资源对应关系图**
< br >
2021-11-02 17:48:39 +08:00
2021-11-01 18:19:42 +08:00
2021-10-29 14:39:50 +08:00
# 获取菜单项
api接口`/api/menu/getMenu`
头文件携带信息:
```
x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVVUlEIjoiOGU2MDBiN2YtMzI5Ny00OTc5LWE0NDUtZDIxODIwNWVmOWE2IiwiSUQiOjEsIlVzZXJuYW1lIjoiYWRtaW4iLCJOaWNrTmFtZSI6Iui2hee6p-euoeeQhuWRmCIsIkF1dGhvcml0eUlkIjoiODg4IiwiQnVmZmVyVGltZSI6ODY0MDAsImV4cCI6MTYzNjAyMDY2MSwiaXNzIjoicW1QbHVzIiwibmJmIjoxNjM1NDE0ODYxfQ.-E9YNI6YV3XLbC5GgXiftTBI7A5ZiIheH5dqwgwnaDA
x-user-id: 1
```
2021-10-31 21:59:08 +08:00
- **角色对应着菜单项和API接口**
通过userid获取权限id(`SELECT * FROM `sys_user_authority` WHERE `sys_user_authority` .`sys_user_id` = 1`)
```
+-------------+----------------------------+
| sys_user_id | sys_authority_authority_id |
+-------------+----------------------------+
| 1 | 888 | 普通用户
| 1 | 8881 | 普通子用户
| 1 | 9528 | 测试用户
+-------------+----------------------------+
```
通过权限ID获取权限(`SELECT * FROM `sys_authorities` WHERE `sys_authorities` .`authority_id` IN ('888','8881','9528')`)
```
+---------------------+---------------------+------------+--------------+----------------+-----------+----------------+
| created_at | updated_at | deleted_at | authority_id | authority_name | parent_id | default_router |
+---------------------+---------------------+------------+--------------+----------------+-----------+----------------+
| 2021-10-25 14:53:31 | 2021-10-25 14:53:31 | NULL | 888 | ???? | 0 | dashboard |
| 2021-10-25 14:53:31 | 2021-10-25 14:53:31 | NULL | 8881 | ??????? | 888 | dashboard |
| 2021-10-25 14:53:31 | 2021-10-25 14:53:31 | NULL | 9528 | ???? | 0 | dashboard |
+---------------------+---------------------+------------+--------------+----------------+-----------+----------------+
```
返回数据样本
```
{
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
2021-11-01 18:19:42 +08:00
2021-10-31 21:59:08 +08:00
}
```
2021-10-29 14:39:50 +08:00
2021-11-02 17:48:39 +08:00
# 使用[casbin](https://github.com/casbin/casbin) 控制权限
2021-10-29 14:39:50 +08:00
Casbin is a powerful and efficient open-source access control library. It provides support for enforcing authorization based on various access control models.
可以 [在线 ](https://casbin.org/editor/ ) 书写规则:
创建一个Casbin enforcer
```
import "github.com/casbin/casbin/v2"
e, err := casbin.NewEnforcer("path/to/model.conf", "path/to/policy.csv")
```
检查权限
```
sub := "alice" // the user that wants to access a resource.
obj := "data1" // the resource that is going to be accessed.
act := "read" // the operation that the user performs on the resource.
ok, err := e.Enforce(sub, obj, act)
if err != nil {
// handle err
}
if ok == true {
// permit alice to read data1
} else {
// deny the request, show an error
}
// You could use BatchEnforce() to enforce some requests in batches.
// This method returns a bool slice, and this slice's index corresponds to the row index of the two-dimensional array.
// e.g. results[0] is the result of {"alice", "data1", "read"}
results, err := e.BatchEnforce([][]interface{}{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"jack", "data3", "read"}})
```
2021-11-02 12:02:43 +08:00
2021-10-29 14:39:50 +08:00
# 文件上传及下载
2021-11-03 09:15:54 +08:00
文件上传及下载code
```
func main() {
router := gin.Default()
// 给表单限制上传大小 (默认 32 MiB)
// router.MaxMultipartMemory = 8 < < 20 / / 8 MiB
router.POST("/upload", func(c *gin.Context) {
// 单文件
file, _ := c.FormFile("file")
log.Println(file.Filename)
// 上传文件到指定的路径
// c.SaveUploadedFile(file, dst)
c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
})
router.Run(":8080")
}
```
```
// @Tags FileUploadAndDownload
// @Summary 文件下载
// @Security ApiKeyAuth
// @accept application/json
// @Produce application/json
// @Param fileName query string true "待下载的文件名"
// @Success 200 {string} string "{"success":true,"data":{},"msg":"文件下载成功"}"
// @Router /fileUploadAndDownload/download [get]
func (u *FileUploadAndDownloadApi) DownloadFile(c *gin.Context) {
fileName := c.Query("fileName")
//待下载的文件是存储本地的,如果存储在云盘，直接访问链接即可
//如果没有记录， ，
err, fileInfo := fileUploadAndDownloadService.FindFile(fileName)
if err != nil {
global.GLOBAL_LOG.Error("文件未找到!", zap.Any("err", err))
c.Redirect(http.StatusFound, "/404")
return
}
c.Header("Content-Type", "application/octet-stream")
c.Header("Content-Disposition", "attachment; filename="+fileInfo.Name)
c.Header("Content-Transfer-Encoding", "binary")
c.File(fileInfo.Url)
return
}
```
2021-11-02 17:48:39 +08:00
文件上传成功返回:
```
{
"code": 0,
"data": {
"file": {
"ID": 0,
"CreatedAt": "0001-01-01T00:00:00Z",
"UpdatedAt": "0001-01-01T00:00:00Z",
"name": "demo.c",
"url": "/Users/zero/Documents/uploads/file/fe01ce2a7fbac8fafaed7c982a04e229_20211102170427.c",
"tag": "c",
"key": "fe01ce2a7fbac8fafaed7c982a04e229_20211102170427.c"
}
},
"msg": "上传成功"
}
```
数据库信息:
```
mysql> select * from file_upload_and_downloads;
+----+---------------------+---------------------+------------+--------+--------------------------------------------------------------------------------------+------+---------------------------------------------------+
| id | created_at | updated_at | deleted_at | name | url | tag | key |
+----+---------------------+---------------------+------------+--------+--------------------------------------------------------------------------------------+------+---------------------------------------------------+
| 3 | 2021-11-02 09:04:27 | 2021-11-02 09:04:27 | NULL | demo.c | /Users/zero/Documents/uploads/file/fe01ce2a7fbac8fafaed7c982a04e229_20211102170427.c | c | fe01ce2a7fbac8fafaed7c982a04e229_20211102170427.c |
+----+---------------------+---------------------+------------+--------+--------------------------------------------------------------------------------------+------+---------------------------------------------------+
```
2021-11-03 09:15:54 +08:00
# 代码自动生成
gin-vue-admin提供代码自动生成功能， ， ，
比如周报的表结构如下:
```
{
"header":"周报",
"contents":[
{"title":"", "content":""},
{"title":"", "content":""}
],
"attachments":[
{"pic":"fe01ce2a7fbac8fafaed7c982a04e229_20211102170427.png"},
{"file":"2db0df442ea6d92d75657712a29e5604_20211102201017.txt"}
]
}
```
2021-11-02 17:48:39 +08:00
2021-10-29 14:39:50 +08:00
# 反射reflect
[官方文档 ](https://pkg.go.dev/reflect )
包反射实现运行时反射，允许程序操作任意类型的对象。典型的用法是取一个静态类型 interface{} 的值，通过调用 TypeOf 提取其动态类型信息，返回一个 Type。
对 ValueOf 的调用返回一个表示运行时数据的值。Zero 接受一个 Type 并返回一个表示该类型的零值的 Value。
有关 Go 中反射的介绍，请参阅 [“反射定律” ](https://golang.org/doc/articles/laws_of_reflection.html )
动态调用有参数的函数
```
type T struct{}
func main() {
name := "Do"
t := & T{}
a := reflect.ValueOf(1111)
b := reflect.ValueOf("world")
in := []reflect.Value{a, b}
reflect.ValueOf(t).MethodByName(name).Call(in)
}
func (t *T) Do(a int, b string) {
fmt.Println("hello" + b, a)
}
```
2021-11-02 12:02:43 +08:00
# GoWeb 发布
go build编译出moduleName的可执行文件，
2021-10-29 14:39:50 +08:00
# 疑问及拓展
2021-11-03 09:15:54 +08:00
#### 为什么函数或方法中变量名很多都是大写字母开始的?
2021-10-29 14:39:50 +08:00
- 任何需要对外暴露的名字必须以大写字母开头，不需要对外暴露的则应该以小写字母开头。
但是gin-vue-admin代码中有很多大小，
2021-11-03 09:15:54 +08:00
2021-10-29 14:39:50 +08:00
```
# 函数中的变量Router
Router := initialize.Routers()
# 方法参数Router
func (s *BaseRouter) InitBaseRouter(Router *gin.RouterGroup) (R gin.IRoutes) {
```
2021-11-03 09:15:54 +08:00
#### unsupported Scan, storing driver.Value type []uint8 into type *time.Time
2021-10-29 14:39:50 +08:00
需要在连接数据库时增加参数:
```
db, err := sqlx.Connect("mysql", "myuser:mypass@tcp(127.0.0.1:3306)/mydb?parseTime=true")
```
Sets the location for time.Time values (when using parseTime=true). "Local" sets the system's location. See [time.LoadLocation ](https://pkg.go.dev/time#LoadLocation ) for details.
#### Error 1075: Incorrect table definition; there can be only one auto column and it must be defined as a key
日志信息
> 2021/10/29 11:44:55 /Users/zero/go/pkg/mod/github.com/casbin/gorm-adapter/v3@v3.4.4/adapter.go:373
> Error 1075: Incorrect table definition; there can be only one auto column and it must be defined as a key
> [7.259ms] [rows:0] ALTER TABLE `casbin_rule` ADD `id` bigint unsigned AUTO_INCREMENT
2021-10-31 21:59:08 +08:00
断点调试gorm-adapter/v3@v3.4.4/adapter.go, 最后上网搜索发现版本问题。 把版本都降低了
github.com/casbin/casbin/v2 v2.11.0
github.com/casbin/gorm-adapter/v3 v3.0.2
2021-11-02 17:48:39 +08:00
#### 查看http请求详情
通过查看gin.Context>>Request>>(Body io.ReadCloser)>>src>>R>>buf=>点击view就能看到http详情。
< br >
< div align = center >
< img src = "./resource/md_res/gin-http-res.jpg" width = "70%" height = "70%" title = "Go Http请求" > < / img >
< / div >
< br >
2021-10-29 14:39:50 +08:00
