gin快速入门

2024-08-23 19:04
文章标签 入门 快速 gin

本文主要是介绍gin快速入门,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

gin

项目地址
晓智科技晓智科技
晓智文档晓智文档
文档源码文档源码

快速体验

func HandlerPong(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "pong",})
}func main() {r := gin.Default()r.GET("/ping", HandlerPong)_ = r.Run(":8080")
}

restful 风格

  • restful 与技术无关,代表的是一种软件架构风格,REST 是 Representational State Transfer 的简称,中文翻译为“表征状态转移”或“表现层状态转化”。
  • RESTFUL 特点包括:
  1. 每一个 URI 代表 1 种资源;
  2. 客户端使用 GET、POST、PUT、DELETE4 个表示操作方式的动词对服务端资源进行操作:GET 用来获取资源,POST 用来新建资源(也可以用于更新资源),PUT 用来更新资源,DELETE 用来删除资源
  3. 通过操作资源的表现形式来操作资源;
  4. 资源的表现形式是 XML 或者 HTML;
  5. 客户端与服务端之间的交互在请求之间是无状态的,从客户端到服务端的每个请求都必须包含理解请求所必需的信息。
func HandlerGet(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "get",})
}func HandlerPost(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "post",})
}func HandlerPut(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "put",})
}func HandlerDelete(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "delete",})
}func main() {r := gin.Default()r.GET("/get", HandlerGet)r.POST("/post", HandlerPost)r.PUT("/put", HandlerPut)r.DELETE("/delete", HandlerDelete)_ = r.Run(":8080")
}

路由分组

  • 在我们实际的开发应用中我们希望能个各个功能模块的路由进行分组,同一个模块的不同路由带有同样的前缀
  • 作用:首先是路由更加的清晰 并且我们在针对某一组路由进行中间件权限校验的时候也比较的方便。
func handleLogin(c *gin.Context) {}func handleSubmit(c *gin.Context) {}func main() {r := gin.Default()v1 := r.Group("/api/v1"){v1.POST("/login", handleLogin)v1.POST("/submit", handleSubmit)}v2 := r.Group("/api/v2"){v2.POST("/login", handleLogin)v2.POST("/submit", handleSubmit)}
}

动态参数获取

  • 在 Gin 框架中,可以使用 c.Param(“paramKey”)来获取动态参数。这里的 paramKey 是你在路由定义中定义的参数名称。
func handleGetInfo(c *gin.Context) {id := c.Param("id")action := c.Param("action")c.JSON(http.StatusOK, gin.H{"id":     id,"action": action,})
}func main() {r := gin.Default()r.GET("/info/:id/:action", handleGetInfo)_ = r.Run(":8080")
}

get 参数获取

  • 获取 GET 参数可以使用 c.Query 函数。这个函数接受一个参数名作为字符串,并返回匹配该参数名的第一个值。如果参数不存在,则返回空字符串。
func handlerGetParams(c *gin.Context) {name := c.DefaultQuery("name", "tom")age := c.DefaultQuery("age", "18")c.JSON(http.StatusOK, gin.H{"name": name,"age":  age,})
}func main() {r := gin.Default()r.GET("/get-params", handlerGetParams)_ = r.Run(":8080")
}

绑定结构体数据

  • 我们可以使用 ShouldBind 系列方法来绑定请求中的数据到 Go 的结构体。这些方法支持 JSON,XML,form 等数据格式。
type Person struct {Id   int    `uri:"id" binding:"required" json:"id"`Name string `uri:"name" binding:"required" json:"name"`
}func handleParams(c *gin.Context) {var person Personif err := c.ShouldBindUri(&person); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, person)
}func main() {r := gin.Default()r.GET("/ping", handleParams)_ = r.Run(":8080")
}

post 参数获取 form-data 数据

  • 获取 POST 参数可以通过 Context.PostForm()方法来实现。这个方法可以获取到 application/x-www-form-urlencoded 类型的数据。
func handlePostParams(c *gin.Context) {name := c.PostForm("name")age := c.PostForm("age")c.JSON(http.StatusOK, gin.H{"name": name,"age":  age,})
}func main() {r := gin.Default()r.POST("/post-params", handlePostParams)_ = r.Run(":8080")
}

post 参数获取 json

  • 要获取 POST JSON 数据,你可以使用 Context.BindJSON()方法。
type User struct {Name string `json:"name"`Age  int    `json:"age"`
}func handlePostJson(c *gin.Context) {var user Userif err := c.ShouldBindJSON(&user); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusCreated, user)
}func main() {r := gin.Default()r.POST("/post-json", handlePostJson)_ = r.Run(":8080")
}

