Gin的使用

最新推荐文章于 2025-03-26 19:26:33 发布
最新推荐文章于 2025-03-26 19:26:33 发布
阅读量954 收藏 2
点赞数 2
分类专栏： GO语言 网络通信 文章标签： golang
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wzb_wzt/article/details/107411582
版权

Gin框架

  • gin框架路由使用前缀树，路由注册的过程是构造前缀树的过程，路由匹配的过程就是查找前缀树的过程。
  • gin框架的中间件函数和处理函数是以切片形式的调用链条存在的，我们可以顺序调用也可以借助c.Next()方法实现嵌套调用。
  • 借助c.Set()和c.Get()方法我们能够在不同的中间件函数中传递数据。
  • 使用前需要调用gin.Default()生成gin引擎
  • 调用r.Run()结尾，可以指定端口

安装

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

静态文件解析

  • 一般放在statics文件夹下分类存放
//静态文件的处理：静态文件指html页面用到的css\js\图片
r.Static("/relativepath", "./statics") //必须在模板解析之前；前面指定相对路径（html模板中使用，后面指定静态文件位置）

//使用
<link rel="stylesheet" href="/relativepath/demo.css">
<script src="/relativepath/vendor/jquery/jquery.min.js"></script>

HTML渲染

  • HTML一般放在templates文件夹中；可以通过define 来给模板命名来定位；
  • 模板文件后缀可以是.html也可以是.tmpl
//例如
{{define "post/index.tmpl"}}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>posts/index</title>
</head>
<body>
    {{.title}}
</body>
</html>
{{end}}


//模板加载的两种方式
r.LoadHTMLFiles("templates/post/index.tmpl", "templates/user/index.tmpl")//便于解析单个文件
r.LoadHTMLGlob("templates/**/*") //便于解析多个文件 **表示目录 *表示文件
//GET提交
r.GET("/post/index", func(c *gin.Context) {
		c.HTML(http.StatusOK, "post/index.tmpl", gin.H{ //第二个参数与模板中define 的文件名保持一致
			"title": "post/index渲染",
		})
	})
  • 自定义模板
// 自定义模板函数  必须写在模板解析之前
r.SetFuncMap(template.FuncMap{
	"safe": func(s string) template.HTML {
		return template.HTML(s)
	},
})
//使用：
<body>
    <h1> {{.title}}</h1>
    <div> {{.setFuncMap|safe}}</div>
</body>
  • 模板继承（调用"github.com/gin-contrib/multitemplate"库实现）
/*
示例；
假设home.tmpl和index.tmpl继承base.tmpl
templates
├── includes
│   ├── home.tmpl
│   └── index.tmpl
├── layouts
│   └── base.tmpl
└── scripts.tmpl
*/
func loadTemplates(templatesDir string) multitemplate.Renderer {
	r := multitemplate.NewRenderer()
	layouts, err := filepath.Glob(templatesDir + "/layouts/*.tmpl")
	if err != nil {
		panic(err.Error())
	}
	includes, err := filepath.Glob(templatesDir + "/includes/*.tmpl")
	if err != nil {
		panic(err.Error())
	}
	// 为layouts/和includes/目录生成 templates map
	for _, include := range includes {
		layoutCopy := make([]string, len(layouts))
		copy(layoutCopy, layouts)
		files := append(layoutCopy, include)
		r.AddFromFiles(filepath.Base(include), files...)
	}
	return r
}


func main(){
	r := gin.Default()
	r.HTMLRender = loadTemplates("./templates")
	r.GET("/index", func (c *gin.Context){
	c.HTML(http.StatusOK, "index.tmpl", nil)
})
	r.GET("/home", func (c *gin.Context){
	c.HTML(http.StatusOK, "home.tmpl", nil)
})
	r.Run()
}

JSON渲染

