APP下载

GoLang -- Gin框架

消息来源:baojiabao.com 作者: 发布时间:2026-05-16

报价宝综合消息GoLang -- Gin框架

一:Gin框架介绍

• 何为框架:

框架一直是敏捷开发中的利器,能让开发者很快的上手并做出应用,甚至有的时候,脱离了框架,一些开发者都不会写程式了。成长总不会一蹴而就,从写出程式获取成就感,再到精通框架,快速构造应用,当这些方面都得心应手的时候,可以尝试改造一些框架,或是自己创造一个。

Gin是一个golang的微框架,封装比较优雅,API友好,源代码注释比较明确,已经发布了1.0版本。具有快速灵活,容错方便等特点。其实对于golang而言,web框架的依赖要远比Python,Java之类的要小。自身的net/http足够简单,效能也非常不错。框架更像是一些常用函式或者工具的集合。借助框架开发,不仅可以省去很多常用的封装带来的时间,也有助于团队的编码风格和形成规范。

(1)首先需要安装,安装比较简单,使用go get即可

go get github.com/gin-gonic/gin

如果安装失败,直接去Github clone下来,放置到对应的目录即可。

(2)程式码中使用:

下面是一个使用Gin的简单例子:

package main

import (

"github.com/gin-gonic/gin"

)

func main() {

router := gin.Default()

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

}

简单几行程式码,就能实现一个web服务。使用gin的Default方法建立一个路由handler。然后通过HTTP方法系结路由规则和路由函式。不同于net/http库的路由函式,gin进行了封装,把request和response都封装到gin.Context的上下文环境。最后是启动路由的Run方法监听埠。麻雀虽小,五脏俱全。当然,除了GET方法,gin也支援POST,PUT,DELETE,OPTION等常用的restful方法。

Gin可以很方便的支援各种HTTP请求方法以及返回各种型别的资料,详情可以前往https://github.com/gin-gonic/gin检视。

二:Gin处理HTTP请求

2.1 匹配引数

我们可以使用Gin框架快速的匹配引数,如下程式码所示:

package main

import (

"github.com/gin-gonic/gin"

"net/http"

)

func main(){

router := gin.Default()

router.GET("/user/:name/:password", ginHandler)

router.Run(":8000")

}

func ginHandler(c *gin.Context) {

name := c.Param("name")

pwd := c.Param("password")

c.String(http.StatusOK, " Hello %s,%s", name, pwd)

}

冒号:加上一个引数名组成路由引数。可以使用c.Param的方法读取其值。当然这个值是字串string。诸如/user/rsj217,和/user/hello都可以匹配,而/user/和/user/rsj217/不会被匹配。

浏览器输入以下测试:

http://127.0.0.1:8000/user/zhangsan/123456

返回结果为:

Hello zhangsan,123456。

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

其中c.Json是gin.Context下提供的方法,用来返回Json。

2.2 Gin分组

下面我们使用以下gin提供的Group函式,方便的为不同的API进行分类。

package main

import (

"github.com/gin-gonic/gin"

"net/http"

)

func main() {

// Creates a default gin router

r := gin.Default() // Grouping routes

// group: v1

v1 := r.Group("/v1")

{

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的预设路由,并为其分配了一个组 v1,监听hello请求并将其路由到检视函式HelloPage,最后系结到 0.0.0.0:8000

浏览器输入 http://127.0.0.1:8000/v1/hello

C.JSON是Gin实现的返回json资料的内建方法,包含了2个引数,状态码和返回的内容。http.StatusOK代表返回状态码为200,正文为{"message": “welcome"}。

注:Gin还包含更多的返回方法如c.String, c.HTML, c.XML等,请自行了解。可以方便的返回HTML资料

2.3 Gin获取普通get引数

我们在之前的组v1路由下新定义一个路由:

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

}

下面我们访问

http://127.0.0.1:8000/v1/hello/lilei

可以看到,通过c.Param(“key”)方法,Gin成功捕获了url请求路径中的引数。同理,gin也可以捕获常规引数,如下程式码所示:

v1.GET("/welcome", func(c *gin.Context) {

firstname := c.DefaultQuery("firstname", "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.Query(“key”)可以成功接收到url引数,c.DefaultQuery在引数不存在的情况下,会由其预设值代替。

func main() {

router := gin.Default()

router.GET("/simple/server/get", GetHandler)

router.Run(":8005")

}

func GetHandler(c *gin.Context) {

//http://127.0.0.1:8005/simple/server/get?name=Jack&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

}

2.4 Gin预设路由

我们还可以为Gin定义一些预设路由:

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}

2.5 Gin Post

下面我们测试在Gin里面使用Post

package main

import (

"fmt"

"github.com/gin-gonic/gin"

"io/ioutil"

"net/http"

)

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)

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,

附带传送的资料,测试即可。记住需要使用POST方法.

继续修改,将PostHandler的函式修改如下

func PostHandler(c *gin.Context) {

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=Jack&password=123456&second=2345

返回结果如下:

Hello Jack,123456,2345。

备注:此处需要指定Content-Type为application/x-www-form-urlencoded,否则识别不出来。

type JsonHolder struct {

Id int `json:"id"`

Name string `json:"name"`

}

//holder := JsonHolder{Id: pwd, Name: name}

holder := JsonHolder{Id: 1, Name: name}

//若返回json资料,可以直接使用gin封装好的JSON方法

c.JSON(http.StatusOK, holder)

}

2.6 PUT与DELETE

package main

import (

"github.com/gin-gonic/gin"

"net/http"

)

func main() {

//gin.SetMode(gin.DebugMode)

router := gin.Default()

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

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

router.Run(":8005")

}

func PutHandler(c *gin.Context) {

c.JSON(http.StatusOK, gin.H{"status": http.StatusOK, "return": "success"})

}

func DeleteHandler(c *gin.Context) {

c.Data(http.StatusOK, "text/plain", []byte("delete success! "))

//c.Data(code, contentType, data)

}

http://127.0.0.1:8005/simple/server/delete

http://127.0.0.1:8005/simple/server/put

一定要选择对应的PUT或者DELETE方法。

总结:

Gin框架快速的建立路由

能够方便的建立分组

支援url正则表示式

支援引数查询(c.Param c.Query c.PostForm)

请求方法精准匹配

支援404处理

快速的返回给客户端资料,常用的c.String c.JSON c.Data

2020-01-13 19:56:00

相关文章