Golang學(xué)習(xí)筆記之WEB框架(gin)基本使用

gin是Go語言寫的一個(gè)web框架，API性能超強(qiáng)，運(yùn)行速度號(hào)稱較httprouter要快40倍。封裝比較優(yōu)雅，API友好，源碼注釋比較明確，具有快速靈活，容錯(cuò)方便等特點(diǎn)。

Github地址：https://github.com/gin-gonic/gin
gin的安裝：go get github.com/gin-gonic/gin
API
gin.Default()
創(chuàng)建路由
gin.DisableConsoleColor()
禁用控制臺(tái)顏色
gin.SetMode()
設(shè)置gin模式。參數(shù)可以傳遞：gin.DebugMode、gin.ReleaseMode、gin.TestMode。
路由的方法為：假定我們先創(chuàng)建一個(gè)路由
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.Group(s string)
分組，s為組名

一、第一個(gè)gin程序

官方給的一個(gè)示例程序

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(":8080") // listen and serve on 0.0.0.0:8080
}

運(yùn)行程序，在瀏覽器上訪問：http://127.0.0.1:8080/ping

c.String用來返回字符串。
c.JSON用來返回Json。

gin的功能不只是簡單輸出Json數(shù)據(jù)。它是一個(gè)輕量級(jí)的WEB框架，支持RestFull風(fēng)格API，支持GET，POST，PUT，PATCH，DELETE，OPTIONS 等http方法，支持文件上傳，分組路由，Multipart/Urlencoded FORM，以及支持JsonP，參數(shù)處理等等功能，這些都和WEB緊密相關(guān)，通過提供這些功能，使開發(fā)人員更方便地處理WEB業(yè)務(wù)。不同于 net/http庫的路由函數(shù)，gin進(jìn)行了封裝，把request和response都封裝到 gin.Context的上下文環(huán)境。

二、快速匹配參數(shù)

Gin框架可以快速的匹配參數(shù)

func main() {
    router := gin.Default()
    router.GET("/user/:name/:password", HinHandler)
    router.Run(":8081")
}
//HinHandler 解構(gòu)傳過來的name和password
func HinHandler(c *gin.Context) {
    name := c.Param("name")
    pwd := c.Param("password")
    //內(nèi)部提供方法用來返回字符串
    c.String(http.StatusOK, "你好 %s,你的密碼為%s", name, pwd)
}

運(yùn)行程序在瀏覽器上訪問：http://127.0.0.1:8081/user/huangzhe/123

三、Gin獲取普通get參數(shù)
func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)
    //Default方法創(chuàng)建一個(gè)路由handler。
    router := gin.Default()
    router.GET("/user", GetHandler)
    router.Run(":8081")
}
//GetHandler 使用get方式獲取對(duì)應(yīng)鍵的值
func GetHandler(c *gin.Context) {
    name := c.DefaultQuery("name", "Guest") //找不到name給它一個(gè)默認(rèn)值Guest
    password := c.Query("password")         //找不到直接賦空
    //GetQuery返回兩個(gè)參數(shù)，第一個(gè)是找到的對(duì)應(yīng)鍵的值，第二個(gè)是是否找到error類型
    id, exist := c.GetQuery("id")
    if !exist {
        name = "the key is not exist"
    }
    c.Data(http.StatusOK, "text/plain",
        []byte(fmt.Sprintf("get success! %s %s %s", name, password, id)))
}

運(yùn)行程序在瀏覽器上訪問：
http://127.0.0.1:8081/user?name=huangzhe&password=123&id=456

四、分組
    //分組
    //組內(nèi)成員訪問為http://127.0.0.1:8080/admin/...
    v1 := router.Group("admin")
    
    {
        //訪問為http://127.0.0.1:8080/admin/ping
        v1.GET("/ping", api.HelloPage)
        v1.GET("/welcome", api.LoginHandler)
        v1.GET("/getquery",api.GetHandler)
    }
五、Gin默認(rèn)路由

我們可以自定義404錯(cuò)誤

func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)

    //Default方法創(chuàng)建一個(gè)路由handler。
    router := gin.Default()

    //設(shè)定請(qǐng)求url不存在的返回值
    router.NoRoute(NoResponse)

    router.GET("/user", GetHandler)
    router.Run(":8081")
}
//NoResponse 請(qǐng)求的url不存在，返回404
func NoResponse(c *gin.Context) {
    //返回404狀態(tài)碼
    c.JSON(http.StatusNotFound, gin.H{
        "status": 404,
        "error":  "404, page not exists!",
    })
}
//GetHandler 使用get方式獲取對(duì)應(yīng)鍵的值
func GetHandler(c *gin.Context) {
    name := c.DefaultQuery("name", "Guest") //找不到name給它一個(gè)默認(rèn)值Guest
    password := c.Query("password")         //找不到直接賦空
    //GetQuery返回兩個(gè)參數(shù)，第一個(gè)是找到的對(duì)應(yīng)鍵的值，第二個(gè)是是否找到error類型
    id, exist := c.GetQuery("id")
    if !exist {
        name = "the key is not exist"
    }
    c.Data(http.StatusOK, "text/plain",
        []byte(fmt.Sprintf("get success! %s %s %s", name, password, id)))
}

我們?nèi)フ?qǐng)求一個(gè)并不存在的url：http://127.0.0.1:8081/us

六、Gin獲取普通post參數(shù)