//方式1
r.GET("/hello", func(c *gin.Context) {
	// c.JSON：返回JSON格式的数据
	c.JSON(200, gin.H{
		"message": "Hello world!",
	})
})
//方式2
r.GET("/helloJSON2", func(c *gin.Context) {
	type msg struct {
		Name  string `json:"name"`
		Age   int
		Hobby string
	}
	var dataObj = msg{
		"wuzb",
		12,
		"soccer",
	}
	c.JSON(http.StatusOK, dataObj)
})

获取请求参数

//获取URL中querystring参数参数
//www.xxx.com/user/search?id=2&page=1
func main() {
	r := gin.Default()
	r.GET("/user/search", func(c *gin.Context) {
		userid := c.DefaultQuery("id ", "1")
		//userid := c.Query("id")
		page:= c.Query("page")
		//输出json结果给调用方
		c.JSON(http.StatusOK, gin.H{
			"message":  "ok",
			"userid ": userid ,
			"page":  page,
		})
	})
	r.Run()
}


//获取form参数
func main() {
	r := gin.Default()
	r.POST("/user/search", func(c *gin.Context) {
		// DefaultPostForm取不到值时会返回指定的默认值
		//username := c.DefaultPostForm("username", "zs")
		username := c.PostForm("username")
		address := c.PostForm("address")
		//输出json结果给调用方
		c.JSON(http.StatusOK, gin.H{
			"message":  "ok",
			"username": username,
			"address":  address,
		})
	})
	r.Run(":8080")
}


//获取path参数
func main() {
	r := gin.Default()
	r.GET("/user/search/:username/:address", func(c *gin.Context) {
		username := c.Param("username")
		address := c.Param("address")
		c.JSON(http.StatusOK, gin.H{
			"message":  "ok",
			"username": username,
			"address":  address,
		})
	})
	r.Run(":8080")
}


//通过bind（基于反射）来自动绑定参数到结构体
type Login struct {
	Username string `form:"name"json:"name" binding:"required,NameValid"` //NameValid是自定义验证方法
	Password string `form:"pwd"json:"pwd"`
}
//shouldBind() 能够基于请求自动提取JSON、form表单和QueryString类型的数据，并把值绑定到指定的结构体对象。
//绑定JSON的示例 ({"name": "wz", "pwd": "123456"})
r.GET("/shudBind", func(c *gin.Context) {
	var u Login
	if err := c.ShouldBind(&u); err == nil {
		c.JSON(http.StatusOK, gin.H{
			"name": u.Username,
			"pwd":  u.Password,
		})
	} else {
		c.JSON(http.StatusOK, gin.H{
			"error": err.Error(),
		})
	}
})

关于binging中的参数既可以自定义也可以使用框架自带的参数；

  1. 框架自带的参数比如required，gt=x,lt=y(大于x小于y)等；
  2. 自定义参数的话，验证使用到gopkg.in/go-playground/validator.v8；例如：
//首先写一个验证方法
func NameValid(
	v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value,
	field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string,
) bool {
	if s, ok := field.Interface().(string); ok {
		if s == "admin" {
			return false
		}
	}
	return true
}

// 在路由中绑定绑定验证器
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
	v.RegisterValidation("NameValid", NameValid)
}

重定向

//HTTP重定向 
r.GET("/test", func(c *gin.Context) {
	c.Redirect(http.StatusMovedPermanently, "http://www.sogo.com/")
})
//路由重定向
r.GET("/test", func(c *gin.Context) {
    // 指定重定向的URL
    c.Request.URL.Path = "/test2"
    r.HandleContext(c)
})
r.GET("/test2", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{"hello": "world"})
})

路由

//get
r.GET("/get", func(c *gin.Context) {
		c.HTML(http.StatusOK, "index.html", gin.H{})
	})
//post
r.POST("/post", func(c *gin.Context) {
		c.HTML(http.StatusOK, "index.html", gin.H{})
	})
//any可以匹配所有请求方法
r.Any("/any", func(c *gin.Context) {
		c.HTML(http.StatusOK, "index.html", gin.H{})
	})
