ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Gin框架系列02:路由与参数

2020-05-25 17:04:22  阅读:257  来源: 互联网

标签:02 string IRoutes func gin Context Gin Copy 路由


回顾#

上一节我们用Gin框架快速搭建了一个GET请求的接口,今天来学习路由和参数的获取。

请求动词#

熟悉RESTful的同学应该知道,RESTful是网络应用程序的一种设计风格和开发方式,每一个URI代表一种资源,客户端通过POSTDELETEPUTGET四种请求方式来对资源做增删改查的操作。

同样的,Gin框架给我们提供的除这4种动词外,还有PATCHOPTIONHEAD等,详细内容可以查看rentergroup.go文件的IRoutes接口。

Copy
type IRoutes interface {
	Use(...HandlerFunc) IRoutes

	Handle(string, string, ...HandlerFunc) IRoutes
	Any(string, ...HandlerFunc) IRoutes
	GET(string, ...HandlerFunc) IRoutes
	POST(string, ...HandlerFunc) IRoutes
	DELETE(string, ...HandlerFunc) IRoutes
	PATCH(string, ...HandlerFunc) IRoutes
	PUT(string, ...HandlerFunc) IRoutes
	OPTIONS(string, ...HandlerFunc) IRoutes
	HEAD(string, ...HandlerFunc) IRoutes

	StaticFile(string, string) IRoutes
	Static(string, string) IRoutes
	StaticFS(string, http.FileSystem) IRoutes
}

因为RenterGroup实现了IRoutes定义的所有请求动词,而且gin.Default返回的Engine类型继承了RenterGroup,所以使用起来非常简单,只需要通过gin.Default实例化对象,接下来所有的路由操作都通过该对象使用即可。

file

Copy
func main() {
	router := gin.Default()
	router.POST("/article", func(c *gin.Context) {
		c.String(200, "article post")
	})
	router.DELETE("/article", func(c *gin.Context) {
		c.String(200, "article delete")
	})
	router.PUT("/article", func(c *gin.Context) {
		c.String(200, "article put")
	})
	router.GET("/article", func(c *gin.Context) {
		c.String(200, "article get")
	})
	router.Run()
}

请求动词的第一个参数是请求路径,第二个参数是用于逻辑处理的函数,可以是匿名的或是其他地方定义的函数名。不同的请求动词可以定义相同的路径,只需要切换动词就可以进入对应的处理逻辑。

Copy
curl -X PUT http://localhost:8080/article
curl -X POST http://localhost:8080/article
curl -X GET http://localhost:8080/article
curl -X DELETE http://localhost:8080/article

路由参数#

GET请求有两种,一种是在URL后加上?name=pingye,这种是有参数名的,另一种是在路径中直接加上参数值/article/1,这种没有参数名,需要在代码中解析参数。

Copy
protocol://hostname:[port]/path/[query]#fragment

我们先来看路由携带参数值的玩法,这里有一道题,怎么利用Gin获取下面链接的参数值1

file

实现方式非常简单,只需要在路由中设置好占位符:id,冒号为占位符的标志,冒号后面的参数名可以自定义,Gin会将路由与请求地址进行匹配,若匹配成功会将1赋值为占位符:id,只需调用c.Param就可以获取id的值。

Copy
router.GET("/article/:id", func(c *gin.Context) {
  id := c.Param("id")
  c.String(200, id)
})

但是,:id占位符会存在一个问题,如果id参数值传空就会有404的错误提示。

file

于是Gin提供了另一种占位符*id,使用它就可以达到取空值的目的。

Copy
router.GET("/article/*id", func(c *gin.Context) {
  id := c.Param("id")
  c.String(200, id)
})

普通参数#

除了路由携带参数值外,接下来看比较传统的GET传参方式。

Copy
http://localhost:8080/welcome?firstname=Jane&lastname=Doe

可以通过c.Queryc.DefaultQuery方法获取问号后的参数。

Copy
router.GET("/welcome", func(c *gin.Context) {
   firstname := c.DefaultQuery("firstname", "pingyeaa")
   lastname := c.Query("lastname")
   c.String(200, firstname+" "+lastname)
})

