Gin框架: 路由解析与分组详解

已于 2024-02-20 12:57:22 修改
阅读量1.1k 收藏 20
点赞数 27
分类专栏： Golang 文章标签： gin golang
于 2024-02-20 12:12:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Tyro_java/article/details/136178737
版权

参数获取与表单处理


1 ）参数获取, 处理 Query 和 Params 请求

package main

import (
	"net/http"
	"github.com/gin-gonic/gin"
)

var statusOK = http.StatusOK

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()

	// 首页
	r.GET("/", func(c *gin.Context) {
		c.String(statusOK, "Welcome to %v", "Home Page")
	})

	// 用户页面
	r.GET("/user", func(c *gin.Context) {
		uid := c.Query("uid")
		page := c.DefaultQuery("page", "0") // 不传这个值，把0当做其默认值
		c.String(statusOK, "uid=%v page=%v", uid, page)
	})

	// 新闻页面
	r.GET("/news/:nid", func(c *gin.Context) {
		nid := c.Param("nid")
		c.String(statusOK, "newsID=%s", nid)
	})

	r.Run()
}
  • 访问: /user, 页面渲染出来的是: uid= page=0
  • 访问: /user?uid=1&page=1, 页面渲染出来的是: uid=1 page=1
  • 访问: /news/1, 页面渲染出来的是: newsID=1

2 ）表单处理

  • 首先看下设定的结构

    yourGinProject/ ·······························  根目录
  ├── go.mod ··································  go mod 文件
  ├── go.sum ··································  go sum 文件
  ├── main.go ·································  main 文件
  └── tpls ····································· html模板目录
	    └── web
	          ├── profile.html
	          └── user.html

  • 再设计下路由访问

    • GET /profile 获取 profile 页面
    • POST /doAddProfile 提交 profile 页面表单处理
    • GET /user 获取 user 页面
    • POST /doAddUser 提交 user 页面表单处理
    • GET /getUser?username=zhangsan&password=1111 查询某条user数据
    • POST /xml 提交xml数据处理

  • 主程序

    package main

import (
	"encoding/xml"
	"net/http"
	"github.com/gin-gonic/gin"
)

var statusOK = http.StatusOK
var statusBadRequest = http.StatusBadRequest

type UserInfo struct {
	Username string `json:"username" form:"username"`
	Password string `json:"password" form:"password"`
}

type Article struct {
	Title   string `json:"title" xml:"title"`
	Content string `json:"content" xml:"content"`
}

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()
	// 加载模板 放在配置路由前面
	r.LoadHTMLGlob("tpls/**/*")

  // 首页
	r.GET("/", func(c *gin.Context) {
		c.String(statusOK, "Welcome to %v", "Home Page")
	})

	// ---------------- profile 页面处理 --------------------
	// 配置可访问的profile页面可以进行post演示
	r.GET("/profile", func(c *gin.Context) {
		c.HTML(statusOK, "web/profile.html", gin.H{})
	})

	// 获取表单post过来的数据
	r.POST("/doAddProfile", func(c *gin.Context) {
		// 参数处理
		username := c.PostForm("username")
		password := c.PostForm("password")
		age := c.DefaultPostForm("age", "20") // 这里有一个默认的参数

		// 响应出去
		c.JSON(statusOK, gin.H{
			"username": username,
			"password": password,
			"age":      age,
		})
	})

	// ---------------- user 页面处理 --------------------
	// 配置可访问的user页面可以进行post演示
	r.GET("/user", func(c *gin.Context) {
		c.HTML(statusOK, "web/user.html", gin.H{})
	})

	// 处理user页面提交出来的数据
	r.POST("/doAddUser", func(c *gin.Context) {
		// user结构体会作为接收参数的结构
		user := &UserInfo{}
		// 正常情况，使用 ShouldBind 来处理
		// .ShouldBind()强大的功能，它能够基于请求自动
		// 提取 JSON、form 表单和 QueryString 类型的数据
		// 并把值绑定到指定的结构体对象
		if err := c.ShouldBind(&user); err == nil {
			// c.JSON(statusOK, &user)
			c.JSON(statusOK, user) // 上下两者均可
		} else {
			// 错误处理
			c.JSON(statusBadRequest, gin.H{
				"err": err.Error(),
			})
		}
	})

	// ---------------- 模拟查询user接口 --------------------
	// 访问参考: /getUser?username=zhangsan&password=1111
	r.GET("/getUser", func(c *gin.Context) {
		// 设定user结构体
		user := &UserInfo{}
		// 处理参数
		if err := c.ShouldBind(&user); err == nil {
			c.JSON(http.StatusOK, user)
		} else {
			c.JSON(http.StatusOK, gin.H{
				"err": err.Error(),
			})
		}
	})

	// ---------------- 这里使用 postman 来提交xml --------------------
	// 获取 Post Xml 数据
	r.POST("/xml", func(c *gin.Context) {
		// 准备结构体
		article := &Article{}
		// 获取原生xml数据
		xmlSliceData, _ := c.GetRawData() //获取 c.Request.Body 读取请求数据

		if err := xml.Unmarshal(xmlSliceData, &article); err == nil {
			c.JSON(statusOK, article)
		} else {
			c.JSON(statusBadRequest, gin.H{
				"err": err.Error(),
			})
		}
	})

	r.Run()
}

  • html 页面

    • web/profile.html
      {{ define "web/profile.html" }}

  <form action="/doAddProfile" method="post">
      
      用户名:<input type="text" name="username" /> <br><br>
      密码:<input type="password" name="password" /> <br><br>      

      <input type="submit" value="提交">
  </form>

