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。

相关文章

从入门到精通MySQL联合查询

从入门到精通MySQL联合查询

《从入门到精通MySQL联合查询》：本文主要介绍从入门到精通MySQL联合查询,本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下... 目录摘要1. 多表联合查询时mysql内部原理2. 内连接3. 外连接4. 自连接5. 子查询6. 合并查询7. 插入查询结果摘要前面我们学习了数据库设计时要满
阅读更多...
从入门到精通C++11 ＜chrono＞ 库特性

从入门到精通C++11 ＜chrono＞ 库特性

《从入门到精通C++11＜chrono＞库特性》chrono库是C++11中一个非常强大和实用的库,它为时间处理提供了丰富的功能和类型安全的接口,通过本文的介绍,我们了解了chrono库的基本概念... 目录一、引言1.1 为什么需要<chrono>库1.2<chrono>库的基本概念二、时间段（Durat
阅读更多...
解析C++11 static_assert及与Boost库的关联从入门到精通

解析C++11 static_assert及与Boost库的关联从入门到精通

《解析C++11static_assert及与Boost库的关联从入门到精通》static_assert是C++中强大的编译时验证工具,它能够在编译阶段拦截不符合预期的类型或值,增强代码的健壮性,通... 目录一、背景知识：传统断言方法的局限性1.1 assert宏1.2 #error指令1.3 第三方解决
阅读更多...
Linux如何快速检查服务器的硬件配置和性能指标

Linux如何快速检查服务器的硬件配置和性能指标

《Linux如何快速检查服务器的硬件配置和性能指标》在运维和开发工作中,我们经常需要快速检查Linux服务器的硬件配置和性能指标,本文将以CentOS为例,介绍如何通过命令行快速获取这些关键信息,... 目录引言一、查询CPU核心数编程（几C？）1. 使用 nproc（最简单）2. 使用 lscpu（详细信
阅读更多...
从入门到精通MySQL 数据库索引(实战案例)

从入门到精通MySQL 数据库索引(实战案例)

《从入门到精通MySQL数据库索引(实战案例)》索引是数据库的目录,提升查询速度,主要类型包括BTree、Hash、全文、空间索引,需根据场景选择,建议用于高频查询、关联字段、排序等,避免重复率高或... 目录一、索引是什么？能干嘛？核心作用：二、索引的 4 种主要类型（附通俗例子）1. BTree 索引（
阅读更多...
Redis 配置文件使用建议redis.conf 从入门到实战

Redis 配置文件使用建议redis.conf 从入门到实战

《Redis配置文件使用建议redis.conf从入门到实战》Redis配置方式包括配置文件、命令行参数、运行时CONFIG命令,支持动态修改参数及持久化,常用项涉及端口、绑定、内存策略等,版本8... 目录一、Redis.conf 是什么？二、命令行方式传参（适用于测试）三、运行时动态修改配置（不重启服务
阅读更多...
MySQL DQL从入门到精通

MySQL DQL从入门到精通

《MySQLDQL从入门到精通》通过DQL,我们可以从数据库中检索出所需的数据,进行各种复杂的数据分析和处理,本文将深入探讨MySQLDQL的各个方面,帮助你全面掌握这一重要技能,感兴趣的朋友跟随小... 目录一、DQL 基础：SELECT 语句入门二、数据过滤：WHERE 子句的使用三、结果排序：ORDE
阅读更多...
一文详解如何在idea中快速搭建一个Spring Boot项目

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热
阅读更多...
Python中OpenCV与Matplotlib的图像操作入门指南

Python中OpenCV与Matplotlib的图像操作入门指南

《Python中OpenCV与Matplotlib的图像操作入门指南》：本文主要介绍Python中OpenCV与Matplotlib的图像操作指南,本文通过实例代码给大家介绍的非常详细,对大家的学... 目录一、环境准备二、图像的基本操作1. 图像读取、显示与保存 使用OpenCV操作2. 像素级操作3.
阅读更多...
MybatisX快速生成增删改查的方法示例

MybatisX快速生成增删改查的方法示例

《MybatisX快速生成增删改查的方法示例》MybatisX是基于IDEA的MyBatis/MyBatis-Plus开发插件,本文主要介绍了MybatisX快速生成增删改查的方法示例,文中通过示例代... 目录1 安装2 基本功能2.1 XML跳转2.2 代码生成2.2.1 生成.xml中的sql语句头2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2