这两者最终都调用了GetQuery方法,唯一的区别是DefaultQuery做了默认值处理。

Copy
func (c *Context) DefaultQuery(key, defaultValue string) string {
	if value, ok := c.GetQuery(key); ok {
		return value
	}
	return defaultValue
}

func (c *Context) Query(key string) string {
	value, _ := c.GetQuery(key)
	return value
}

表单参数#

从HTML提交过来的表单form内容同样也可以轻松获取。

Copy
router.POST("/form_post", func(c *gin.Context) {
  message := c.PostForm("message")
  nick := c.DefaultPostForm("nick", "anonymous")

  c.JSON(200, gin.H{
    "status":  "posted",
    "message": message,
    "nick":    nick,
  })
})
Copy
curl -d "message=pingye" http://localhost:8080/form_post
{"message":"pingye","nick":"anonymous","status":"posted"}

数组类型参数#

有时候(例如复选框)前端页面会传来数组类型的值,这种类型name相同,但存储的内容不同。

Copy
POST /post?ids[a]=1234&ids[b]=hello HTTP/1.1
Content-Type: application/x-www-form-urlencoded

依然是一个QueryMap方法就搞定,该方法默认返回map类型。

Copy
router.GET("/post", func(c *gin.Context) {
  ids := c.QueryMap("ids")
  c.String(200, ids["a"]+" "+ids["b"])
})
Copy
curl http://localhost:8080/post?ids[a]=pingye&ids[b]=hehe
pingye hehe

文件上传#

一般情况下,文件上传会由前端直接传给云存储服务商,比如阿里云、七牛云等,比较少的场景会传给自己的服务器。为了避免书到用时方恨少的情况发生,我们来了解一下。

Gin提供了FormFile方法获取文件流,这个方法返回了一个FileHeader类型的变量,可以调用Filename属性来查看文件名。

Copy
type FileHeader struct {
   Filename string
   Header   textproto.MIMEHeader
   Size     int64

   content []byte
   tmpfile string
}
Copy
router.POST("/upload", func(c *gin.Context) {
  file, _ := c.FormFile("file")
  c.String(200, file.Filename)
})

通过curl请求接口,可以看到轻松获取文件名称。

Copy
curl -X POST http://localhost:8080/upload \
  -F "file=@/Users/enoch/Downloads/IMG_9216.JPG" \
  -H "Content-Type: multipart/form-data"
IMG_9216.JPG

当然不止可以拿到文件名,我们还可以使用SaveUploadedFile方法将文件保存到某个地方,文件保存时要确保有目标目录的操作权限。

Copy
router.POST("/upload", func(c *gin.Context) {
		file, _ := c.FormFile("file")
		c.String(200, file.Filename)
		err := c.SaveUploadedFile(file, "/Users/enoch/Desktop/ab.png")
		if err != nil {
			c.String(500, err.Error())
		}
})

路由分组#

当接口发生重大变更(比如入参出参)时,考虑到向下兼容,一般会新增一个接口,但是又希望新接口的名称显而易见地看出是老接口的升级版,那么就可以在接口名前加上版本号v1/article这种形式。

Copy
v1 := r.Group("v1")
{
  v1.POST("/login", func(c *gin.Context) {
    c.String(200, "v1/login")
  })
  v1.POST("/submit", func(c *gin.Context) {
    c.String(200, "v1/submit")
  })
}

v2 := r.Group("v2")
{
  v2.POST("/login", func(c *gin.Context) {
    c.String(200, "v2/login")
  })
  v2.POST("/submit", func(c *gin.Context) {
    c.String(200, "v2/submit")
  })
}
Copy
curl -X POST http://localhost:8080/v1/login
curl -X POST http://localhost:8080/v2/login

Go语言库代码示例,欢迎star
https://github.com/pingyeaa/golang-examples#

标签:02,string,IRoutes,func,gin,Context,Gin,Copy,路由
来源: https://www.cnblogs.com/ExMan/p/12957872.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有