学习gin框架知识的注意点

这几天重新学习了一遍gin框架：收获颇多

Gin框架的初始化

有些项目中 初始化gin框架写的是： r := gin.New()

r.Use(logger.GinLogger(), logger.GinRecovery(true))

而不是r := gin.Default()

为什么呢？

点击进入Default源码发现其实他也是new+两个中间件，（Logger，Recovery）

default源码
func Default() *Engine {
    debugPrintWARNINGDefault()
    engine := New()
     engine.Use(Logger(), Recovery())
    return engine
}

但是中间件已经固定了，对于一些精细化开发来说换成new+自定义中间件则更有性价比；

自定义的：
	r := gin.New()
	r.Use(logger.GinLogger(), logger.GinRecovery(true)) //中间件
更精细化，这两个区别是一个用的是基础log，一个用的是gin框架特殊处理的log

项目结构

后端处理路线通常是先写router层：各种各样的路由信息，

再写controller层：

1 获取参数和参数校验 ：定义参数结构，接收参数并存放
2 业务处理 ：写到逻辑层
3 返回响应 ：可以写中间件方便多次处理

然后logic层：（举登录的例子）

1.一系列登录逻辑判断：
用户是否存在         sql写在dao层，供logic层调用
账号密码是否符合格式  可以不使用sql语句的，直接逻辑判断
判断完成生成对应uid   调用一系列外置方法
对数据进行加密        调用一系列外置方法
保存进数据库          调用dao层sql方法

然后是dao层，写各种数据库操作封装成的方法以供调用

在我看来，controller层最大，logic以实现controller层的业务而出现，dao层最小，以实现logic层中的数据库操作为己任；

所以每次写小需求，先写router层，再写controller层，再写logic层，然后是dao层

这样理解起来比盲目学习要好很多；

Query和Param的区别

虽然已经学了不知道多少遍了，但这两个老是弄反，再写一遍吧

Query:

  • Query 用于获取 URL 查询参数。它从 URL 中解析参数，并返回一个字符串值。

如：

name := c.Query("name")

https://example.com/search?query=golang&page=1&limit=10

Param:

  • Param 用于获取路径参数。路径参数是包含在 URL 中的参数，例如 /users/:id 中的 :id 就是路径参数。

如：

https://example.com/users/123
userID := c.Param("id") // Returns "123"

数据校验

而shouldbindjson是什么呢？

ShouldBindJSON:

  • ShouldBindJSON 用于将 JSON 数据绑定到结构体。它从请求的 JSON 主体中提取数据，并将其解析到指定的结构体中。
var user User
if err := c.ShouldBindJSON(&user); err == nil {
    // 处理 user 结构体中的数据
}

将 HTTP 请求体中的 JSON 数据绑定到变量 user。

注意点：ShouldBindJSON只能识别是不是json格式，并不能保证数据是否完全符合结构体格式，例如

image-20240125171059861

image-20240125171014484image-20240125171205274

这样写都会直接通过，

只有

image-20240125171143727

会报错，所以需要手动去对数据进行业务判断（数据校验），例如数据不为空，数据类型不对，数据不符合格式等等，因此就引入了第三方的validator库进行爽歪歪！(^ ▽ ^)，ps:之后说这个库

image-20240125172035094

binding就是gin框架参数校验的tag：required就是不能为空，不然直接结束

常用tag

  1. form:
    • form:"fieldName" 表示该字段的值将从 HTTP 请求的表单数据中获取，其中 "fieldName" 是表单字段的名称。
  2. query:
    • query:"paramName" 表示该字段的值将从 URL 查询参数中获取，其中 "paramName" 是查询参数的名称。
  3. json:
    • json:"fieldName" 表示该字段的值将从 JSON 数据中获取，其中 "fieldName" 是 JSON 对象中的字段名。
  4. uri:
    • uri:"paramName" 表示该字段的值将从 URL 的路径参数中获取，其中 "paramName" 是路径参数的名称。
  5. binding:
    • binding:"required" 表示该字段是必需的，如果请求中缺少该字段，将返回错误。
  6. xml:
    • xml:"fieldName" 表示该字段的值将从 XML 数据中获取，其中 "fieldName" 是 XML 对象中的字段名。
  7. header:
    • header:"Header-Name" 表示该字段的值将从 HTTP 请求头中获取，其中 "Header-Name" 是请求头的名称。
  8. time:
    • time_format:"2006-01-02" 表示该时间字段的格式，用于将字符串转换为时间类型。