我這里是使用RESTClient來模擬的，在Firefox上附加組件


func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)

    //Default方法創(chuàng)建一個(gè)路由handler。
    router := gin.Default()

    //設(shè)定請(qǐng)求url不存在的返回值
    router.NoRoute(NoResponse)

    router.POST("/user", PostLoginHandler)
    router.Run(":8081")
}

//NoResponse 請(qǐng)求的url不存在，返回404
func NoResponse(c *gin.Context) {
    //返回404狀態(tài)碼
    c.JSON(http.StatusNotFound, gin.H{
        "status": 404,
        "error":  "404, page not exists!",
    })
}

//PostLoginHandler 獲取參數(shù)
func PostLoginHandler(c *gin.Context) {
    name := c.PostForm("name")                       //找不到name直接返回0值
    password := c.DefaultPostForm("password", "888") //找不到password賦默認(rèn)值
    sec, ok := c.GetPostForm("second")               //判斷是否能找到，找不到返回false
    c.String(http.StatusOK, "hello %s %s %s", name, password, sec)
    log.Panicln(ok)
}

使用post需要添加頭字段



如下：


七、中間件MiddleWare

注意，gin.Default() 默認(rèn)是加載了一些框架內(nèi)置的中間件的，而 gin.New() 則沒有，根據(jù)需要自己手動(dòng)加載中間件。

func MiddleWare(c *gin.Context) {
    fmt.Println("before request")
    c.Next()
}
func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)

    //Default方法創(chuàng)建一個(gè)路由handler。
    router := gin.Default()

    //設(shè)定請(qǐng)求url不存在的返回值
    router.NoRoute(NoResponse)

    router.Use(MiddleWare)

    router.GET("/user", GetHandler)
    router.Run(":8081")
}

//NoResponse 請(qǐng)求的url不存在，返回404
func NoResponse(c *gin.Context) {
    //返回404狀態(tài)碼
    c.JSON(http.StatusNotFound, gin.H{
        "status": 404,
        "error":  "404, page not exists!",
    })
}

//GetHandler 使用get方式獲取對(duì)應(yīng)鍵的值
func GetHandler(c *gin.Context) {
    name := c.DefaultQuery("name", "Guest") //找不到name給它一個(gè)默認(rèn)值Guest
    password := c.Query("password")         //找不到直接賦空
    //GetQuery返回兩個(gè)參數(shù)，第一個(gè)是找到的對(duì)應(yīng)鍵的值，第二個(gè)是是否找到error類型
    id, exist := c.GetQuery("id")
    if !exist {
        name = "the key is not exist"
    }
    c.Data(http.StatusOK, "text/plain",
        []byte(fmt.Sprintf("get success! %s %s %s", name, password, id)))
}

我們?cè)L問上面的url


在終端上你會(huì)發(fā)現(xiàn)中間件已執(zhí)行，我們可以在中間件里做驗(yàn)證或者?志記錄

c.Next()繼續(xù)執(zhí)行下面的函數(shù)
c.Abort()截?cái)鄨?zhí)行

八、文件服務(wù)

上傳單個(gè)文件

func main() {
    router := gin.Default()
    // Set a lower memory limit for multipart forms (default is 32 MiB)
    // router.MaxMultipartMemory = 8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // single file
        file, _ := c.FormFile("file")
        log.Println(file.Filename)

        // Upload the file to specific dst.
        // c.SaveUploadedFile(file, dst)

        c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
    })
    router.Run(":8080")
}

上傳多個(gè)文件

func main() {
    router := gin.Default()
    // Set a lower memory limit for multipart forms (default is 32 MiB)
    // router.MaxMultipartMemory = 8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // Multipart form
        form, _ := c.MultipartForm()
        files := form.File["upload[]"]
        for _, file := range files {
            log.Println(file.Filename)

            // Upload the file to specific dst.
            // c.SaveUploadedFile(file, dst)
        }
        c.String(http.StatusOK, fmt.Sprintf("%d files uploaded!", len(files)))
    })
    router.Run(":8080")
}

更多使用可以去Github去查：https://github.com/gin-gonic/gin

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 轉(zhuǎn)發(fā)自：http://shanshanpt.github.io/2016/05/03/go-gin.html gi...
    dncmn閱讀 6,214評(píng)論 0贊 1
  • 所謂框架 框架一直是敏捷開發(fā)中的利器，能讓開發(fā)者很快的上手并做出應(yīng)用，甚至有的時(shí)候，脫離了框架，一些開發(fā)者都不會(huì)寫...
    人世間閱讀 217,107評(píng)論 11贊 242
  • 使用Gin構(gòu)建Go Web應(yīng)用程序和微服務(wù) 原文鏈接：https://semaphoreci.com/commun...
    devabel閱讀 16,005評(píng)論 2贊 28
  • 附上原文作者連接：作者：金誠 一.榜單介紹 排行榜包括四大類： 單一框架：僅提供路由、網(wǎng)絡(luò)層、UI層、通信層或其他...
    這個(gè)美嘉不姓陳閱讀 2,330評(píng)論 1贊 35
  • 文/周晨曦 抖動(dòng)的髭鬃揚(yáng)著雄烈，騰躍的四蹄彈著剛野。流火般的馬群昂首長嘶，哪一匹不像徐悲鴻飛筆點(diǎn)染？ ...
    朔方吳人閱讀 434評(píng)論 0贊 1

友情鏈接更多精彩內(nèi)容