返回 protobuf 数据

  • 你需要做的是先将 Protobuf 数据序列化成二进制格式,然后设置正确的响应头,最后将二进制数据写入到 Response 中
//protobuf
syntax = "proto3";option go_package = ".;proto";message Teacher{string name = 1;repeated  string course = 2;
}
//---------------------------------------
func handleProtobuf(c *gin.Context) {teacher := proto.Teacher{Name:   "tom",Course: []string{"python", "java", "go"},}c.ProtoBuf(http.StatusOK, &teacher)
}func main() {r := gin.Default()r.GET("/protobuf", handleProtobuf)_ = r.Run(":8080")
}

from 表单验证 from-data

  • 若要将请求体绑定到结构体中,需要使用模型绑定,支持 JSON、XML、YAML 和标准表单的绑定,设置时需要在绑定的字段上设置 tag,其只要有两套绑定方法
  • Must bind
  1. 方法: Bind 、BindJSON、BindXML、BindQuery、BindYAML
  2. 行为:这些方法底层使用 MustBindWith 方法,如果存在绑定错误,请求将被终止,响应代码会被设置成 400
  • Should bind
  1. 方法: ShouldBind、ShouldBindJSON、ShouldBindXML、ShouldBindQuery、ShouldBindYAML
  2. 行为:底层使用 ShouldBindWith 方法,如果存在绑定错误,则返回 go 语言的错误形式,开发人员可以处理错误,请求不会被终
type LoginForm struct {Name     string `form:"name" binding:"required,min=2,max=10"`Password string `form:"password" binding:"required,min=8,max=20"`
}func handleLogin(c *gin.Context) {var loginForm LoginFormif err := c.ShouldBind(&loginForm); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, &loginForm)
}func main() {r := gin.Default()r.POST("/login", handleLogin)_ = r.Run(":8080")
}

from 表单验证 json

type User struct {Name     string `json:"name" binding:"required,min=2,max=20"`Password string `json:"password" binding:"required,min=8,max=20"`
}func handleLogin(c *gin.Context) {var user Userif err := c.ShouldBindJSON(&user); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, &user)
}func main() {r := gin.Default()r.POST("/login", handleLogin)_ = r.Run(":8080")
}

中间件 middleware

  • 中间件(middleware)是一种独立的组件或模块,通常是一个函数或一组函数,常被用于处理请求或事件的过程中
  • 中间件常用来实现一些通用的功能,如日志记录、权限校验、数据加工等
  • 中间件流程控制函数包括:
  1. c.Next(): 调用该函数会将控制权交给下一个中间件函数,如果没有下一个中间件函数,则将控制权交给处理请求的路由处理函数
  2. c.Abort(): 调用该函数会立即终止当前中间件函数的执行,并且不会再调用后续的中间件函数或路由处理函数
  3. c.AbortWithStatus(code int): 调用该函数会终止当前中间件函数的执行,并返回指定的 HTTP 状态码给客户端
  4. c.NextWithError(): 调用该函数会将控制权交给下一个中间件函数,同时传递一个错误给下一个中间件函数或路由处理函数
  5. c.IsAborted(): 该函数用于判断当前请求是否已经被终止,返回一个布尔值表示请求是否已经被终止

func handleUserInfo(c *gin.Context) {c.JSON(200, gin.H{"code": 200,"name": "tom",})
}func main() {r := gin.Default()v1 := r.Group("/api/v1").Use(middleware.Logger()){v1.GET("/info", handleUserInfo)}_ = r.Run(":8080")
}
//------------------------------------------------
// middlewarefunc Logger() gin.HandlerFunc {return func(c *gin.Context) {t := time.Now()c.Set("name", "tom")c.Next()end := time.Since(t)fmt.Println(end)}
}

优雅退出

  • 在 Web 开发中,一个应用程序可能因为多种原因需要关闭,比如接收到关闭信号、处理完所有的请求或者遇到不可恢复的错误。优雅的退出机制可以确保应用程序在关闭过程中,能够完成正在处理的任务,释放资源,并向客户端提供适当的响应,从而保证服务的高可用性和数据的完整性。
func handleExit(c *gin.Context) {c.JSON(200, gin.H{"code": 200,"name": "tom",})
}func main() {r := gin.Default()r.GET("/", handleExit)go func() {_ = r.Run(":8080")}()// 接收信号quit := make(chan os.Signal)signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)<-quitfmt.Println("服务关闭中....")
}