{{end}}
    • web/user.html
      {{ define "web/user.html" }}

  <form action="/doAddUser" method="post">
      
      用户名:<input type="text" name="username" /> <br><br>
      密码:<input type="password" name="password" /> <br><br>      

      <input type="submit" value="提交">
  </form>

{{end}}

  • 特别地，提交xml时的设置与响应

路由分组处理

1 ）简单分组

主程序

package main

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

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()
	
	// 默认分组
	defaultRouters := r.Group("/")
	{
		defaultRouters.GET("/", func(c *gin.Context) {
			c.String(200, "首页")
		})
		defaultRouters.GET("/news", func(c *gin.Context) {
			c.String(200, "新闻")
		})
	}
	
	// api分组
	apiRouters := r.Group("/api")
	{
		apiRouters.GET("/", func(c *gin.Context) {
			c.String(200, "我是一个api接口")
		})
		apiRouters.GET("/userlist", func(c *gin.Context) {
			c.String(200, "我是一个api接口-userlist")
		})
		apiRouters.GET("/plist", func(c *gin.Context) {
			c.String(200, "我是一个api接口-plist")
		})
	}
	
	// admin分组
	adminRouters := r.Group("/admin")
	{
		adminRouters.GET("/", func(c *gin.Context) {
			c.String(200, "后台首页")
		})
		adminRouters.GET("/user", func(c *gin.Context) {
			c.String(200, "用户列表")
		})
		adminRouters.GET("/article", func(c *gin.Context) {
			c.String(200, "新闻列表")
		})
	}

	r.Run()
}

2 ）按文件分组

  • 首先看下设定的结构
    yourGinProject/ ·······························  根目录
  ├── go.mod ··································  go mod 文件
  ├── go.sum ··································  go sum 文件
  ├── main.go ·································  main 文件
  └── tpls ····································· html模板目录
  |	    └── web
  |	          └── index.html
  └── routers ·································· 路由配置目录
		├── webRouters.go
		├── apiRouters.go
		└── adminRouters.go

2.1 主程序

package main

import (
	"gin-demo/routers" // 注意，这里gin-demo是项目名称，需要一开始 go mod init gin-demo
	"github.com/gin-gonic/gin"
)

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()

	// 配置默认路由
	routers.WebRoutersInit(r)
	
	// 配置api
	routers.ApiRoutersInit(r)

	// 配置admin
	routers.AdminRoutersInit(r)

	r.Run()
}

2.2 routers 包

2.1 webRouters.go

package routers

import (
	"net/http"
	"github.com/gin-gonic/gin"
)

