学习gin框架知识的小注意点

news2024/11/15 21:43:34

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使用起来还是非常方便的,就是配置麻烦了一点(只是亿点点…)

image-20240125172606561

validator 提供了许多内置的验证规则,如 requiredminmaxemailurl 等,同时也支持使用正则表达式、自定义函数等进行验证。使用 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
}

使用的时候举例子:

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": errs.Translate(trans),
       })
       return
    }

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

image-20240125205830430

image-20240125205840912

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

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

单调性的应用

1单调性 应用场景&#xff1a;常应用于双指针的进一步优化问题中含义&#xff1a;针对指针 i 1 > i i1>i i1>i一定有 j 1 > j j1>j j1>j或者 j 1 < j j1<j j1<j这样我们就可以利用该性质对算法进行进一步优化&#xff0c;避免一些不必要的遍历…

基于卡尔曼滤波的平面轨迹优化

文章目录 概要卡尔曼滤波代码主函数代码CMakeLists.txt概要 在进行目标跟踪时,算法实时测量得到的目标平面位置,是具有误差的,连续观测,所形成的轨迹如下图所示,需要对其进行噪声滤除。这篇博客将使用卡尔曼滤波,对轨迹进行优化。 优化的结果为黄色线。 卡尔曼滤波代码…

微信小程序元素/文字在横向和纵向实现居中对齐、两端对齐、左右对齐、上下对齐

元素对齐往往是新学者的一大困惑点&#xff0c;在此总结常用的各种元素和文字对齐方式以供参考&#xff1a; 初始显示 .wxml <view style"width: 100%;height: 500rpx; background-color: lightgray;"><view style"width: 200rpx;height:100rpx;bac…

STM32CubeMX教程29 USB_HOST - 使用FatFs文件系统读写U盘

目录 1、准备材料 2、实验目标 3、USB概述 3.1、USB协议 3.2、USB设备 3.3、USB接口 3.4、硬件原理 4、实验流程 4.0、前提知识 4.1、CubeMX相关配置 4.1.0、工程基本配置 4.1.1、时钟树配置 4.1.2、外设参数配置 4.1.3、外设中断配置 4.2、生成代码 4.2.0、配…

C++ day2 类 访问权限

1> 思维导图 2> 自己封装一个矩形类(Rect)&#xff0c;拥有私有属性:宽度(width)、高度(height)&#xff0c; 定义公有成员函数: 初始化函数:void init(int w, int h) 更改宽度的函数:set_w(int w) 更改高度的函数:set_h(int h) 输出该矩形的周长和面积函数:void s…

数据权限方案设计(后端)

有些BO模型放在bo包下用来装一些SQL语句查询返回&#xff0c;用于在Service层中进行处理业务逻辑,不会出现在Controller接口层的包装中。在持久层的基础组件中&#xff0c;我司业务种用的是Mysql5.7版本。在前后端开发使用的是分离技术&#xff0c;即前端使用流行的VUEElement-…

RISC-V常用汇编指令

RISC-V寄存器表&#xff1a; RISC-V和常用的x86汇编语言存在许多的不同之处&#xff0c;下面将列出其中部分指令作用&#xff1a; 指令语法描述addiaddi rd,rs1,imm将寄存器rs1的值与立即数imm相加并存入寄存器rdldld t0, 0(t1)将t1的值加上0,将这个值作为地址&#xff0c;取…

6家券商综合评级上升,12月券商App终端业务体验评测报告发布

随着移动金融服务的盛行&#xff0c;手机 App 炒股成为广大股民普遍的选择。股市行情变幻莫测&#xff0c;行情推送速度会影响到投资者的交易决策&#xff0c;委托下单与撤单等关键操作环节的响应性能又会极大影响投资者的收益。由此&#xff0c;行情数据的推送实时性和交易的快…

小程序系列--14.小程序分包

一、基础概念 1. 什么是分包 分包指的是把一个完整的小程序项目&#xff0c;按照需求划分为不同的子包&#xff0c;在构建时打包成不同的分包&#xff0c;用户在使用时按需进行加载。 2. 分包的好处 3. 分包前项目的构成 4. 分包后项目的构成 5. 分包的加载规则 6. 分包的…

vue3预览pdf文件的几种方法