这些标签值用于告诉 Gin 框架在处理请求时如何从不同的数据源（如表单、查询参数、JSON 数据等）中提取和绑定数据。在使用 Gin 进行参数绑定时，可以根据请求中的数据类型和来源选择适当的标签。

validator库

接下来是重头戏validator库的说明，validator使用起来还是非常方便的，就是配置麻烦了一点（只是亿点点…）

image-20240125172606561

validator 提供了许多内置的验证规则，如 required、min、max、email、url 等，同时也支持使用正则表达式、自定义函数等进行验证。使用 validator 可以有效地提高应用程序的数据完整性和安全性。

而当不符合validator的tag规则时，返回的错误也是由validator库内置的，比如image-20240125172900409

我们需要将其改成中文并符合我们自己的代码习惯（这种配置配一次就行了，以后项目框架基本不会变，validator的代码也几乎不需要变化）；

例如说自动翻译成中文，将特定字段格式转为json供前端使用，去掉结构体名称，处理复杂逻辑时候的结构体转换，咳咳，想要完美道阻且艰，错误信息完美到这里已经差不多了（还有很多优化空间阿伟！）

然后是固定代码格式：（包含了初始化翻译器，可以自动翻译中文，把结构体字段转为json，去掉包名，给用户看）

最后还是只有三个功能，可以直接使用哦~~

package controller

import (
    "fmt"
    "reflect"
    "strings"

    "github.com/gin-gonic/gin/binding"
    "github.com/go-playground/locales/en"
    "github.com/go-playground/locales/zh"
    ut "github.com/go-playground/universal-translator"
    "github.com/go-playground/validator/v10"
    enTranslations "github.com/go-playground/validator/v10/translations/en"
    zhTranslations "github.com/go-playground/validator/v10/translations/zh"
)

// 这种初始化代码，知道意思就行，因为每次的项目这个都是提前写好的；
// 定义一个全局翻译器T
var trans ut.Translator

// InitTrans 初始化翻译器
func InitTrans(locale string) (err error) {
    // 修改gin框架中的Validator引擎属性，实现自定制
    if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
       // 注册一个获取json tag的自定义方法
       v.RegisterTagNameFunc(func(fld reflect.StructField) string {
          name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
          if name == "-" {
             return ""
          }
          return name
       })

       zhT := zh.New() // 中文翻译器
       enT := en.New() // 英文翻译器

       // 第一个参数是备用（fallback）的语言环境
       // 后面的参数是应该支持的语言环境（支持多个）
       // uni := ut.New(zhT, zhT) 也是可以的
       uni := ut.New(enT, zhT, enT)

       // locale 通常取决于 http 请求头的 'Accept-Language'
       var ok bool
       // 也可以使用 uni.FindTranslator(...) 传入多个locale进行查找
       trans, ok = uni.GetTranslator(locale)
       if !ok {
          return fmt.Errorf("uni.GetTranslator(%s) failed", locale)
       }

       // 注册翻译器
       switch locale {
       case "en":
          err = enTranslations.RegisterDefaultTranslations(v, trans)
       case "zh":
          err = zhTranslations.RegisterDefaultTranslations(v, trans)
       default:
          err = zhTranslations.RegisterDefaultTranslations(v, trans)
       }
       return
    }
    return
}


// removeTopStruct 去除提示信息中的结构体名称,使用时直接包裹就行了
func removeTopStruct(field map[string]string) map[string]string {
	res := map[string]string{}
	for field, err := range field {
		res[field[strings.Index(field, ".")+1:]] = err

	}
	return res
}

使用的时候举例子：

controller/user的post登陆请求

