[ go 与 golang | 青训营笔记]
这是我参与「第五届青训营 」伴学笔记创作活动的第 10 天, 在学习了go的相关基础知识以后，可以说是初步的了解了go,接下来，我们将步入全新的环节，今天我们学习go的一个常用web框架gin
6. 验证器
bind绑定器
需要使用参数验证功能，需要加binding tag
常用验证器
// 不能为空，并且不能没有这个字段
required： 必填字段，如：binding:"required"
// 针对字符串的长度
min 最小长度，如：binding:"min=5"
max 最大长度，如：binding:"max=10"
len 长度，如：binding:"len=6"
// 针对数字的大小
eq 等于，如：binding:"eq=3"
ne 不等于，如：binding:"ne=12"
gt 大于，如：binding:"gt=10"
gte 大于等于，如：binding:"gte=10"
lt 小于，如：binding:"lt=10"
lte 小于等于，如：binding:"lte=10"
// 针对同级字段的
eqfield 等于其他字段的值，如：PassWord string `binding:"eqfield=Password"`
nefield 不等于其他字段的值
- 忽略字段，如：binding:"-"
gin内置验证器
// 枚举 只能是red 或green
oneof=red green
// 字符串
contains=ranran // 包含fengfeng的字符串
excludes // 不包含
startswith // 字符串前缀
endswith // 字符串后缀
// 数组
dive // dive后面的验证就是针对数组中的每一个元素
// 网络验证
ip
ipv4
ipv6
uri
url
// uri 在于I(Identifier)是统一资源标示符，可以唯一标识一个资源。
// url 在于Locater，是统一资源定位符，提供找到该资源的确切路径
// 日期验证 1月2号下午3点4分5秒在2006年
datetime=2006-01-02
自定义验证的错误信息
当验证不通过时，会给出错误的信息，但是原始的错误信息不太友好，不利于用户查看
只需要给结构体加一个msg 的tag
type UserInfo struct {
Username string `json:"username" binding:"required" msg:"用户名不能为空"`
Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`
Email string `json:"email" binding:"email" msg:"邮箱地址格式不正确"`
}
当出现错误时，就可以来获取出错字段上的msg。
err：这个参数为ShouldBindJSON返回的错误信息obj：这个参数为绑定的结构体- 还有一点要注意的是，validator这个包要引用v10这个版本的，否则会出错
// GetValidMsg 返回结构体中的msg参数
func GetValidMsg(err error, obj any) string {
// 使用的时候，需要传obj的指针
getObj := reflect.TypeOf(obj)
// 将err接口断言为具体类型
if errs, ok := err.(validator.ValidationErrors); ok {
// 断言成功
for _, e := range errs {
// 循环每一个错误信息
// 根据报错字段名，获取结构体的具体字段
if f, exits := getObj.Elem().FieldByName(e.Field()); exits {
msg := f.Tag.Get("msg")
return msg
}
}
}
return err.Error()
}
自定义验证器
- 注册验证器函数
// github.com/go-playground/validator/v10
// 注意这个版本得是v10的
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
v.RegisterValidation("sign", signValid)
}
- 编写函数
// 如果用户名不等于fengfeng就校验失败
func signValid(fl validator.FieldLevel) bool {
name := fl.Field().Interface().(string)
if name != "fengfeng" {
return false
}
return true
}
- 使用
type UserInfo struct {
Name string `json:"name" binding:"sign" msg:"用户名错误"`
Age int `json:"age" binding:""`
}
package main
import (
"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
"github.com/go-playground/validator/v10"
"reflect"
)
func GetValidMsg(err error, obj interface{}) string {
// obj为结构体指针
getObj := reflect.TypeOf(obj)
// 断言为具体的类型，err是一个接口
if errs, ok := err.(validator.ValidationErrors); ok {
for _, e := range errs {
if f, exist := getObj.Elem().FieldByName(e.Field()); exist {
return f.Tag.Get("msg") //错误信息不需要全部返回，当找到第一个错误的信息时，就可以结束
}
}
}
return err.Error()
}
// 如果用户名不等于fengfeng就校验失败
func signValid(fl validator.FieldLevel) bool {
name := fl.Field().Interface().(string)
if name != "fengfeng" {
return false
}
return true
}
func main() {
router := gin.Default()
router.POST("/", func(c *gin.Context) {
type UserInfo struct {
Name string `json:"name" binding:"sign" msg:"用户名错误"`
Age int `json:"age" binding:""`
}
var user UserInfo
err := c.ShouldBindJSON(&user)
if err != nil {
// 显示自定义的错误信息
msg := GetValidMsg(err, &user)
c.JSON(200, gin.H{"msg": msg})
return
}
c.JSON(200, user)
})
// 注册
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
v.RegisterValidation("sign", signValid)
}
router.Run(":80")
}
7. 文件上传与下载
文件上传
单文件
func main() {
router := gin.Default()
// 为 multipart forms 设置较低的内存限制 (默认是 32 MiB)
// 单位是字节， << 是左移预算符号，等价于 8 * 2^20
// gin对文件上传大小的默认值是32MB
router.MaxMultipartMemory = 8 << 20 // 8 MiB
router.POST("/upload", func(c *gin.Context) {
// 单文件
file, _ := c.FormFile("file")
log.Println(file.Filename)
dst := "./" + file.Filename
// 上传文件至指定的完整文件路径
c.SaveUploadedFile(file, dst)
c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
})
router.Run(":8080")
}
服务端保存文件的几种方式
SaveUploadedFile
c.SaveUploadedFile(file, dst) // 文件对象 文件路径，注意要从项目根路径开始写
Create+Copy
file.Open的第一个返回值就是我们讲文件对象中的那个文件（只读的），我们可以使用这个去直接读取文件内容
file, _ := c.FormFile("file")
log.Println(file.Filename)
// 读取文件中的数据，返回文件对象
fileRead, _ := file.Open()
dst := "./" + file.Filename
// 创建一个文件
out, err := os.Create(dst)
if err != nil {
fmt.Println(err)
}
defer out.Close()
// 拷贝文件对象到out中
io.Copy(out, fileRead)
读取上传的文件
file, _ := c.FormFile("file")
// 读取文件中的数据，返回文件对象
fileRead, _ := file.Open()
data, _ := io.ReadAll(fileRead)
fmt.Println(string(data))
这里的玩法就很多了
例如我们可以基于文件中的内容，判断是否需要保存到服务器中
多文件上传
func main() {
router := gin.Default()
// 为 multipart forms 设置较低的内存限制 (默认是 32 MiB)
router.MaxMultipartMemory = 8 << 20 // 8 MiB
router.POST("/upload", func(c *gin.Context) {
// Multipart form
form, _ := c.MultipartForm()
files := form.File["upload[]"] // 注意这里名字不要对不上了
for _, file := range files {
log.Println(file.Filename)
// 上传文件至指定目录
c.SaveUploadedFile(file, "./"+file.Filename)
}
c.String(http.StatusOK, fmt.Sprintf("%d files uploaded!", len(files)))
})
router.Run(":8080")
}
文件下载
直接响应一个路径下的文件
c.File("uploads/12.png")
有些响应，比如图片，浏览器就会显示这个图片，而不是下载，所以我们需要使浏览器唤起下载行为
c.Header("Content-Type", "application/octet-stream") // 表示是文件流，唤起浏览器下载，一般设置了这个，就要设置文件名
c.Header("Content-Disposition", "attachment; filename="+"牛逼.png") // 用来指定下载下来的文件名
c.Header("Content-Transfer-Encoding", "binary") // 表示传输过程中的编码形式，乱码问题可能就是因为它
c.File("uploads/12.png")CopyErrorOK!
注意，文件下载浏览器可能会有缓存，这个要注意一下
解决办法就是加查询参数
前后端模式下的文件下载
如果是前后端模式下，后端就只需要响应一个文件数据
文件名和其他信息就写在请求头中
c.Header("fileName", "xxx.png")
c.Header("msg", "文件下载成功")
c.File("uploads/12.png")CopyErrorOK!
前端写法
略
