从零开发区块链应用(六)--gin框架使用

参考文档:

一、Gin 框架介绍

Gin 是一个用 Go 语言编写的 web 微框架,封装比较优雅,API 友好,具有快速灵活,容错方便等特点。它是一个类似于 martini 但拥有更好性能的 API 框架,由于使用了 httpprouter,速度提高了近 40 倍。如果你是性能和高效的追求者,你会爱上 Gin。

Go 世界里最流行的 Web 框架,Github 上有 46k+star。基于 httprouter 开发的 Web 框架。中文文档齐全,简单易用的轻量级框架。

二、Gin安装

  • 下载并安装 gin:
go get -u github.com/gin-gonic/gin
  • 将 gin 引入到代码中:
import "github.com/gin-gonic/gin"

三、Gin使用

package api
 
import (
    "github.com/gin-gonic/gin"
)
 
func RouterStart()  {

    // 创建一个路由引擎
    router := gin.New()
    
    // 创建一个默认的路由引擎
    router := gin.Default()
    
    
    // GET:请求方式;/hello:请求的路径
    // 当客户端以GET方法请求/hello路径时,会执行后面的匿名函数
        // gin.Context封装了Request和Response
        
    r.GET("/hello", func(c *gin.Context) {
        // c.JSON:返回JSON格式的数据
        c.JSON(200, gin.H{
            "message": "Hello world!",
        })
    })
    // 启动HTTP服务,默认在0.0.0.0:8080启动服务
    r.Run()
}

3.1 设置gin模式

gin.SetMode(gin.ReleaseMode)

查看gin源码,可发现gin框架提供了下列三种模式。

const (
    // DebugMode indicates gin mode is debug.
    DebugMode = "debug"
    // ReleaseMode indicates gin mode is release.
    ReleaseMode = "release"
    // TestMode indicates gin mode is test.
    TestMode = "test"
)

我们每次启动gin框架,如果不设置以下gin模式

gin.SetMode(gin.ReleaseMode)

程序则会输出一段提示

[WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

所以,现在我们就可以明白了,这三种mode分别对应了不同的场景。在我们开发调试过程中,使用debug模式就可以了。在上线的时候,一定要选择release模式。而test可以用在测试场景中。

3.2 创建新路由

//创建一个路由引擎
router := gin.New()
    
// 创建一个默认的路由引擎
router := gin.Default()

gin.Default() 和 gin.New() 的区别在于 gin.Default() 也使用 gin.New() 创建engine实例,但是会默认使用 Logger 和 Recovery 中间件。

  • Logger 是负责进行打印并输出日志的中间件,方便开发者进行程序调试;
  • Recovery 中间件的作用是如果程序执行过程中遇到 panic 中断了服务,则 Recovery 会恢复程序执行,并返回服务器500内部错误。通常情况下,我们使用默认的 gin.Default() 创建 router 实例。

3.3 创建多路由分组

chain := router.Group("/api/admin")

我们把一个模块相关的方法都写在一个路由下。便于管理和查找相关的代码。
Gin框架正好为我们提供了这个方法。

代码举例如下

//v1组路由
v1:=router.Group("/v1")
{
    v1.GET("/login", loginEndpoint)
    v1.GET("/submit", submitEndpoint)
    v1.GET("/read", readEndpoint)
}

//v2组路由
v2:=router.Group("/v2")
{
    v2.GET("/login", loginEndpoint)
    v2.GET("/submit", submitEndpoint)
    v2.GET("/read", readEndpoint)
}

3.4 创建路由

// 新增banner
chain.POST("/banner/add", handler.AddBanner)
  • POST:请求方式;另外例如GET
  • /banner/add:请求的二级路径
  • handler.AddBanner:执行函数

当客户端以POST方法请求.../banner/add 路径时,会执行后面的函数

3.5 编写接口执行函数

func AddBanner(ctx *gin.Context)
  • gin.Context封装了Request和Response

Web服务器收到客户端的http请求,会针对每一次请求,分别创建一个用于代表请求的request对象、和代表响应的response对象。

故:当需要获取客户机提交过来的数据时,找request对象就行了。
当需要向客户机输出数据,找response对象。

3.6 启动服务

router.Run(config.Conf.Console.Port)
  • 启动HTTP服务,从配置文件中获取当前服务启动的端口

默认在0.0.0.0:8080启动服务

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容