//NoRoute:用于处理非注册的路由，报404页面
r.NoRoute(func(c *gin.Context) {
		c.HTML(http.StatusNotFound, "404.html", nil)
	})
//路由组
ginRoute := gin.Default()
prodGroup := ginRoute.Group("/prod")
{
	prodGroup.POST("/list", func(c *gin.Context) {c.HTML(http.StatusOK,"index.html", gin.H{})})
	prodGroup.GET("/detail/:pid",func(c *gin.Context){c.HTML(http.StatusOK,"index.html", gin.H{})})
}
return ginRoute

中间件

//中间件函数（统计请求处理函数的耗时）
func m1() gin.HandlerFunc {
	//连接数据库或者其他的一些操作
	return func(c *gin.Context) {
		//存放具体的逻辑
		start := time.Now()
		c.Next() //调用后续的函数
		// c.Abort() //阻止后续的函数
		//c.Set()//往上下文中存值；通过c.Get()取值；实现中间件的值传递
		cost := time.Since(start)
		fmt.Printf("cost %d times", cost)
	}

}


//中间件使用
//1.单个路由注册
r.GET("/middleware", m1(), func(c *gin.Context) { //某个路由单独注册中间体
		c.JSON(http.StatusOK, gin.H{
			"msg": "middleware",
		})
	})
//2.注册一个全局中间件
r.Use(m1())
//3.组注册中间件
r.Use(m1()){
把组路由给包裹进来
}
//或者
prodGroup := ginRoute.Group("/prod",m1())
{
	prodGroup.POST("/list", func(c *gin.Context) {c.HTML(http.StatusOK,"index.html", gin.H{})})
	prodGroup.GET("/detail/:pid",func(c *gin.Context){c.HTML(http.StatusOK,"index.html", gin.H{})})
}

文件上传

//html
<form action="/upload" method="post" enctype="multipart/form-data">
    <input type="file" name="f1">
    <input type="submit" value="上传">
</form>
//go
//单文件上传处理
func main() {
	router := gin.Default()
	// 处理multipart forms提交文件时默认的内存限制是32 MiB
	// 可以通过下面的方式修改
	// router.MaxMultipartMemory = 8 << 20  // 8 MiB
	router.POST("/upload", func(c *gin.Context) {
		// 单个文件
		file, err := c.FormFile("f1")
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{
				"message": err.Error(),
			})
			return
		}

		log.Println(file.Filename)
		dst := fmt.Sprintf("C:/tmp/%s", file.Filename)
		// 上传文件到指定的目录
		c.SaveUploadedFile(file, dst)
		c.JSON(http.StatusOK, gin.H{
			"message": fmt.Sprintf("'%s' uploaded!", file.Filename),
		})
	})
	router.Run()
}
//多文件上传处理
func main() {
	router := gin.Default()
	// 处理multipart forms提交文件时默认的内存限制是32 MiB
	// 可以通过下面的方式修改
	// router.MaxMultipartMemory = 8 << 20  // 8 MiB
	router.POST("/upload", func(c *gin.Context) {
		// Multipart form
		form, _ := c.MultipartForm()
		files := form.File["file"]

		for index, file := range files {
			log.Println(file.Filename)
			dst := fmt.Sprintf("C:/tmp/%s_%d", file.Filename, index)
			// 上传文件到指定的目录
			c.SaveUploadedFile(file, dst)
		}
		c.JSON(http.StatusOK, gin.H{
			"message": fmt.Sprintf("%d files uploaded!", len(files)),
		})
	})
	router.Run()
}

注意：

//异步(无法使用他的原始上下文，必须使用他的只读副本)
r.GET("/request-async", func(c *gin.Context) {
	copyC := c.Copy()
	go func() {
		time.Sleep(3 * time.Second)
		fmt.Println("异步请求：", copyC)
	}()
})


