gin快速入门

news2025/11/4 22:27:46

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 Person
	if 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 User
	if 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 LoginForm
	if 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 User
	if 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")
}
//------------------------------------------------
// middleware

func 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)
	<-quit

	fmt.Println("服务关闭中....")
}

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

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

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

相关文章

JUnit 5和Mockito进行单元测试！

JUnit 5和Mockito进行单元测试！

1. JUnit 5 基础 JUnit 5是最新的JUnit版本&#xff0c;它引入了许多新特性&#xff0c;包括更灵活的测试实例生命周期、参数化测试、更丰富的断言和假设等。 1.1 基本注解 Test&#xff1a;标记一个方法为测试方法。 BeforeEach&#xff1a;在每个测试方法之前执行。 AfterEac…
阅读更多...
69 H3C SecPath F1000 （系统模块介绍-2）

69 H3C SecPath F1000 （系统模块介绍-2）

28-IRF 特性简介 IRF&#xff08;Intelligent Resilient Framework&#xff0c;智能弹性架构&#xff09;是一种软件虚拟化技术。它的核心思想是将多台设备连接在一起&#xff0c;进行必要的配置后&#xff0c;虚拟化成一台设备。使用这种虚拟化技术可以集合多台设备的硬件资源…
阅读更多...
54. 螺旋矩阵【 力扣(LeetCode) 】

54. 螺旋矩阵【 力扣(LeetCode) 】

一、题目描述 给你一个 m 行 n 列的矩阵 matrix &#xff0c;请按照 顺时针螺旋顺序 &#xff0c;返回矩阵中的所有元素。 二、测试用例 示例 1&#xff1a; 输入&#xff1a;matrix [[1,2,3],[4,5,6],[7,8,9]] 输出&#xff1a;[1,2,3,6,9,8,7,4,5]示例 2&#xff1a; 输入…
阅读更多...
软件测试——自动化测试selenium

软件测试——自动化测试selenium

自动化测试 测试人员编写自动化测试脚本&#xff0c;维护并解决自动化脚本问题 自动化的主要目的就是用来进行回归测试 回归测试 常见面试题 ⾃动化测试能够取代人工测试吗&#xff1f; ⾃动化测试不⼀定⽐人工测试更能保障系统的可靠性&#xff0c;⾃动化测试是测试⼈员手…
阅读更多...
图论 最短路

图论 最短路

文章目录 单源最短路朴素Dijkstra代码 堆优化Dijkstra代码 Bellman-ford代码 spfaspfa求最短路代码 spfa判断负环代码 多源最短路Floyd代码 单源最短路 朴素Dijkstra 给定一个 n n n 个点 m m m 条边的有向图&#xff0c;图中可能存在重边和自环&#xff0c;所有边权均为正…
阅读更多...
vscode 阅读linux内核（vscode+clangd）

vscode 阅读linux内核（vscode+clangd）

此插件曾在vim里用过&#xff0c;非常好用。 首先先在vscode 里下载clangd插件 这只是客户端&#xff0c;还需下载个服务器&#xff08;这在coc插件里也有说明&#xff09; sudo apt install clangd 下载完后可以 clangd --version 查看版本信息&#xff0c;如果能查看&#x…
阅读更多...
回归预测|基于灰狼GWO优化BP神经网络多输入多输出的数据回归预测Matlab程序GWO-BP 含预测新数据程序

回归预测|基于灰狼GWO优化BP神经网络多输入多输出的数据回归预测Matlab程序GWO-BP 含预测新数据程序

回归预测|基于灰狼GWO优化BP神经网络多输入多输出的数据回归预测Matlab程序GWO-BP 含预测新数据程序 文章目录 前言回归预测|基于灰狼GWO优化BP神经网络多输入多输出的数据回归预测Matlab程序GWO-BP 含预测新数据程序 一、GWO-BP多输出模型1. 原理2. GWO-BP模型流程步骤1: 初始…
阅读更多...
jenkins最佳实践（一）：jenkins安装与部署

jenkins最佳实践（一）：jenkins安装与部署

各位小伙伴们大家好呀&#xff0c;我是小金&#xff0c;下面我将记录学习jenkins的系列文章与心得&#xff0c;一方面用于博主的自我记录&#xff0c;一方面如果能帮助到正在浏览这篇文章的小伙伴&#xff0c;那更好不过了&#xff0c;本篇文章主要讲述jenkins的安装以及安装je…
阅读更多...
已经30岁了，想转行从头开始现实吗？什么样的工作算好工作？

已经30岁了，想转行从头开始现实吗？什么样的工作算好工作？

我是29岁那年&#xff0c;完成从转行裸辞副业的职业转型。 如果你把职业生涯看成是从现在开始30岁&#xff0c;到你退休那年&#xff0c;中间这么漫长的30年&#xff0c;那么30岁转行完全来得及&#xff1b; 如果你觉得必须在什么年纪&#xff0c;什么时间内必须完成赚到几十…
阅读更多...
框架——MyBatis查询（单表查询，多表联查）

框架——MyBatis查询（单表查询，多表联查）

