当前位置：首页 > news >正文

gin 框架初始教程文档

news 2025/12/20 13:25:16

一、gin 入门

1. 安装gin ：下载并安装 gin包：

$ go get -u github.com/gin-gonic/gin

2. 将 gin 引入到代码中：

import "github.com/gin-gonic/gin"

3.初始化项目

go mod init gin

4.完整代码

package mainimport "github.com/gin-gonic/gin"func main() {r := gin.Default()r.GET("/ping", func(c *gin.Context) {c.JSON(200, gin.H{"message": "pong",})})r.Run()
}

5.启动项目

go run main.go  # 运行 main.go 并且在浏览器中访问 0.0.0.0:8080/ping

6.效果图

二、基础知识

go get -u

参数介绍：

-d 只下载不安装

-f 只有在你包含了 -u 参数的时候才有效，不让 -u 去验证 import 中的每一个都已经获取了，这对于本地 fork 的包特别有用

-fix 在获取源码之后先运行 fix，然后再去做其他的事情

-t 同时也下载需要为运行测试所需要的包

-u 强制使用网络去更新包和它的依赖包

-v 显示执行的命

三、gin测试用例

AsciiJSON 生成具有转义的非 ASCII 字符的 ASCII-only JSON。

package mainimport ("github.com/gin-gonic/gin""net/http"
)func main()  {r:=gin.Default()r.GET("/someJson", func(c *gin.Context) {data:=map[string]interface{}{"lang":"go 语言","tag":"<br>",}c.AsciiJSON(http.StatusOK,data)})r.Run(":8081")
}

为什么浏览器和终端命令行curl打印出来的结果格式不一样？gin.AsciiJSON

答：编码问题

绑定HTML复选框

package mainimport "github.com/gin-gonic/gin"type myForm struct {Colors []string `form:"colors[]"`
}func formHandler(c *gin.Context) {var fakeForm myFormc.ShouldBind(&fakeForm)c.JSON(200, gin.H{"color": fakeForm.Colors})
}func innerHandler(c *gin.Context) {c.HTML(200, "form.html", nil)
}func main() {r := gin.Default()r.LoadHTMLGlob("views/*")r.GET("/", innerHandler)r.POST("/", formHandler)r.Run(":8082")
}

views/form.html

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<form action="/" method="POST"><p>Check some colors</p><label for="red">Red</label><input type="checkbox" name="colors[]" value="red" id="red"><label for="green">Green</label><input type="checkbox" name="colors[]" value="green" id="green"><label for="blue">Blue</label><input type="checkbox" name="colors[]" value="blue" id="blue"><input type="submit">
</form>
</body>
</html>

绑定查询字符串或表单数据