var statusOK = http.StatusOK

func WebRoutersInit(r *gin.Engine) {
	r.LoadHTMLGlob("tpls/**/*") // 配置模板路径，如果是通用的，这个配置应放在 main.go 中
	webRouters := r.Group("/")
	{
		webRouters.GET("/", func(c *gin.Context) {
			c.HTML(statusOK, "web/index.html", gin.H{
				"msg": "我是一个msg",
			})
		})
		webRouters.GET("/news", func(c *gin.Context) {
			c.String(statusOK, "新闻")
		})
	}
}

2.2 apiRouters.go

package routers

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

func ApiRoutersInit(r *gin.Engine) {
	apiRouters := r.Group("/api")
	{
		apiRouters.GET("/", func(c *gin.Context) {
			c.String(200, "我是一个api接口")
		})
		apiRouters.GET("/userlist", func(c *gin.Context) {
			c.String(200, "我是一个api接口-userlist")
		})
	}
}

2.3 adminRouters.go

package routers

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

func AdminRoutersInit(r *gin.Engine) {
	adminRouters := r.Group("/admin")
	{
		adminRouters.GET("/", func(c *gin.Context) {
			c.String(200, "后台首页")
		})
		adminRouters.GET("/user", func(c *gin.Context) {
			c.String(200, "用户列表")
		})
	}
}
Gin框架深度解析：构建高性能Go Web应用的基石
m0_70066267的博客
07-29 1358
Gin是Go语言生态中一款轻量级但功能强大的Web框架。它的设计初衷是提供一个简单、快速且高效的方式来构建Web应用。与其他Go Web框架相比，Gin在保持高性能的同时，还提供了丰富的API和灵活的中间件支持，使得开发者可以轻松地构建出既满足性能要求又具备丰富功能的Web应用。除了内置的中间件之外，Gin还允许开发者自定义中间件。自定义中间件可以根据应用的具体需求来编写，实现诸如权限验证、CORS（跨源资源共享）控制、请求限流等特定功能。
gin路由分组
10-31 872
gin路由分组 func main() { router := gin.Default() // Simple group: v1 v1 := router.Group("/v1") { v1.POST("/login", loginEndpoint) v1.POST("/submit", submitEndpoint) v1.POST("/read", readEndpoint) } // Simple group: v2 v2 := router.Group("/v2.
gin-路由分组
wtt234的专栏
04-27 694
主函数： //路由分组 func routegroup() { type Userinfo struct { Username string `form:"username" json:"user"` Password string `form:"password" json:"password"` } r := gin.Default() //调用文件routes包下的路由分组 routes.AdminRoutesInit(r) routes.ApiRoutesInit(r)
【Gin框架入门到精通系列04】Gin中的路由分组
最新发布
GopherTribe的博客
03-25 972
本文深入介绍Gin框架的路由分组功能，包括基础路由分组、嵌套分组技术以及API版本控制实现，通过系统化的讲解和实战代码示例，帮助开发者构建结构清晰、易于维护的大型Web应用。
2. Gin路由分组
菜鸟的博客
06-02 1056
Gin路由分组功能
Gin框架入门(三)—多路由分组
kiscon的博客
04-27 453
Gin框架入门(三)—多路由分组 官方文档：https://godoc.org/github.com/gin-gonic/gin 官方地址：https://github.com/gin-gonic/gin 路由分组：https://gin-gonic.com/zh-cn/docs/examples/grouping-routes
Gin框架中实现路由分组
owolai的博客
10-09 433
分组可以包含中间件、路由前缀等，这使得路由的组织和管理变得非常方便，尤其是在大型项目中。分组还可以嵌套使用，即在一个分组内再创建分组，这有助于进一步组织和管理复杂的路由结构。通过这种方式，你可以根据需要灵活地组织和管理你的Web应用路由。每个分组内可以定义多个路由，这些路由会自动继承分组的前缀。方法来创建一个分组，然后在这个分组中定义相关的路由。在Gin框架中实现路由分组非常简单，你可以使用。
Go语言Gin框架：数据绑定与API详解
Gin框架支持多种数据绑定方式，这对于处理HTTP请求中的参数尤其重要，因为它允许开发者将请求体或查询字符串自动映射到结构体字段，简化了数据解析过程。 首先，获取 Gin 的路由引擎是基础操作，通过`gin.Default()...
Gin框架详解：v1.7.1版本的高效API设计与实现
Gin框架介绍(v1.7.1) 是一个轻量级、高效的API开发框架，专为构建高性能的Web服务而设计。以下是一些核心特点和工作原理的详细解析： 1. **快速路由与内存效率**: Gin采用基数树（Radix Tree）数据结构实现路由...
深入解析Gin框架的路由机制
通过本篇内容，开发者可以全面掌握Gin框架的路由处理能力，提高API开发的效率和性能。 首先，Gin的路由匹配机制是基于HTTP请求方法和URL路径的，开发者可以为不同的HTTP方法（如GET、POST、PUT、DELETE等）定义对应...
【Gin框架核心组件详解】：深入理解路由、中间件和处理器
[【Gin框架核心组件详解】：深入理解路由、中间件和处理器](https://opengraph.githubassets.com/b898812e8f23a6a0e112c8bc90707578fff7b86c4c1dc38e8700e1b9022a592e/gin-gonic/gin/issues/229) # 摘要 Gin框架...
gin路由组
bonfirelit的博客
07-25 1263
这行代码调用了方法，返回一个新的路由组对象v1。所有在这个组内定义的路由都会自动加上/v1作为前缀。
Go Web轻量级框架Gin学习系列：路由分组
weixin_34007879的博客
05-04 3995
在这篇文章中我们来讲一讲Gin框架路由(Router)的设置，Gin框架的路由设置非常简单，我们在前面几篇学习Gin框架的文章中，几乎每个示例都会见到Gin的路由定义，Gin框架就是通过定义路由以及处理该路由对应的Handler来接收用户的Web请求。 HttpRouter Gin框架的路由实际是使用第三方的HttpRouter库,HttpRouter是一个轻量级高性能的HTTP请求路由器(路由多...
Golang Gin框架路由分组分文件
地球流浪猫的博客
04-08 792
使用Gin框架写Go项目的时候，如果把路由都写在一个.go文件中，随着路由的数量的增加，会导致路由文件显得异常臃肿。分组后的go代码，虽然路由都实现路由分组，路由的逻辑显得清晰，但是路由文件还是集中在一个文件中，文件还是大。此时需要对路由进行分组并且分文件管理，更有利于代码的组织和维护，更好把项目做大，做强，再创辉煌。
7.Gin 路由详解 - 路由分组 - 路由文件抽离
DevOps海洋的渔夫@专栏
11-20 516
7.Gin 路由详解 - 路由分组 - 路由文件抽离前言在前面的示例中，我们直接将路由的定义全部写在 main.go 文件中，如果后面 路由越来越多，那将会越来越不好管理。所以，下一步我们应该考虑将路由进行分组管理，并且将其抽离 main.go的文件。1696330394289路由分组我们可以将相同模块路径的作为一组，将路由进行分组处理。1696330862506//2.1路由分组 //设置...
Gin：路由抽离与分组
Fisher3652的博客
02-07 1133
目录1. 对路由进行分组2. 配置 main.go3. 启动服务 1. 对路由进行分组 这里使用2组路由，user和department 新建routers文件夹，创建userRouters.go和departmentRouters.go userRouters package routers import ( "net/http" "github.com/gin-gonic/gin" ) func UserRoutersInit(router *gin.Engine) { user
Gin框架的分组路由与分组中间件
一起coding，一起嗨。
09-05 970
Gin框架的分组路由与分组中间件
gin框架学习-路由分组和中间件
林钟一的博客
07-04 3829
gin框架学习-路由分组和中间件
Gin框架之路由详解
阿澈不吃蒜的博客
09-11 1056
当我们的项目比较大的时候有必要对我们的控制器进行分组在中大型项目中，路由是路由，业务逻辑（控制方法）是分开且又相互联系的两个方法来操作方法分离：（建议使用结构体）两个方法都需要构建文件入口。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值