目录 1.单表查询 2.多表查询 想查询student并且查询student所选择的专业major ①通过id查一个 ②不传入值直接查所有的学生列表 ③嵌套查询 想查询专业major并且查询该专业被哪些学生student选择 ①通过id查一个 ②不传入值直接查所有的专业列表 ③嵌套查询 3. 设置自动…
阅读更多...
webpack打包优化方案

webpack打包优化方案

调试工具&#xff1a;安装webpack-bundle-analyzer打包可视化工具&#xff0c;可以看到打包文件大小&#xff0c;从而有针对性的优化。 npm install --save-dev webpack-bundle-analyzer。 方案一&#xff1a;将第三方依赖包使用cdn进行引入减小文件包体积&#xff08;例&…
阅读更多...
Unity 编辑器-UGUI拓展Button,一个和原Button一样按钮⭐

Unity 编辑器-UGUI拓展Button,一个和原Button一样按钮⭐

拓展Button 需求实现1.创建继承自Button的类2.处理Inspector 显示问题3.处理在prafab中和hierarchy中创建按钮4.处理一些细节 完成 需求 想拓展一下UGUI的Button,找了几个帖子&#xff0c;只是能实现功能&#xff0c;但是用起来总有些不尽人意的地方&#xff0c;想办法处理一下…
阅读更多...
针对防火墙IPSec业务不通或业务丢包问题，防火墙如何做流量统计、远程抓包、报文示踪

针对防火墙IPSec业务不通或业务丢包问题，防火墙如何做流量统计、远程抓包、报文示踪

问题描述 针对防火墙IPSec业务不通或业务丢包问题&#xff0c;防火墙如何做流量统计、远程抓包、报文示踪 解决方案 1&#xff09;配置流统和远程抓包用的ACL&#xff1b; system [sysname] acl 3555 [sysname-acl-adv-3555] rule permit icmp source 10.82.100.215 0 destin…
阅读更多...
Vue实现表格数据的增删改查

Vue实现表格数据的增删改查

整体效果图&#xff1a; 一、创建表格数据 效果图&#xff1a; el-table组件&#xff1a;表格组件 <el-table:data"dataList"borderv-loading"dataListLoading"selection-change"selectionChangeHandle"style"width: 100%;">&l…
阅读更多...
KISS(Keep It Sample,Stupid)[完整代码]

KISS(Keep It Sample,Stupid)[完整代码]

根据KISS原文它的伪随机数产生器的Period about 2^123&#xff0c;周期很长&#xff0c;并且来自于多个产生器的共同作用之下而得&#xff0c; 原文的这这句话很有意思&#xff0c;&#xff08;车轱辘压我脸上了&#xff09;一个人不好的时候&#xff0c;试一试两个人&#xff…
阅读更多...
线段树的原理

线段树的原理

1.如果知道两个子范围上的最值&#xff0c;通过比较就可以知道整个范围上的最值 2.如果知道两个子范围上分别出现的次数最多的数&#xff0c;但无法知道整个范围上出现最多的数 范围修改logn的前提&#xff1a;如果维护的是区域和&#xff0c;要把区域上的每个数字加上a&#…
阅读更多...
【蓝桥杯集训100题】scratch绘制扇子 蓝桥杯scratch比赛专项预测编程题 集训模拟练习题第28题

【蓝桥杯集训100题】scratch绘制扇子 蓝桥杯scratch比赛专项预测编程题 集训模拟练习题第28题

scratch绘制扇子 蓝桥杯集训100题第28题模拟练习解析 此题曾经作为第十届省赛的真题考过 一、题目要求 以坐标&#xff08;0,0&#xff09;点为中心绘制一把扇子&#xff1b;扇面和扇把都是三分之一圆&#xff0c;扇面的半径 为 100 左右&#xff0c;扇把的半径为 20 左右。…
阅读更多...
HTML实现2048小游戏

HTML实现2048小游戏

游戏概述 实现一个基本的2048游戏涉及综合运用HTML、CSS和JavaScript这三种关键技术。 HTML用于构建游戏的结构框架&#xff0c;包括游戏容器、网格布局以及可能的用户交互元素&#xff08;如按钮或得分显示&#xff09;。 CSS则负责美化游戏界面&#xff0c;通过样式表定义网格…
阅读更多...
培训班和科班出生有什么区别

培训班和科班出生有什么区别

IT业的萌新来啦 每到毕业季 总有大量萌新走进职场 IT圈子的程序员 有的是科班出生 比如 计算机科学与技术、软件工程、大数据技术 有的是相关专业出生的 比如 信息安全、网络工程、物联网工程等等 除此之外 还有各种其他专业转行过来的 文理不限、专业不限 科班出生…
阅读更多...
mydump 文件拆分 mysqldumpsplitter

mydump 文件拆分 mysqldumpsplitter

mydump 文件拆分 如何将mysqldump的输出拆分为较小的文件&#xff1f; 要将mysqldump的输出拆分为较小的文件&#xff0c;可以使用–max-allowed-packet和–single-transaction选项。 使用–max-allowed-packet选项设置每个查询允许的最大数据包大小。这将确保mysqldump在执行…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023