package mainimport ("github.com/gin-gonic/gin""log""time"
)
//表单字符串
type PersonString struct {Name     string    `form:"name"`Address  string    `form:"address" `Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc:"1"`
}//请求json格式
type PersonJson struct {Name     string    `json:"name"`Address  string    `json:"address"`Birthday time.Time `json:"birthday" time_format:"2006-01-02" time_utc:"1"`
}func startPage(c *gin.Context) {var person PersonStringerr := c.Bind(&person)//ShouldBind 与 Bind 打印结果一样//err:=c.ShouldBind(&person)if err == nil {log.Println(person.Name)log.Println(person.Address)log.Println(person.Birthday)log.Println("Binding success...")} else {log.Println("Binding failed...")log.Println(err)}var personJson PersonJsonerrJson := c.BindJSON(&personJson)if errJson == nil {log.Println(personJson.Name)log.Println(personJson.Address)//log.Println(personJson.Birthday)log.Println("BindJson success...")} else {log.Println("BindJson failed...")log.Println(errJson)}c.String(200, "success")
}
func main() {log.Println("Hello World")route := gin.Default()route.GET("/testing", startPage)route.Run(":8083")
}

请求：

string:

 curl -X GET "http://0.0.0.0:8083/testing?name=appleboy&address=xyz&birthday=2023-03-15"
打印：结果
success

josn:

curl -X GET "http://0.0.0.0:8083/testing" --data '{"name":"JJ", "address":"xyz"}' -H "Content-Type:application/json"结果：success

效果图：

绑定uri

package mainimport "github.com/gin-gonic/gin"type Person struct {ID   string `uri:"id" building:"required,uuid"`Name string `uri:"name" building:"required"`
}func main() {r := gin.Default()r.GET("/:name/:id", func(c *gin.Context) {var person Personif err := c.ShouldBindUri(&person); err != nil {c.JSON(400, gin.H{"msg": err})return}c.JSON(200, gin.H{"name": person.Name, "uuid": person.ID})})r.Run(":8080")}

控制log 高亮输出，默认开启高亮

//强制log 高亮
gin.ForceConsoleColor()//关闭log高亮
//gin.DisableConsoleColor()

6.自定义http配置：（监听端口，读写时间，最大读写字节数）


func main() {r := gin.Default()r.GET("/ping", func(c *gin.Context) {c.String(200, "pong")})//两行作用一样，谁先执行谁生效//r.Run(":8080")//http.ListenAndServe(":8081",r)s := &http.Server{Addr:           ":8084",Handler:        r, //实例句柄ReadTimeout:    10 * time.Second,WriteTimeout:   10 * time.Second,MaxHeaderBytes: 1 << 20,}s.ListenAndServe()
}

自定义log文件

func main() {r := gin.New()r.Use(gin.LoggerWithFormatter(func(params gin.LogFormatterParams) string {return fmt.Sprintf("%s - [%s] \"%s %s %s %d %s \"%s\" %s\"\n",params.ClientIP,params.TimeStamp.Format(time.RFC3339),params.Method,params.Path,params.Request.Proto,params.StatusCode,params.Latency,params.Request.UserAgent(),params.ErrorMessage,)}))r.Use(gin.Recovery())r.GET("/ping", func(c *gin.Context) {c.String(200, "pong")})r.Run(":8080")
}

自定义中间件

//自定义中间件
func logger() gin.HandlerFunc {return func(c *gin.Context) {t := time.Now()//设置变量c.Set("lxw", "this is string")c.Set("lxwInt", 123456789)//请求前c.Next()//请求后latency := time.Since(t)log.Println(latency) //花费时间//获取发送的codestatusCode := c.Writer.Status()log.Println(statusCode)}
}
func main() {r := gin.New()r.Use(logger()) //引用(相当于include)r.GET("/test", func(c *gin.Context) {/*** MustGet returns the value for the given key if it exists, otherwise it panics.返回给定键的值（如果存在），否则会死机*/varInt := c.MustGet("lxwInt").(int) //int 是对变量lxwInt 的限制要求，若不是int则报错varString := c.GetString("lxw")log.Println(varInt,varString)})r.Run(":8080")
}

自定义验证器

//自定义验证器
//输入和输出日期必填；输出日期大于输入日期；输入和输出日期符合自定的验证器(日期需在今天日期之后)type Booking struct {CheckIn  time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"`CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn bookabledate" time_format:"2006-01-02"`
}//验证器
var bookableDate validator.Func = func(fl validator.FieldLevel) bool {date, ok := fl.Field().Interface().(time.Time)if ok {today := time.Now()if today.After(date) {return false}}return true
}func getBookable(c *gin.Context) {var b Bookingif err := c.ShouldBindWith(&b, binding.Query); err == nil {c.JSON(http.StatusOK, gin.H{"message": "book data is validate"})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}
}func main() {r := gin.Default()if v, ok := binding.Validator.Engine().(*validator.Validate); ok {v.RegisterValidation("bookabledate", bookableDate)}r.GET("/bookable", getBookable)r.Run(":8080")
}

请求地址：输入和输出日期必填；输出日期大于输入日期；输入和输出日期符合自定的验证器(日期需在今天日期之后)