func SignUpHandler(c *gin.Context) {
    //1 获取参数和参数校验
    p := new(models.ParamSignUp) //声明参数p是接收账号密码时的类型
    err := c.ShouldBindJSON(&p)  //获取参数传给p
    if err != nil {
       zap.L().Error("SignUp with invalid param", zap.Error(err)) //用日志输出
       //判断err是不是validator.ValidationErrors 类型,不是的话就不翻译了
       errs, ok := err.(validator.ValidationErrors)
       if !ok { //不是validator类型,正常响应
          c.JSON(http.StatusOK, gin.H{
             "msg": err.Error(),
          })
       }
       //是validator类型的,进行翻译操作
       c.JSON(http.StatusOK, gin.H{
           "msg": removeTopStruct(errs.Translate(trans)),
       })
       return
    }

只用判断是不是validator类型，是的话返回err.Translate(trans)就好了

image-20240125205830430

image-20240126103722304

至于为什么不做其他的处理直到完美，首先代码复杂了，其次对效率也有不小的影响，有这三步已经差不多了；

对状态码的定义

为什么要引入自定义状态码呢？首先我们看自己写的响应

image-20240126104153447

我们会发现很大一部分代码都用来表示重复的响应代码段了，有什么统一格式的写法么？

当然有！蹡蹡

我们可以定义成这种格式，为什么呢，因为统一格式有利于前端进行工作，包括看错误提示信息和接受数据都方便一些

image-20240126104112812

把经常会用到的响应单独拉出来写进一个文件，例如：

package controller

type MyCode int64 //自定义MyCode类型

const ( //使用 const 关键字定义了一组错误码，每个错误码都是 MyCode 类型的常量。
    CodeSuccess         MyCode = 1000
    CodeInvalidParams   MyCode = 1001
    CodeUserExist       MyCode = 1002
    CodeUserNotExist    MyCode = 1003
    CodeInvalidPassword MyCode = 1004
    CodeServerBusy      MyCode = 1005

    CodeInvalidToken      MyCode = 1006
    CodeInvalidAuthFormat MyCode = 1007
    CodeNotLogin          MyCode = 1008
)

var msgFlags = map[MyCode]string{ //map类型,映射错误码和信息
    CodeSuccess:         "success",
    CodeInvalidParams:   "请求参数错误",
    CodeUserExist:       "用户名重复",
    CodeUserNotExist:    "用户不存在",
    CodeInvalidPassword: "用户名或密码错误",
    CodeServerBusy:      "服务繁忙",

    CodeInvalidToken:      "无效的Token",
    CodeInvalidAuthFormat: "认证格式有误",
    CodeNotLogin:          "未登录",
}

func (c MyCode) Msg() string { //把上边两个连起来，传入code，传出code对应的信息
    //当调用 Msg 方法时，会查找 msgFlags 中是否存在对应的错误信息，
    //如果存在则返回，否则返回默认的错误信息，例如 CodeServerBusy 对应的信息。
    msg, ok := msgFlags[c]
    if ok {
       return msg
    }
    return msgFlags[CodeServerBusy]
}


再写几个方法把这些响应给包装起来：
例如
type ResponseData struct {
	Code    MyCode      `json:"code"` //把错误码都拉过来
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}


func ResponseError(c *gin.Context, code MyCode) { //错误的，传入状态码，直接用写好的错误信息
	rd := &ResponseData{
		Code:    code,
		Message: code.Msg(),
		Data:    nil,
	}
	c.JSON(http.StatusOK, rd)
}

在代码中调用时前后比较

if err != nil {
    zap.L().Error("SignUp with invalid param", zap.Error(err)) //用日志输出
    //判断err是不是validator.ValidationErrors 类型,不是的话就不翻译了
    errs, ok := err.(validator.ValidationErrors)
    if !ok { //不是validator类型,正常响应
    //这里原本是写响应状态码和msg，但现在就可以直接调用定义好的了
       ResponseError(c, CodeUserExist)
    }

然后是登录

用户认证

cookie和session方式

我们平时访问网站，当不登录时，权限是非常低的，因为http是无状态的协议

image-20240126144148161

image-20240126144403112

需要每次访问接口时将cookie和session也访问一下是否带cookie的值

问题：

image-20240126144530440

所以token也就应运而生了

token方式

image-20240126144818406image-20240126144856271

看这个图的话会觉得和cookie，session方式基本差不多

其实差距还是很大的

image-20240126145056314

而对应的实践就是JWT了

image-20240126145925563

  • 签名

    image-20240126150526364

image-20240126150951510

三部分组成：

  1. Header（头部）:

    • 头部通常由两部分组成：令牌的类型（JWT）和所使用的签名算法，例如 HMAC SHA256 或 RSA。
    • 头部是Base64Url编码的JSON字符串。

    示例：

     code{
  "alg": "HS256",
  "typ": "JWT"
}

  2. Payload（负载）:

    • 负载包含有关声明（claims）的信息，可以包括用户的身份信息、权限等。
    • 负载也是Base64Url编码的JSON字符串。

    示例：

     code{
  "sub": "1234567890",
  "name": "John Doe",
  "iat": 1516239022
}

  3. Signature（签名）:

    • 签名是通过将编码后的头部、编码后的负载和秘钥进行签名生成的。
    • 签名用于验证消息的完整性和认证发送方。

    示例：

     codeHMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

这三部分通过点号连接在一起，形成完整的JWT，如下所示：

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiAiMTIzNDU2Nzg5MCIsICJuYW1lIjogIkpvaG4gRG9lIiwgI

需要知道这串jwt并没有进行过加密，若需要保证数据安全性，可以用加密算法处理

总结一下这几天学习的心得：

其实ginweb并不难，难的是没有web基础就进入学习，刚学时，并不清楚日志，配置文件，数据验证等等web中要用到的各种库，其实把理论学好分开来看，这些初始化以及只需后期调用的代码，是可以一直重复利用的，只要是web项目，那么只用一套完整的初始化流程代码，就可以只用专注于写接口就行了，只需要会改配置，知道什么意思就行，而接口书写上边已经说过了，只有router层，controller层，logic层，然后是dao层，甚至很多接口还是高度重复的，。

所以才有基础web开发最简单这种说法，现在我也越发的认同了~

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/351628.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

如何在有或没有备份的 iPhone 上检索已删除的短信

如何在有或没有备份的 iPhone 上检索已删除的短信

iPhone 清理垃圾短信时不小心删除了一些重要短信？想知道如何找回 iPhone 上已删除的短信吗？如果您已将设备备份到 iCloud 或 iTunes，则可以从备份恢复 iPhone 上的短信。如果没有备份，您可以尝试第三方iPhone短信恢复程序来恢复它…
阅读更多...
记一个信息泄露到RCE

记一个信息泄露到RCE

打点 开局一个登录框 信息收集 发现了一处接口泄露了部分信息 不过只有支付宝密钥的信息无法扩大危害，此时尝试寻找了一下其他同类型系统同样的接口，查看一下是否泄露的信息相同 因为如果相同就说明是静态的，没有价值横向收集 此时访问其他…
阅读更多...
RabbitMQ概念

RabbitMQ概念

一 、RabbitMQ概念 1 架构图 2 相关概念 Publisher - ⽣产者：发布消息到RabbitMQ中的Exchange Consumer - 消费者：监听RabbitMQ中的Queue中的消息 Broker：接收和分发消息的应用，RabbitMQ Server就是 Message Broker&#xf…
阅读更多...
力扣日记1.27-【回溯算法篇】131. 分割回文串

力扣日记1.27-【回溯算法篇】131. 分割回文串

力扣日记：【回溯算法篇】131. 分割回文串 日期：2023.1.27 参考：代码随想录、力扣 131. 分割回文串 题目描述 难度：中等 给你一个字符串 s，请你将 s 分割成一些子串，使每个子串都是 回文串 。返回 s 所有可…
阅读更多...
Android App开发-简单控件（2）——视图基础

Android App开发-简单控件（2）——视图基础

2.2　视图基础 本节介绍视图的几种基本概念及其用法，包括如何设置视图的宽度和高度，如何设置视图的外部间距和内部间距，如何设置视图的外部对齐方式和内部对齐方式等等。 2.2.1　设置视图的宽高 手机屏幕是块长方形区域，较短的那…
阅读更多...
Unknown encoder ‘libmp3lame

Unknown encoder ‘libmp3lame

环境： macos m1 ， python3.10.x 背景 做视频切片， 使用moviepy 中VideoFileClip进行截取视频。 报错： Unknown encoder libmp3lameThe audio export failed because FFMPEG didnt find the specified codec for audio encoding …
阅读更多...
ppt背景图片怎么设置？让你的演示更加出彩！

ppt背景图片怎么设置？让你的演示更加出彩！

PowerPoint是一款广泛应用于演示文稿制作的软件，而背景图片是演示文稿中不可或缺的一部分。一个好的背景图片能够提升演示文稿的整体效果，使观众更加关注你的演示内容。可是ppt背景图片怎么设置呢？本文将介绍ppt背景图片设置的三个方法&#…
阅读更多...
浪花 - 添加队伍业务开发

浪花 - 添加队伍业务开发

一、接口设计 1. 请求参数：封装添加队伍参数 TeamAddRequest package com.example.usercenter.model.request;import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.ann…
阅读更多...
STM32 freertos 使用软件模拟串口uart

STM32 freertos 使用软件模拟串口uart

如题，为什么要这样做？ 最近做的一个项目上使用了74HC595作为指示灯板使用； 这个灯板与驱动板是通过排线连接，排线约25cm长； 在实验室测试一切正常，发到客户手上使用就出现了某个LED跳动情况；…
阅读更多...
Spring Boot 中 Service 层依赖注入问题

Spring Boot 中 Service 层依赖注入问题

目录 问题描述 产生错误 问题原因 解决方法 手动注入方法 1、使用工具集 hutool，引入 Maven 依赖 2、编写 SpringUtil 工具类 问题描述 Controller 层方法为 static 静态，引入 Service 层时使用 Autowired 注解自动装配，Controller层方…
阅读更多...
2017年认证杯SPSSPRO杯数学建模D题(第二阶段)教室的合理设计全过程文档及程序

2017年认证杯SPSSPRO杯数学建模D题(第二阶段)教室的合理设计全过程文档及程序

2017年认证杯SPSSPRO杯数学建模 D题 教室的合理设计 原题再现： 某培训机构租用了一块如图（见附件）所示的场地，由于该机构开设了多种门类的课程，所以需要将这块场地通过加入一些隔墙来分割为多个独立的教室和活动区。…
阅读更多...
手把手教学:AD09制作BOM及小技巧

手把手教学:AD09制作BOM及小技巧

BOM（Bill of Material）物料清单，是以数据格式来描述产品结构的文件，即生产一件产品所需的子零件及其产品中零件数量的完全组合。这里生成BOM表用作对你制作的pcb板进行成本预估和制作生产资料文件。同时也是样品制作时&#xff0c…
阅读更多...
pytest参数化

pytest参数化

一、pytest.mark.parametrize介绍 pytest.mark.parametrize(argnames, argvalues, indirectFalse, idsNone)参数说明： argnames: 一个或多个参数名，用逗号分隔的字符串，如"arg1,arg2,arg3"，参数名与用例入参数一致。 a…
阅读更多...
TensorFlow2实战-系列教程2：神经网络分类任务

TensorFlow2实战-系列教程2：神经网络分类任务

🧡💛💚TensorFlow2实战-系列教程 总目录 有任何问题欢迎在下面留言 本篇文章的代码运行界面均在Jupyter Notebook中进行 本篇文章配套的代码资源已经上传 1、Mnist数据集 下载mnist数据集： %matplotlib inline from pathlib imp…
阅读更多...
shell常用命令，参数传递，函数，挂载磁盘

shell常用命令，参数传递，函数，挂载磁盘

1、ls 功能：显示文件和目录的信息ls　以默认方式显示当前目录文件列表 ls -a 显示所有文件包括隐藏文件 ls -l 显示文件属性，包括大小，日期，符号连接，是否可读写及是否可执行 ls -lh 显示文件的大小，以…
阅读更多...
BOSS 直聘：日增10亿数据的历史库，如何通过OceanBase节省70%存储成本？

BOSS 直聘：日增10亿数据的历史库，如何通过OceanBase节省70%存储成本？

BOSS 直聘是在全球范围内首创互联网“直聘”模式的在线招聘产品，目前已经成为了中国最大的招聘平台。本文谈到的 BOSS 直聘的业务场景主要是通过数据库对招聘过程中的聊天记录信息进行存储，数据量极大，且每天都有 5 亿到 10 亿的增量数据。和…
阅读更多...
Linux入门攻坚——14、实战软件安装-搭建Python3.8环境-2

Linux入门攻坚——14、实战软件安装-搭建Python3.8环境-2

上一篇解决了openssl和pip问题，这一篇来解决sqlite问题 创建app时出现错误，模块_sqlite3找不到，查询sqlite相关的包： 在python2.6的lib-dynload路径下，有_sqlite3.so，这个应该就是Python需要的sqlite模块&a…
阅读更多...
Redis 实际项目中的整合,记录各种用法

Redis 实际项目中的整合,记录各种用法

Redis缓存餐厅数据 我们来看主要的流程 很简单,就是在数据库和接口之间加了一层缓冲,在redis之前其实还可以加其他的缓存 例如 nginx的缓存 接下来,就是结合我的业务,来做缓存 我这里的业务逻辑是,按了分类的按钮,分别以不同的 分类为一组缓存数据 所以,这里的缓存粒度是分类…
阅读更多...
一个人永远无法赚到认知以外的钱

一个人永远无法赚到认知以外的钱

做交付、做产品，从来都不是一件容易的事情。在营销和服务的过程中，我充分见证了人生百态。 前一段时间，小灰创建了一个自媒体陪伴群，群里邀请了各个领域的自媒体大佬，每周都会在群里进行分享，大家的学习气氛…
阅读更多...
推荐家庭关系三姑六婆计算器微信小程序源码

推荐家庭关系三姑六婆计算器微信小程序源码

亲戚关系计算器微信小程序源码是一款为避免遇到亲戚却不知道该怎么称呼时遇到的尴尬情况而开发的，由于社会节奏的快速发展，现在的关系不像以前一样经常联系和维护，导致了有些自己家的一些亲戚也疏远了很多。 演示地 址 ： runrunco…
阅读更多...
最新文章

Copyright @ 2022~2023