贵州晓智信息科技有限公司

这篇关于gin快速入门的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1100236

相关文章

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

电脑桌面文件删除了怎么找回来?别急,快速恢复攻略在此

在日常使用电脑的过程中,我们经常会遇到这样的情况:一不小心,桌面上的某个重要文件被删除了。这时,大多数人可能会感到惊慌失措,不知所措。 其实,不必过于担心,因为有很多方法可以帮助我们找回被删除的桌面文件。下面,就让我们一起来了解一下这些恢复桌面文件的方法吧。 一、使用撤销操作 如果我们刚刚删除了桌面上的文件,并且还没有进行其他操作,那么可以尝试使用撤销操作来恢复文件。在键盘上同时按下“C

数论入门整理(updating)

一、gcd lcm 基础中的基础,一般用来处理计算第一步什么的,分数化简之类。 LL gcd(LL a, LL b) { return b ? gcd(b, a % b) : a; } <pre name="code" class="cpp">LL lcm(LL a, LL b){LL c = gcd(a, b);return a / c * b;} 例题:

Java 创建图形用户界面(GUI)入门指南(Swing库 JFrame 类)概述

概述 基本概念 Java Swing 的架构 Java Swing 是一个为 Java 设计的 GUI 工具包,是 JAVA 基础类的一部分,基于 Java AWT 构建,提供了一系列轻量级、可定制的图形用户界面(GUI)组件。 与 AWT 相比,Swing 提供了许多比 AWT 更好的屏幕显示元素,更加灵活和可定制,具有更好的跨平台性能。 组件和容器 Java Swing 提供了许多

【IPV6从入门到起飞】5-1 IPV6+Home Assistant(搭建基本环境)

【IPV6从入门到起飞】5-1 IPV6+Home Assistant #搭建基本环境 1 背景2 docker下载 hass3 创建容器4 浏览器访问 hass5 手机APP远程访问hass6 更多玩法 1 背景 既然电脑可以IPV6入站,手机流量可以访问IPV6网络的服务,为什么不在电脑搭建Home Assistant(hass),来控制你的设备呢?@智能家居 @万物互联

poj 2104 and hdu 2665 划分树模板入门题

题意: 给一个数组n(1e5)个数,给一个范围(fr, to, k),求这个范围中第k大的数。 解析: 划分树入门。 bing神的模板。 坑爹的地方是把-l 看成了-1........ 一直re。 代码: poj 2104: #include <iostream>#include <cstdio>#include <cstdlib>#include <al

hdu 4565 推倒公式+矩阵快速幂

题意 求下式的值: Sn=⌈ (a+b√)n⌉%m S_n = \lceil\ (a + \sqrt{b}) ^ n \rceil\% m 其中: 0<a,m<215 0< a, m < 2^{15} 0<b,n<231 0 < b, n < 2^{31} (a−1)2<b<a2 (a-1)^2< b < a^2 解析 令: An=(a+b√)n A_n = (a +

MySQL-CRUD入门1

文章目录 认识配置文件client节点mysql节点mysqld节点 数据的添加(Create)添加一行数据添加多行数据两种添加数据的效率对比 数据的查询(Retrieve)全列查询指定列查询查询中带有表达式关于字面量关于as重命名 临时表引入distinct去重order by 排序关于NULL 认识配置文件 在我们的MySQL服务安装好了之后, 会有一个配置文件, 也就

v0.dev快速开发

探索v0.dev:次世代开发者之利器 今之技艺日新月异,开发者之工具亦随之进步不辍。v0.dev者,新兴之开发者利器也,迅速引起众多开发者之瞩目。本文将引汝探究v0.dev之基本功能与优势,助汝速速上手,提升开发之效率。 何谓v0.dev? v0.dev者,现代化之开发者工具也,旨在简化并加速软件开发之过程。其集多种功能于一体,助开发者高效编写、测试及部署代码。无论汝为前端开发者、后端开发者

音视频入门基础:WAV专题(10)——FFmpeg源码中计算WAV音频文件每个packet的pts、dts的实现

一、引言 从文章《音视频入门基础:WAV专题(6)——通过FFprobe显示WAV音频文件每个数据包的信息》中我们可以知道,通过FFprobe命令可以打印WAV音频文件每个packet(也称为数据包或多媒体包)的信息,这些信息包含该packet的pts、dts: 打印出来的“pts”实际是AVPacket结构体中的成员变量pts,是以AVStream->time_base为单位的显