http://0.0.0.0:8080/bookable?check_in=2023-02-08&check_out=2023-03-09

定义路由日志格式

//定义路由日志格式
func main() {r := gin.Default()gin.DebugPrintRouteFunc = func(httpMethod, absolutePath, handlerName string, nuHandlers int) {log.Printf("endpoint %v %v %v %v\n", httpMethod, absolutePath, handlerName, nuHandlers)}r.POST("/aaa", func(c *gin.Context) {c.JSON(http.StatusOK, "aaa")})r.GET("/bbb", func(c *gin.Context) {c.JSON(http.StatusOK, "bbb")})r.GET("/ccc", func(c *gin.Context) {c.JSON(http.StatusOK, "ccc")})r.Run()
}

优雅的关机或重启

//优雅的关机或重启
func main() {r := gin.Default()r.GET("/", func(c *gin.Context) {time.Sleep(5 * time.Second)c.String(http.StatusOK, "welcome server")})srv := &http.Server{Addr:    ":8080",Handler: r,}go func() {//服务连接：打印链接错误信息if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {log.Fatalf("listen: %s \n", err)}}()//等待中断信号优雅关闭服务器（设置5秒的超时时间）quit := make(chan os.Signal)signal.Notify(quit, os.Interrupt)<-quitlog.Println("shutdown server...")ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)defer cancel()//关机失败原因if err := srv.Shutdown(ctx); err != nil {log.Fatal("server shutdown:", err)}log.Println("server exiting")
}

路由组


func main() {r := gin.Default()v1 := r.Group("/v1"){v1.GET("/aa", loginEndpoint)v1.GET("/bb", exit)}r.Run()
}func loginEndpoint(c *gin.Context) {c.String(200,"hello")
}func exit( context2 *gin.Context)  {context2.String(200,"world")
}

记录日志到文件和控制台（默认直接打印在控制台）

func main() {//禁用控制台颜色，将日志写入文件时不需要控制台颜色（加不加无所谓）//gin.DisableConsoleColor()//创建日志文件fileName, _ := os.Create("gin.log")//将日志并发写入文件gin.DefaultWriter = io.MultiWriter(fileName)//将日志同时写入文件和控制台//gin.DefaultWriter = io.MultiWriter(fileName, os.Stdout)r := gin.Default()r.GET("/ping", func(c *gin.Context) {c.String(200, "pong")})r.Run()
}

参考：https://learnku.com/docs/gin-gonic/1.7/examples-bind-uri/11391

gin 框架初始教程文档

一、gin 入门1. 安装gin ：下载并安装 gin包：$ go get -u github.com/gin-gonic/gin2. 将 gin 引入到代码中：import "github.com/gin-gonic/gin"3.初始化项目go mod init gin4.完整代码package mainimport "github.com/gin-go…...

编程日记 2023/2/26 20:34:13

Maven的下载和安装【详细】

文章目录一、什么是Maven？二、Maven的安装与配置2.1下载Maven安装包2.2配置Maven环境变量2.3验证三、Idea配置Maven3.1配置 setting.xml文件3.2Idea配置Maven一、什么是Maven？ Apache Maven是个项目管理和自动构建工具，基于项目对象模型&…...

编程日记 2023/2/26 20:33:07

[数据结构]：04-循环队列（数组）（C语言实现）

目录前言已完成内容循环队列实现 01-开发环境 02-文件布局 03-代码 01-主函数 02-头文件 03-QueueCommon.cpp 04-QueueFunction.cpp 结语前言此专栏包含408考研数据结构全部内容，除其中使用到C引用外，全为C语言代码。使用C引用主要是为了…...

编程日记 2023/2/26 20:32:01

题目描述： import hashlib import sympy from Crypto.Util.number import *flag GWHT{******} secret ******assert(len(flag) 38)half len(flag) / 2flag1 flag[:half] flag2 flag[half:]secret_num getPrime(1024) * bytes_to_long(secret)p sympy.nextp…...

编程日记 2023/2/26 20:30:55

codeforces 1669F

题意: alice和bob从数组两边的吃糖果, 数组的值就是糖果重量要求alice和bob吃的糖果重量必须一样, 输出能吃几个糖果这题最先想到的是前后缀相加模拟一个前缀和和后缀和在n/2的位置向前找前缀和在n/2的位置向后找后缀和找到第一个前缀和后缀和的下标输出就好 …...

编程日记 2023/2/26 20:29:49

高数考试必备知识点

三角函数与反三角函数的知识点正弦函数 ysin x， 反正弦函数 yarcsin x • y sin x， x∈R， y∈[–1，1]，周期为2π，函数图像以 x (π/2) kπ 为对称轴 • y arcsin x， x∈[–1，1]…...

编程日记 2023/2/26 20:28:39

[蓝桥杯] 二分与前缀和习题练习

文章目录一、二分查找习题练习 1、1 数的范围 1、1、1 题目描述 1、1、2 题解关键思路与解答 1、2 机器人跳跃问题 1、2、1 题目描述 1、2、2 题解关键思路与解答 1、3 四平方和 1、3、1 题目描述 1、3、2 题解关键思路与解答二、前缀和习题练习 2、1 前缀和 2、1、1 题目描述…...

编程日记 2023/2/26 20:27:33

SpringMvc中HandlerAdapter组件的作用

概述我们在使用springMVC时，都知道其中不仅包含handlerMapping组件还包含handlerAdapter组件，为什么呢？ springMVC请求流程图 HandlerAdapter组件使用了适配器模式适配器模式的本质是接口转换和代码复用，这里使用适配器模式的…...

编程日记 2023/2/26 20:26:27

FreeRTOS优先级翻转

优先级翻转优先级翻转：高优先级的任务反而慢执行，低优先级的任务反而优先执行优先级翻转在抢占式内核中是非常常见的，但是在实时操作系统中是不允许出现优先级翻转的，因为优先级翻转会破坏任务的预期顺序，可能会导致未…...

编程日记 2023/2/26 20:25:20

服务器部署—部署springboot之Linux服务器安装jdk和tomcat【建议收藏】

我是用的xshell连接的云服务器，今天想在服务器上面部署一个前后端分离【springbootvue】项目，打开我的云服务器才发现，过期了，然后又买了一个，里面环境啥都没有，正好出一期教程，方便大家也方便自…...

编程日记 2023/2/26 20:24:15

golang项目----家庭收支记账软件

家庭收支记账软件实现基本功能(先使用面向过程，后面改成面向对象)项目代码实现改进面向过程源码面向对象源码utils包中main包中实现基本功能(先使用面向过程，后面改成面向对象) 编写文件TestMyAccount.go完成基本功能功能一：先完成可以显示…...

编程日记 2023/2/26 20:23:08

中国LNG市场投资机会研究

中国LNG市场投资机会研究中国LNG市场是一个具有巨大潜力和发展机遇的市场，尤其是在政府大力推动清洁能源发展的背景下，LNG市场投资机会正在不断扩大。首先，政府大力支持LNG市场的发展。政府实施的“十三五”规划将LNG作为清洁能源的重要来源&…...

编程日记 2023/2/26 20:22:02

Elasticsearch：索引数据是如何完成的

在我在之前的文章 “Elasticsearch：彻底理解 Elasticsearch 数据操作” 文章中，我详细地描述了如何索引数据到 Elasticsearch 中。在今天的文章中，我想更进一步来描述这个流程。 Elasticsearch 是一个非常强大和灵活的分布式数据系统&#x…...

编程日记 2023/2/26 20:20:53

处理器管理

处理器状态处理器管理是操作系统中重要组成部分，负责管理、调度和分配计算机系统的重要资源——处理器，并控制程序执行由于处理器管理是操作系统最核心的部分，无论是应用程序还是系统程序，最终都要在处理器上执行以实现其功能&…...

编程日记 2023/2/26 20:19:47

跟着我从零开始入门FPGA（一周入门系列）第五

5、同步和异步设计前面已有铺垫，同步就是与时钟同步。同步就是走正步，一二一，该迈哪个脚就迈那个脚，跑的快的要等着跑的慢的。异步就是搞赛跑，各显神通，尽最大力量去跑，谁跑得快，…...

编程日记 2023/2/26 20:18:41

【第42天】Arrays.sort 与 Collections.sort 应用 | 整形数组与集合的排序

本文已收录于专栏🌸《Java入门一百练》🌸学习指引序、专栏前言一.sort函数二、【例题1】1、题目描述2、解题思路3、模板代码4、代码解析二、【例题1】1、题目描述2、解题思路3、模板代码4、代码解析三、推荐专栏序、专栏前言本专栏开启，目的…...

编程日记 2023/2/26 20:17:35

LeetCode第334场周赛

2023.2.26LeetCode第334场周赛 A. 左右元素和的差值思路前缀和后缀和代码 class Solution { public:vector<int> leftRigthDifference(vector<int>& nums) {int n nums.size();vector<int> l(n), r(n), ans(n);for (int i 1; i < n; i )l[…...

编程日记 2023/2/26 20:16:28

基于深度学习的三维重建网络PatchMatchNet（三）：PatchMatchNet配置及代码主要运行流程

目录 1.PatchMatchNet环境配置 2. PatchMatchNet的大致执行流程（eval.py） 2.1 深度图的保存...

编程日记 2023/2/26 20:15:20

【一天一门编程语言】设计一门编程语言，给出基础语法代码示例，SDK设计。

文章目录设计一门编程语言，给出基础语法代码示例，SDK设计。一、编程语言设计1.1 语言名称1.2 数据类型1.3 基本运算符1.4 控制语句二、SDK设计2.1 基础库2.2 第三方库三、例子用 Mango 这门语言实现斐波那契数列。基础语法代码示例SDK 设计使用 Mango 语…...

编程日记 2023/2/26 20:14:11

ubuntu 下 python 安装 venv

ubuntu 下 python 安装 venv1.首先，确保您的系统已安装 Python3 和 pip3，如果没有安装，可以使用以下命令安装：2. 接着，安装 virtualenv 包，使用以下命令：3.创建 Python 虚拟环境，使用…...

编程日记 2023/2/26 20:13:03

Python｜GIF 解析与构建（5）：手搓截屏和帧率控制

目录 Python｜GIF 解析与构建（5）：手搓截屏和帧率控制一、引言二、技术实现：手搓截屏模块 2.1 核心原理 2.2 代码解析：ScreenshotData类 2.2.1 截图函数：capture_screen 三、技术实现&…...

编程新知 2025/11/14 3:06:30

label-studio的使用教程(导入本地路径)

文章目录 1. 准备环境2. 脚本启动2.1 Windows2.2 Linux 3. 安装label-studio机器学习后端3.1 pip安装(推荐)3.2 GitHub仓库安装 4. 后端配置4.1 yolo环境4.2 引入后端模型4.3 修改脚本4.4 启动后端 5. 标注工程5.1 创建工程5.2 配置图片路径5.3 配置工程类型标签5.4 配置模型5.…...

编程新知 2025/12/15 11:25:33

【入坑系列】TiDB 强制索引在不同库下不生效问题

文章目录背景SQL 优化情况线上SQL运行情况分析怀疑1：执行计划绑定问题？尝试：SHOW WARNINGS 查看警告探索 TiDB 的 USE_INDEX 写法Hint 不生效问题排查解决参考背景项目中使用 TiDB 数据库，并对 SQL 进行优化了，添加了强制索引。 UAT 环境已经生效，但 PROD 环境强制索…...

编程新知 2025/12/20 2:56:30