vue3预览pdf集中方法 方法一&#xff1a; iframe&#xff1a;这种方法显示有点丑 <iframesrc"E:\\1.pdf"frameborder"0"style"width: 80%; height: 100vh; margin: auto; display: block"></iframe>方法二&#xff1a; 展示效果&…

Objective-C方法的声明实现及调用

1.无参数的方法 1)声明 a.位置&#xff1a;在interface括弧的外面 b.语法&#xff1a; - (返回值类型)方法名称; interface Person : NSObject -(void) run; end 2)实现 a.位置&#xff1a;在implementation中实现 b.语法&#xff1a;加大括弧将方法实现的代码写在大括孤之中 …

浅出深入-机器学习

文章目录 一、K近邻算法1.1 先画一个散列图1.2 使用K最近算法建模拟合数据1.3 进行预测1.4 K最近邻算法处理多元分类问题1.5 K最近邻算法用于回归分析1.6 K最近邻算法项目实战-酒的分类1.6.1 对数据进行分析1.6.2 生成训练数据集和测试数据集1.6.3 使用K最近邻算法对数据进行建…

抽象工厂模式-C#实现

该实例基于WPF实现&#xff0c;直接上代码&#xff0c;下面为三层架构的代码。 一 Model using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks;namespace 设计模式练习.Model.抽象工厂模式 {public abstrac…

学习笔记之 机器学习之预测雾霾

文章目录 Encoder-DecoderSeq2Seq (序列到序列&#xff09; Encoder-Decoder 基础的Encoder-Decoder是存在很多弊端的&#xff0c;最大的问题就是信息丢失。Encoder将输入编码为固定大小的向量的过程实际上是一个“信息有损的压缩过程”&#xff0c;如果信息量越大&#xff0c;…

Rollup:打包 TypeScript - React 组件库

调用浏览器摄像头拍照组件 1、前提1、安装依赖2、添加 rollup.config.js 配置3、修改 package.json3.1 添加打包命令3.2 添加组件入口3.3 添加组件声明入口3.4 浏览器支持 1、前提 1.1 通过 create-react-app take-photo --template 创建前端应用 1.2 添加组件 TakePhoto (拍照…

华为三层交换机之基本操作

Telnet简介 Telnet是一个应用层协议,可以在Internet上或局域网上使用。它提供了基于文本的远程终端接口&#xff0c;允许用户在本地计算机上登录到远程计算机&#xff0c;然后像在本地计算机上一样使用远程计算机的资源。Telnet客户端和服务器之间的通信是通过Telnet协议进行的…

<蓝桥杯软件赛>零基础备赛20周--第17周--并查集

报名明年4月蓝桥杯软件赛的同学们&#xff0c;如果你是大一零基础&#xff0c;目前懵懂中&#xff0c;不知该怎么办&#xff0c;可以看看本博客系列&#xff1a;备赛20周合集 20周的完整安排请点击&#xff1a;20周计划 每周发1个博客&#xff0c;共20周。 在QQ群上交流答疑&am…

JavaSE基础学习

一、编程入门 二、Java语言概述 三、Java基本语法 四、程序流程控制 五、数组 六、面向对象(上) 数组工具类的封装: 七、面向对象(中) 八、面向对象(下) 九、异常处理 十、多线程 十一、常用类 十二、枚举类与注解 十三、集合 十四、泛型 十五、IO流 十六、网络编程 十七、反射…

【论文阅读】Grasp-Anything: Large-scale Grasp Dataset from Foundation Models

文章目录 Grasp-Anything: Large-scale Grasp Dataset from Foundation Models针对痛点和贡献摘要和结论引言相关工作Grasp-Anything 数据集实验 - 零镜头抓取检测实验 - 机器人评估总结 Grasp-Anything: Large-scale Grasp Dataset from Foundation Models Project page&…

【重点】【DP】123.买卖股票的最佳时机III

题目 法1&#xff1a;单次遍历&#xff0c;Best! class Solution {public int maxProfit(int[] prices) {int f1 -prices[0], f2 0, f3 -prices[0], f4 0;for (int i 1; i < prices.length; i) {f1 Math.max(f1, -prices[i]);f2 Math.max(f2, f1 prices[i]);f3 Ma…