深圳幻海软件技术有限公司 欢迎您!

跟着官网学Go之基于Gin开发一个简单的RESTful API

2023-02-28

前面已经将Go1.17.6安装好了,这一小节,继续跟着官网学习基于Gin开发RESTfulAPI环境准备这里,我在E盘新建一个名为ginrest的文件夹,然后用vscode打开该文件夹,继续使用cmd命令进入到E:\ginrest文件夹,然后执行gomodinit命令此时,在该文件夹下会生成一个名为

前面已经将Go1.17.6安装好了,这一小节,继续跟着官网学习基于Gin开发RESTful API

环境准备

这里,我在E盘新建一个名为ginrest的文件夹,然后用vscode打开该文件夹,继续使用cmd命令进入到E:\ginrest文件夹,然后执行go mod init命令

此时,在该文件夹下会生成一个名为go.mod的文件

新建main.go

前面基础准备好后,我们就需要准备程序该有的入口,那便是新建一个main.go文件,

在该文件中加入包名package main

我继续新建一个名为album的struct,go中的struct类似于C#中的类,在Go中,定义一个struct的标准格式如下

type 名 struct{
    字段名 字段类型
}
  • 1.
  • 2.
  • 3.

我们在该struct中加入一些字段属性

type album struct {
    Id     string  `json:"id"`
    Title  string  `json:"title"`
    Artist string  `json:"artist"`
    Price  float64 `json:"price"`
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

我们可以看到类型后面用json标识了别名,其主要作用则是当该struct序列化成json时,会序列化为该别名,如果没有别名则按属性名展示。

我新建一个album的数组,主要是为后续数据读取做准备

var albums = []album{
    {Id: "1", Title: "Blue Train", Artist: "John Coltrane", Price: 56.99},
    {Id: "2", Title: "Jeru", Artist: "Gerry Mulligan", Price: 17.99},
    {Id: "3", Title: "Sarah Vaughan and Clifford Brown", Artist: "Sarah Vaughan", Price: 39.99},
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.

使用Gin

前面把基础的准备工作已经做好了,现在便是进入主题,开始使用Gin,引入Gin包,现在main.go中使用import导入包并编写main方法,在main方法中使用gin创建一个简单的Http服务器

import "github.com/gin-gonic/gin"
func main() {
    router := gin.Default()

    router.Run("0.0.0.0:8080")
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

这里是0.0.0.0:8080是监听本机的8080端口,其实也可以直接使用:8080,如:router.Run(":8080"),端口号可以自行调整,如果不指定,默认端口号也是8080。此时通过cmd执行go get .来下载gin的依赖包,这是不是类似.Net里面的Nuget包管理呢?

依赖包下载完成后,此时,我们的go.mod文件便会新增一来记录,并且会多出一个go.sum的文件,它为我们记录了依赖包版本信息。

此时,我们的程序就可以运行了,

这时,我们访问一下8080端口,服务端会返回404 page not found,那是因为我们现在什么都还没有做,

我们继续来分别实现获取(getAlbums)和添加(postAlbums)两个方法,Go语言中的方法和C#有些差别,

C#中大概就是这样子

public List<Albums> GetAlbums(){

}
  • 1.
  • 2.
  • 3.

Go中需要func关键字来申明,下面就跟着官网的例子继续写

func getAlbums(c *gin.Context) {
    c.IndentedJSON(http.StatusOK, albums)
}

func postAlbums(c *gin.Context) {
    var newAlbum album

    if err := c.BindJSON(&newAlbum); err != nil {
        return
    }

    albums = append(albums, newAlbum)
    c.IndentedJSON(http.StatusCreated, newAlbum)
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.

接下来就是将方法注册到Gin的路由中

router.GET("/albums", getAlbums)
router.POST("/albums", postAlbums)
  • 1.
  • 2.

这里的注册的路由路径都是/albums,通过Get和Post这两种请求方式来区分不同的逻辑

现在运行起来后,在浏览器访问

http://localhost:8080/albums便能正常返回数据

接下来,使用postman发起post请求,当服务端接受到请求后,会将提交的数据追加到数组中

这里只是使用Gin来实现简单的Get和Post,就从这个简单的示例中,我们可以感受到它的灵活和简洁,后面我们再继续跟进学习,最好是结合实际例子来做些小应用。