基于gin的golang web开发：路由

Gin是一个用Golang编写的HTTP网络框架。它的特点是类似于Martini的API，性能更好。在golang web开发领域是一个非常热门的web框架。

启动一个Gin web服务器

使用下面的命令安装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.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})
	r.Run()
}

核心api gin.Default()返回一个Engine对象，调用Engine对象的Run方法会在本机8080端口启动web服务器。如果不想绑定8080端口或者8080端口已被占用的话，可以给Run方法传递你要绑定的端口r.Run(":8081")。代码中的r.GET就是本文要讲解核心内容：路由。

路由

Gin支持http方法: GET, POST, PUT, PATCH, DELETE,HEAD, OPTIONS。分别对应了不同的方法。

func main() {
	router := gin.Default()

	router.GET("/someGet", getting)
	router.POST("/somePost", posting)
	router.PUT("/somePut", putting)
	router.DELETE("/someDelete", deleting)
	router.PATCH("/somePatch", patching)
	router.HEAD("/someHead", head)
	router.OPTIONS("/someOptions", options)

	router.Run()
}

这些路由方法的第一个参数设置相对地址，第二个方法是访问该地址时执行的方法。在Gin中叫做handler。handler方法的原型如下。

type HandlerFunc func(*Context)

Gin还可以设置路由前缀。例如有v1/login,v1/logout两个地址可以使用Gin的Grouping routes功能设置路由前缀。

func main() {
	router := gin.Default()

	v1 := router.Group("/v1")
	{
		v1.POST("/login", loginEndpoint)
		v1.POST("/logout", logoutEndpoint)
	}

	router.Run()
}

获取参数

func main() {
	router := gin.Default()

	router.GET("/user/:name", func(c *gin.Context) {
		name := c.Param("name")
		c.String(http.StatusOK, "Hello %s", name)
	})

	router.GET("/user/:name/*action", func(c *gin.Context) {
		name := c.Param("name")
		action := c.Param("action")
		message := name + " is " + action
		c.String(http.StatusOK, message)
	})

	router.GET("/welcome", func(c *gin.Context) {
		firstname := c.DefaultQuery("firstname", "Guest")
		lastname := c.Query("lastname")

		c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
	})
	
	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,
		})
	})

	router.Run(":8080")
}

可以看到获取参数的方法可以分为路由参数、查询字符串和表单。

路由参数使用c.Param("name")取值。访问/user/john时会调用/user/:name对应的handler，根据规则当访问/user/或者/user并不会调用这个hanlder。

访问/user/john/或者/user/john/send时会调用/user/:name/*action对应的handler。如果没有对/user/john设置过路由的话，访问/user/john会重定向到/user/john/。

使用DefaultQuery或者Query获取查询字符串中的参数，DefaultQuery在没有获取到参数时可以设置一个默认值。在本例中访问/welcome?firstname=Jane&lastname=Doe会调用/welcome对应的handler。

获取表单参数Gin同样也为我们提供了两种方法PostForm和DefaultPostForm。和获取查询字符串的方法一样，DefaultPostForm也可以在没有获取到参数时设置一个默认值。

Gin的Api总体来说还是很直观的，例如上文中没有提到的c.JSON从命名就可以看出会输出一段JSON。c.String直接输出字符串。http.StatusOK定义在http包中，这是一个值为200的常量。gin.H不太一样，这是一个自定义的数据类型map[string]interface{}可以用于返回JSON。

文章出处：基于gin的golang web开发：路由