Go语言学习笔记-Gin框架

一、Gin

安装Gin 终端运行 go get github.com/gin-gonic/gin，如果安装失败，直接去Github clone下来，放置到对应的目录即可。
Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比 较明确，已经发布了1.0版本。具有快速灵活，容错方便等特点。框架更像是一些常用函数或者工具的集合。

//基础使用gin
package main

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

func main() {
    //gin.SetMode(gin.ReleaseMode)
    router := gin.Default()    //使用Default方法创建一个路由handler
    router.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",     //返回的
        })
    })
    router.Run(":8080")  // listen and serve on 0.0.0.0:8080
}

使用gin的Default方法创建 一个路由handler。然后通过HTTP方法绑定路由规则和路由函数。不同于 net/http库的路由函数，gin进行了封装，把request和response都封装到 gin.Context的上下文环境。最后是启动路由的Run方法监听端口。除了GET方法，gin也支持POST,PUT,DELETE,OPTION 等常用的restful方法。

二、Gin处理HTTP请求

1.参数

func main(){
router := gin.Default() 
router.GET("/user/:name/:password", ginHandler) //冒号加上一个参数名组成路由参数
router.Run(":8000")
}
func ginHandler(c *gin.Context) {
  name := c.Param("name")   //读取name的值
  pwd := c.Param("password") c.String(http.StatusOK, " Hello  %s,%s", name, pwd)     //http.StatusOK返回状态码
}

浏览器输入http://127.0.0.1:8000/user/zhangsan/123456查看结果：Hello zhangsan,123456

其中c.String是gin.Context下提供的方法，用来返回字符串。
其中c.JSON是gin.Context下提供的方法，用来返回Json。

2.Gin分组
方便不同API分类

func main() {
// Creates a default gin router
r := gin.Default()   // Grouping routes
// group: v1
v1 := r.Group("/v1")   // "/v1"  url里加的组名
 {
     v1.GET("/hello", HelloPage) 
 }
r.Run(":8000")      // listen and serve on 0.0.0.0:8000 
}

func HelloPage(c *gin.Context) {       
    c.JSON(http.StatusOK, gin.H{
              "message": "welcome", 
     })      //Gin内置返回json数据的方法
}

创建了一个gin的默认路由，并为其分配了一个组 v1，监听 hello请求并将其路由到视图函数HelloPage，最后绑定到 0.0.0.0:8000 浏览器输入 http://127.0.0.1:8000/v1/hello
返回 {"message": “welcome"}（http.StatusOK代表返回状态码为200）

3.Gin获取GET参数
通过c.Param(“key”)方法捕获url中的参数

func main() {
// Creates a default gin router
r := gin.Default() // Grouping routes 
// group: v1
v1 := r.Group("/v1") {
v1.GET("/hello", HelloPage) v1.GET("/hello/:name", func(c *gin.Context) {
name := c.Param("name")
c.String(http.StatusOK, "Hello %s", name) })
}
r.Run(":8000") // listen and serve on 0.0.0.0:8000
}

通过c.Query(“key”)捕获，c.DefaultQuery在参数不存在的情况下，会由其默认值代替。

v1.GET("/welcome", func(c *gin.Context) {
   firstname := c.DefaultQuery("firstname","Guest")//"Guest"为默认值
  lastname:= c.Query("lastname") 
   c.String(http.StatusOK, "Hello %s %s", firstname,lastname)
 })

http://127.0.0.1:8000/v1/welcome?firstname=li&lastname=lei

通过c.GetQuery("Key") 接收：name, exist := c.GetQuery("name"),exist为true接收成功。c.GetQuery和c.Param是两个不同的API

func GetHandler(c *gin.Context) {
 //http://127.0.0.1:8005/simple/server/get?name=LXL&password=123456
 //c.GetQuery和c.Param是两个不同的API
   name, exist := c.GetQuery("name") pwd, _ := c.GetQuery("password") 
   if !exist {
      name = "the key is not exist!" 
    }
   c.Data(http.StatusOK, "text/plain", []byte(fmt.Sprintf("get success! %s %s", name, pwd)))
   return 
}

4.设置默认路由，url出现错误时可以返回设置路由

r := gin.Default() // Grouping routes 
r.NoRoute(func(c *gin.Context) {
c.JSON(http.StatusNotFound, gin.H{     
     "status": 404,
     "error": "404, page not exists!", 
   })
})

访问一个不存在的页面: http://127.0.0.1:8000/v2/notfound
返回如下所示:
{"error":"404, page not exists!”,”status":404}
5.Gin获取POST参数

（1）数据整体解析

func main() {
   router := gin.Default()
   router.POST("/simple/server/post",PostHandler)
   router.Run(":8005") }

func PostHandler(c *gin.Context) {
  //1:如何解析post  发送的内容
    data, _ := ioutil.ReadAll(c.Request.Body)  //要import  "io/ioutil"
    fmt.Printf("ctx.Request.body: %v", string(data)) 
    c.String(http.StatusOK, " Hello %s", string(data))
}

在测试端输入:http://127.0.0.1:8005/simple/server/post，附带发
送的数据，测试即可。
（2）按参数名解析
将PostHandler修改

func PostHandler(c *gin.Context) {
//3种获取post参数的方式
   key := c.PostForm("name")
   pwd, _ := c.GetPostForm("password")
   sure := c.DefaultPostForm("second", "1qaz2wsx")   //设置默认值的
   c.String(http.StatusOK, " Hello %s,%s,%s", key, pwd, sure)
    return 
 }

测试工具:http://127.0.0.1:8005/simple/server/post
发送的内容:name=zhuyuqiang&password=123456&second=2345
结果如下: Hello zhuyuqiang,123456,2345。
此处需要指定Content-Type为application/x-www-form- urlencoded，否则识别不出来。
（3）使用c.JSON返回结构体数据

type JsonHolder struct {
 Id int `json:"id"`
Name string `json:"name"` 
}
holder := JsonHolder{Id: 1, Name: name} //若返回json数据，可以直接使 gin封装好的JSON 法
c.JSON(http.StatusOK, holder)
 }

6.PUT、DELETE

router.PUT("/simple/server/put", PutHandler) 
router.DELETE("simple/server/delete", DeleteHandler)