/*
gin.Default()默认使用了Logger和Recovery中间件:
Logger中间件将日志写入gin.DefaultWriter，即使配置了GIN_MODE=release。
Recovery中间件会recover任何panic。如果有panic的话，会写入500响应码。
*/
//需要建立个空白中间件的gin引擎的话可以使用
gin.New()
Gin框架的使用
m0_56137272的博客
09-10 2175
以上就是今天要讲的内容，本文仅仅简单介绍了Gin框架的使用，更多的用法请参考官方文档。
Go Web——Gin使用中间件
qq_39280718的博客
08-25 485
Gin 是一个基于 Go 语言编写的 Web 框架
Gin使用
weixin_34315665的博客
01-06 417
这里的博客版本都不会被更新维护。查看最新的版本请移步：http://neojos.com Gin对net/http包做了封装，支持路由、中间件等特性，极大的方便对Http Server的开发。文章通过一个Test例子，来简要介绍。对于特别基础的部分，请阅读参考文章。 接口测试 Go中testing包为程序自测提供了便利。可以查阅之前写的...
Gin的基本使用
金艺群的博客
07-25 310
安装：go get github.com\gin-gonic\gin 示例程序 package main import ( "fmt" "net/http" "path" "github.com/gin-gonic/gin" ) type Account struct { Username string `json:"username"` Password string `json:"password"` Avatar string `json:"avatar"` .
【Gin框架入门到精通系列14】Gin框架中的国际化与本地化
最新发布
GopherTribe的博客
03-26 606
本文详细介绍了Gin框架中实现国际化与本地化的方法，包括多语言支持实现、语言自动检测与切换、时区和格式处理以及资源管理策略，帮助您构建面向全球用户的Web应用，提供优质的本地化体验。
gin使用教程
penngo的专栏
01-15 2928
gin使用教程
Gin基本使用
qq_51164450的博客
05-22 1660
Gin框架使用 *基于httprouter开发的web框架 *提供Martini风格的API，但比Martini要快40倍 *非常轻量级，使用起来非常简洁 Gin框架安装与使用 *安装：go get -u github.com/gin-gonic/gin *import"github.com/gin-gonic/gin" 第一个Gin程序 package main import "github.com/gin-gonic/gin" func main(){ r := gin.Default() r.GE
Go Web——Gin使用cookies
qq_39280718的博客
08-25 740
Gin 是一个基于 Go 语言编写的 Web 框架
Go 语言中gin使用gzip压缩遇到的问题
09-21
主要介绍了Go 语言中gin使用gzip压缩遇到的问题,需要的朋友可以参考下
gin使用自定义结构绑定表单数据的示例代码
12-16
4. `StructD` 结构体中 `NestedAnonyStruct` 是一个匿名结构体，包含字段 `FieldX`，同样使用了 `form` 标签。 `GetDataB`、`GetDataC` 和 `GetDataD` 函数分别演示了如何将接收到的 HTTP GET 请求参数绑定到对应的...
Gin 框架的使用
功不唐捐，玉汝于成
04-29 1867
Go Web 开发框架 Gin 快速入门
multitemplate:多种格式的模板库，可互操作
06-29
多模板 虽然 Go 有多个模板库，但我想要一个允许我混合不同样式的模板，而不必创建某种查找表来查看模板是在哪个库中创建的。 Multitemplate是一组解析器、一个html函数库、模板互操作函数，以及一个类似于标准库中html/template模板结构的Template的实现。 它的执行后端是来自标准库的 html/template 包，multitemplate 是一组函数、解析器和胶水，它在标准库之上添加了更大的功能集。 当前文档可在。 当前状态为测试版。 快乐的道路是有效的，但偏离快乐的道路可能会导致大坏熊。 现在，我正在努力用多模板构建真实的东西，所以我将在任意时间推出多模板的新版本来解决我发现的问题。 在接下来的一两个月的某个时候，我计划开始将多模板移动到 0.5 版本的候选发布状态。 巴姆文档 我将继续添加到，这是用 bham 编写的预订示例中的一个简单片段。
Gin框架的大致使用方法（详细）
weixin_51991615的博客
03-20 6360
1、在gin框架中文文档是这么介绍的 Gin 是一个用 Go (Golang) 编写的 web 框架。 它是一个类似于 martini 但拥有更好性能的 API 框架，由于 httprouter，速度提高了近 40 倍。 如果你是性能和高效的追求者，你会爱上 Gin。两款Web框架相比较，Gin自己说他比Martini要强很多。 2、Gin的基本使用方法 首先在项目终端下载安装gin包： go get -u github.com/gin-gonic/gin 举一个简单的例子： package main
GIN框架介绍以及使用
编程技术， 日益精进
02-20 3483
李文周的博客
gin框架基本使用
m0_64288219的博客
01-19 5720
在go的web项目中，gin相当于java中的springmvc、gorm相当于java中的mybatis、gomod相当于java中的maven。gin的中文文档。
golang gin框架学习第一节之上传文件
weixin_34858807的博客
03-05 262
通过实现web浏览器上传文件，初探golang中gin框架使用方法。
golang-gin框架入门
wspppdy的博客
04-14 2035
相当于spring的拦截器，其中的Context的Next方法决定拦截前后。上下文对象同样是gin的基础，在gin中context方法非常的多。类似SpringBoot的SpringApplication；在go和go框架中，上下文是一个非常核心的概念，，当然和原生Context有点不同。到这里启动基本完成，
gin 七.路由组与接口异步处理的注意事项
qq_29799655的博客
05-09 1041
目录 解释,在请求后端接口时,某些情况下可能需要直接响应成功,后端异步去执行其他操作,在go时候通过groutine开启一个协程即可(接口默认是同步等待的) 注意点,由于groutine是异步的,所以在groutine中不可修改Context的值,防止groutine外部使用时造成数据混乱,通常情况下是复制已发Context的副本拿来使用 import ( "github.com/gin-gonic/gin" "log" "net/http" "time" ) func main() { r
深入Gin框架内幕(一)
weichuangxxb的博客
01-11 2530
Gin框架介绍 Gin是一个用 Go (Golang) 编写的 web 框架。它是一个类似于martini但性能更好的API框架，不同于谢大主导的Beegoweb框架，后者更像是Python语言中的Django框架，内部包含了开发一个web程序所需的各种组件。 如果你是性能和高效的追求者，我相信你会像我一样爱上Gin。 同时，不同于其他Golang语言的API框架，该框架社区十分活跃，并且主程仍然...
gin使用swagger
01-01
Gin是一个轻量级的Go语言Web框架，而Swagger是一套用于描述RESTful API的规范和工具集，它提供了一个可视化的方式来设计、文档化和测试API。将Swagger集成到Gin中可以帮助你更好地管理和展示API接口，使得开发者能够更方便地理解和操作。 在Gin中使用Swagger，通常需要以下几个步骤： 1. 安装依赖：首先你需要安装`gin-swagger`包，可以通过Go的包管理工具`go get`获取，例如 `go get -u github.com/swaggo/gin-swagger` 2. 配置中间件：在Gin应用中初始化`Swag`中间件，添加路由信息并指定生成的HTML文件路径。例如： ```go import "github.com/swaggo/gin-swagger" func main() { r := gin.Default() swagger := gin.NewSwagger() r.Use(swagger.Middleware()) // 添加你的API路由和处理函数 ... } ``` 3. 注解路由：使用Swagger提供的注解（如`@SWG Doc`、`@SWG Operation`等）来标记哪些路由应该被包含在文档中，以及它们的描述、参数和返回值。 4. 生成文档：运行应用程序后，访问Swagger UI页面（默认地址通常是`http://localhost:8080/swagger-ui.html`），你可以查看和测试你的API，并自动生成API文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值